ListConsumableResources
Returns a list of AWS Batch consumable resources.
Request Syntax
POST /v1/listconsumableresources HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filters
-
The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:
-
name:
CONSUMABLE_RESOURCE_NAMEvalues: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.
Type: Array of KeyValuesPair objects
Required: No
-
- maxResults
-
The maximum number of results returned by
ListConsumableResourcesin paginated output. When this parameter is used,ListConsumableResourcesonly returnsmaxResultsresults in a single page and anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListConsumableResourcesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter isn't used, thenListConsumableResourcesreturns up to 100 results and anextTokenvalue if applicable.Type: Integer
Required: No
- nextToken
-
The
nextTokenvalue returned from a previous paginatedListConsumableResourcesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.Note
Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"consumableResources": [
{
"consumableResourceArn": "string",
"consumableResourceName": "string",
"inUseQuantity": number,
"resourceType": "string",
"totalQuantity": number
}
],
"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.
- consumableResources
-
A list of consumable resources that match the request.
Type: Array of ConsumableResourceSummary objects
- nextToken
-
The
nextTokenvalue to include in a futureListConsumableResourcesrequest. When the results of aListConsumableResourcesrequest exceedmaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return.Type: String
Errors
- ClientException
-
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
