CreateUsageLimit
Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Amount
-
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
Type: Long
Required: Yes
- ClusterIdentifier
-
The identifier of the cluster that you want to limit usage.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- FeatureType
-
The Amazon Redshift feature that you want to limit.
Type: String
Valid Values:
spectrum | concurrency-scaling | cross-region-datasharingRequired: Yes
- LimitType
-
The type of limit. Depending on the feature type, this can be based on a time duration or data size. If
FeatureTypeisspectrum, thenLimitTypemust bedata-scanned. IfFeatureTypeisconcurrency-scaling, thenLimitTypemust betime. IfFeatureTypeiscross-region-datasharing, thenLimitTypemust bedata-scanned.Type: String
Valid Values:
time | data-scannedRequired: Yes
- BreachAction
-
The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
Type: String
Valid Values:
log | emit-metric | disableRequired: No
- Period
-
The time period that the amount applies to. A
weeklyperiod begins on Sunday. The default ismonthly.Type: String
Valid Values:
daily | weekly | monthlyRequired: No
- Tags.Tag.N
-
A list of tag instances.
Type: Array of Tag objects
Required: No
Response Elements
The following elements are returned by the service.
- Amount
-
The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
Type: Long
- BreachAction
-
The action that Amazon Redshift takes when the limit is reached. Possible values are:
-
log - To log an event in a system table. The default is log.
-
emit-metric - To emit CloudWatch metrics.
-
disable - To disable the feature until the next usage period begins.
Type: String
Valid Values:
log | emit-metric | disable -
- ClusterIdentifier
-
The identifier of the cluster with a usage limit.
Type: String
Length Constraints: Maximum length of 2147483647.
- FeatureType
-
The Amazon Redshift feature to which the limit applies.
Type: String
Valid Values:
spectrum | concurrency-scaling | cross-region-datasharing - LimitType
-
The type of limit. Depending on the feature type, this can be based on a time duration or data size.
Type: String
Valid Values:
time | data-scanned - Period
-
The time period that the amount applies to. A
weeklyperiod begins on Sunday. The default ismonthly.Type: String
Valid Values:
daily | weekly | monthly - Tags.Tag.N
-
A list of tag instances.
Type: Array of Tag objects
- UsageLimitId
-
The identifier of the usage limit.
Type: String
Length Constraints: Maximum length of 2147483647.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- InvalidClusterState
-
The specified cluster is not in the
availablestate.HTTP Status Code: 400
- InvalidUsageLimit
-
The usage limit is not valid.
HTTP Status Code: 400
- LimitExceededFault
-
The encryption key has exceeded its grant limit in AWS KMS.
HTTP Status Code: 400
- TagLimitExceededFault
-
You have exceeded the number of tags allowed.
HTTP Status Code: 400
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
- UsageLimitAlreadyExists
-
The usage limit already exists.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
