CodeCommit / Paginator / ListBranches

ListBranches

class CodeCommit.Paginator.ListBranches

paginator = client.get_paginator('list_branches')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCommit.Client.list_branches().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• repositoryName (string) –

  [REQUIRED]

  The name of the repository that contains the branches.

• 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.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'branches': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a list branches operation.

  • branches (list) –

    The list of branch names.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.