Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateSpendingLimit

Updates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.

Request Syntax


PATCH /spending-limit/spendingLimitArn/update HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "spendingLimit": "string",
   "timePeriod": { 
      "endAt": number,
      "startAt": number
   }
}

URI Request Parameters

The request uses the following URI parameters.

spendingLimitArn

The Amazon Resource Name (ARN) of the spending limit to update.

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:spending-limit/.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Braket ignores the request, but does not return an error.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

spendingLimit

The new maximum amount that can be spent on the specified device, in USD.

Type: String

Length Constraints: Minimum length of 1.

Pattern: \d+(\.\d{1,2})?

Required: No

timePeriod

The new time period during which the spending limit is active, including start and end dates.

Type: TimePeriod object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

The request failed because of an unknown error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The API throttling rate limit is exceeded.

HTTP Status Code: 429

ValidationException

The input request failed to satisfy constraints expected by Amazon Braket.

programSetValidationFailures: The validation failures in the program set submitted in the request.
reason: The reason for validation failure.

HTTP Status Code: 400