CodeBuild / Paginator / ListBuilds

ListBuilds¶

class CodeBuild.Paginator.ListBuilds¶

paginator = client.get_paginator('list_builds')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CodeBuild.Client.list_builds().

Request Syntax

response_iterator = paginator.paginate(
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

sortOrder (string) –
The order to list build IDs. Valid values include:
- ASCENDING: List the build IDs in ascending order by build ID.
- DESCENDING: List the build IDs in descending order by build ID.
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

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

Response Structure

(dict) –
- ids (list) –
  
  A list of build IDs, with each build ID representing a single build.
  - (string) –
- NextToken (string) –
  
  A token to resume pagination.