ListPullRequests

class CodeCommit.Paginator.ListPullRequests

paginator = client.get_paginator('list_pull_requests')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    repositoryName='string',
    authorArn='string',
    pullRequestStatus='OPEN'|'CLOSED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• repositoryName (string) --

  [REQUIRED]

  The name of the repository for which you want to list pull requests.

• authorArn (string) -- Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.
• pullRequestStatus (string) -- Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.
• 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

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

Response Structure

• (dict) --

  • pullRequestIds (list) --

    The system-generated IDs of the pull requests.

    • (string) --

  • NextToken (string) --

    A token to resume pagination.