Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBuildBatches

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

Request Syntax


{
   "filter": { 
      "status": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "sortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

filter

A BuildBatchFilter object that specifies the filters for the search.

Type: BuildBatchFilter object

Required: No

maxResults

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

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.

Type: String

Required: No

sortOrder

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.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ids

An array of strings that contains the batch build identifiers.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1.

nextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400