Proton / Paginator / ListRepositories

ListRepositories¶

class Proton.Paginator.ListRepositories¶

paginator = client.get_paginator('list_repositories')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_repositories().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.