DescribeConsumableResource
Returns a description of the specified consumable resource.
Request Syntax
POST /v1/describeconsumableresource HTTP/1.1
Content-type: application/json
{
"consumableResource": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- consumableResource
-
The name or ARN of the consumable resource whose description will be returned.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"availableQuantity": number,
"consumableResourceArn": "string",
"consumableResourceName": "string",
"createdAt": number,
"inUseQuantity": number,
"resourceType": "string",
"tags": {
"string" : "string"
},
"totalQuantity": number
}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.
- availableQuantity
-
The amount of the consumable resource that is currently available to use.
Type: Long
- consumableResourceArn
-
The Amazon Resource Name (ARN) of the consumable resource.
Type: String
- consumableResourceName
-
The name of the consumable resource.
Type: String
- createdAt
-
The Unix timestamp (in milliseconds) for when the consumable resource was created.
Type: Long
- inUseQuantity
-
The amount of the consumable resource that is currently in use.
Type: Long
- resourceType
-
Indicates whether the resource is available to be re-used after a job completes. Can be one of:
-
REPLENISHABLE -
NON_REPLENISHABLE
Type: String
-
-
The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
- totalQuantity
-
The total amount of the consumable resource that is available.
Type: Long
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:
