CodeCatalyst / Paginator / ListSourceRepositoryBranches

ListSourceRepositoryBranches

class CodeCatalyst.Paginator.ListSourceRepositoryBranches

paginator = client.get_paginator('list_source_repository_branches')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    projectName='string',
    sourceRepositoryName='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.

• sourceRepositoryName (string) –

  [REQUIRED]

  The name of the source repository.

• 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': [
        {
            'ref': 'string',
            'name': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'headCommitId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    Information about the source branches.

    • (dict) –

      Information about a branch of a source repository returned in a list of branches.

      • ref (string) –

        The Git reference name of the branch.

      • name (string) –

        The name of the branch.

      • lastUpdatedTime (datetime) –

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

      • headCommitId (string) –

        The commit ID of the tip of the branch at the time of the request, also known as the head commit.

  • NextToken (string) –

    A token to resume pagination.