ModifyUsageLimit - Amazon Redshift

ModifyUsageLimit

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Request Parameters

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

UsageLimitId

The identifier of the usage limit to modify.

Type: String

Required: Yes

Amount

The new limit amount. For more information about this parameter, see UsageLimit.

Type: Long

Required: No

BreachAction

The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.

Type: String

Valid Values: log | emit-metric | disable

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

FeatureType

The Amazon Redshift feature to which the limit applies.

Type: String

Valid Values: spectrum | concurrency-scaling

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 weekly period begins on Sunday. The default is monthly.

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

Errors

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

InvalidUsageLimit

The usage limit is not valid.

HTTP Status Code: 400

UnsupportedOperation

The requested operation isn't supported.

HTTP Status Code: 400

UsageLimitNotFound

The usage limit identifier can't be found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: