UpdateConsumableResource
Updates a consumable resource.
Request Syntax
POST /v1/updateconsumableresource HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"consumableResource": "string",
"operation": "string",
"quantity": number
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
If this parameter is specified and two update requests with identical payloads and
clientTokens are received, these requests are considered the same request and the second request is rejected. AclientTokenis valid for 8 hours or until one hour after the consumable resource is deleted, whichever is less.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- consumableResource
-
The name or ARN of the consumable resource to be updated.
Type: String
Required: Yes
- operation
-
Indicates how the quantity of the consumable resource will be updated. Must be one of:
-
SETSets the quantity of the resource to the value specified by the
quantityparameter. -
ADDIncreases the quantity of the resource by the value specified by the
quantityparameter. -
REMOVEReduces the quantity of the resource by the value specified by the
quantityparameter.
Type: String
Required: No
-
- quantity
-
The change in the total quantity of the consumable resource. The
operationparameter determines whether the value specified here will be the new total quantity, or the amount by which the total quantity will be increased or reduced. Must be a non-negative value.Type: Long
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"consumableResourceArn": "string",
"consumableResourceName": "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.
- consumableResourceArn
-
The Amazon Resource Name (ARN) of the consumable resource.
Type: String
- consumableResourceName
-
The name of the consumable resource to be updated.
Type: String
- 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:
