Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListUsageLimits

Lists all usage limits within Amazon Redshift Serverless.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "resourceArn": "string",
   "usageType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

Type: Integer

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

Required: No

nextToken

If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

Required: No

resourceArn

The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

Type: String

Required: No

usageType

The Amazon Redshift Serverless feature whose limits you want to see.

Type: String

Valid Values: serverless-compute | cross-region-datasharing

Required: No

Response Syntax


{
   "nextToken": "string",
   "usageLimits": [ 
      { 
         "amount": number,
         "breachAction": "string",
         "period": "string",
         "resourceArn": "string",
         "usageLimitArn": "string",
         "usageLimitId": "string",
         "usageType": "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

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

usageLimits

An array of returned usage limit objects.

Type: Array of UsageLimit objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Errors

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

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidPaginationException

The provided pagination token is invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400