CodeBuild / Paginator / ListBuildBatchesForProject


class CodeBuild.Paginator.ListBuildBatchesForProject#
paginator = client.get_paginator('list_build_batches_for_project')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • projectName (string) – The name of the project.

  • filter (dict) –

    A BuildBatchFilter object that specifies the filters for the search.

    • status (string) –

      The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.

  • sortOrder (string) –

    Specifies the sort order of the returned items. Valid values include:

    • ASCENDING: List the batch build identifiers in ascending order by identifier.

    • DESCENDING: List the batch build identifiers in descending order by identifier.

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



Response Syntax

    'ids': [
    'NextToken': 'string'

Response Structure

  • (dict) –

    • ids (list) –

      An array of strings that contains the batch build identifiers.

      • (string) –

    • NextToken (string) –

      A token to resume pagination.