Proton / Client / list_repositories

list_repositories#

Proton.Client.list_repositories(**kwargs)#

List linked repositories with detail data.

Request Syntax

response = client.list_repositories(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of repositories to list.
nextToken (string) – A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'repositories': [
        {
            'arn': 'string',
            'connectionArn': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories.
- repositories (list) –
  
  An array of repository links.
  - (dict) –
    
    Summary data of a linked repository—a repository that has been registered with Proton.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the linked repository.
    - connectionArn (string) –
      
      The Amazon Resource Name (ARN) of the of your connection that connects Proton to your repository.
    - name (string) –
      
      The repository name.
    - provider (string) –
      
      The repository provider.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException