Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateUsageLimit

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Request Syntax


{
   "amount": number,
   "breachAction": "string",
   "period": "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.

amount

The 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: Yes

breachAction

The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

Type: String

Valid Values: log | emit-metric | deactivate

Required: No

period

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

Type: String

Valid Values: daily | weekly | monthly

Required: No

resourceArn

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

Type: String

Required: Yes

usageType

The type of Amazon Redshift Serverless usage to create a usage limit for.

Type: String

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

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 returned 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

ServiceQuotaExceededException

The service limit was exceeded.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400