CodeCatalyst / Paginator / ListSourceRepositories

ListSourceRepositories#

class CodeCatalyst.Paginator.ListSourceRepositories#
paginator = client.get_paginator('list_source_repositories')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_source_repositories().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    projectName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • projectName (string) –

    [REQUIRED]

    The name of the project in the space.

  • 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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'createdTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Information about the source repositories.

      • (dict) –

        Information about a source repository returned in a list of source repositories.

        • id (string) –

          The system-generated unique ID of the source repository.

        • name (string) –

          The name of the source repository.

        • description (string) –

          The description of the repository, if any.

        • lastUpdatedTime (datetime) –

          The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • createdTime (datetime) –

          The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • NextToken (string) –

      A token to resume pagination.