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

SearchSpendingLimits

Searches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific spending limits. We recommend using pagination to ensure that the operation returns quickly and successfully.

Request Syntax


POST /spending-limits HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "operator": "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 when searching for spending limits. Use filters to narrow down the results based on specific criteria.

Type: Array of SearchSpendingLimitsFilter objects

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

Required: No

maxResults

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 100. Default is 20.

Type: Integer

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

Required: No

nextToken

The token to retrieve the next page of results. This value is returned from a previous call to SearchSpendingLimits when there are more results available.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "spendingLimits": [ 
      { 
         "createdAt": "string",
         "deviceArn": "string",
         "queuedSpend": "string",
         "spendingLimit": "string",
         "spendingLimitArn": "string",
         "tags": { 
            "string" : "string" 
         },
         "timePeriod": { 
            "endAt": number,
            "startAt": number
         },
         "totalSpend": "string",
         "updatedAt": "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.

nextToken

The token to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

spendingLimits

An array of spending limit summaries that match the specified filters.

Type: Array of SpendingLimitSummary objects

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

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