Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
Request Syntax
{
"amount": number,
"breachAction": "string",
"usageLimitId": "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.
- amount
-
The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
Type: Long
Required: No
- breachAction
-
The new action that Amazon Redshift Serverless takes when the limit is reached.
Type: String
Valid Values:
log | emit-metric | deactivateRequired: No
- usageLimitId
-
The identifier of the usage limit to update.
Type: String
Required: Yes
Response Syntax
{
"usageLimit": {
"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.
- usageLimit
-
The updated usage limit object.
Type: UsageLimit object
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
