list_build_batches

CodeBuild.Client.list_build_batches(**kwargs)

Retrieves the identifiers of your build batches in the current region.

See also: AWS API Documentation

Request Syntax

response = client.list_build_batches(
    filter={
        'status': 'SUCCEEDED'|'FAILED'|'FAULT'|'TIMED_OUT'|'IN_PROGRESS'|'STOPPED'
    },
    maxResults=123,
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string'
)

Parameters

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

• maxResults (integer) -- The maximum number of results to return.
• 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.
• nextToken (string) -- The nextToken value returned from a previous call to ListBuildBatches . This specifies the next item to return. To return the beginning of the list, exclude this parameter.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • ids (list) --

    An array of strings that contains the batch build identifiers.

    • (string) --

  • nextToken (string) --

    If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.

Exceptions

• CodeBuild.Client.exceptions.InvalidInputException