Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_usage_limit

create_usage_limit(**kwargs)

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

See also: AWS API Documentation

Request Syntax

response = client.create_usage_limit(
    ClusterIdentifier='string',
    FeatureType='spectrum'|'concurrency-scaling'|'cross-region-datasharing',
    LimitType='time'|'data-scanned',
    Amount=123,
    Period='daily'|'weekly'|'monthly',
    BreachAction='log'|'emit-metric'|'disable',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The identifier of the cluster that you want to limit usage.

  • FeatureType (string) --

    [REQUIRED]

    The Amazon Redshift feature that you want to limit.

  • LimitType (string) --

    [REQUIRED]

    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum , then LimitType must be data-scanned . If FeatureType is concurrency-scaling , then LimitType must be time . If FeatureType is cross-region-datasharing , then LimitType must be data-scanned .

  • Amount (integer) --

    [REQUIRED]

    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.

  • Period (string) -- The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly .
  • BreachAction (string) -- The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
  • Tags (list) --

    A list of tag instances.

    • (dict) --

      A tag consisting of a name/value pair for a resource.

      • Key (string) --

        The key, or name, for the resource tag.

      • Value (string) --

        The value for the resource tag.

Return type

dict

Returns

Response Syntax

{
    'UsageLimitId': 'string',
    'ClusterIdentifier': 'string',
    'FeatureType': 'spectrum'|'concurrency-scaling'|'cross-region-datasharing',
    'LimitType': 'time'|'data-scanned',
    'Amount': 123,
    'Period': 'daily'|'weekly'|'monthly',
    'BreachAction': 'log'|'emit-metric'|'disable',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Describes a usage limit object for a cluster.

    • UsageLimitId (string) --

      The identifier of the usage limit.

    • ClusterIdentifier (string) --

      The identifier of the cluster with a usage limit.

    • FeatureType (string) --

      The Amazon Redshift feature to which the limit applies.

    • LimitType (string) --

      The type of limit. Depending on the feature type, this can be based on a time duration or data size.

    • Amount (integer) --

      The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

    • Period (string) --

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

    • BreachAction (string) --

      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.
    • Tags (list) --

      A list of tag instances.

      • (dict) --

        A tag consisting of a name/value pair for a resource.

        • Key (string) --

          The key, or name, for the resource tag.

        • Value (string) --

          The value for the resource tag.

Exceptions

  • Redshift.Client.exceptions.ClusterNotFoundFault
  • Redshift.Client.exceptions.InvalidClusterStateFault
  • Redshift.Client.exceptions.LimitExceededFault
  • Redshift.Client.exceptions.UsageLimitAlreadyExistsFault
  • Redshift.Client.exceptions.InvalidUsageLimitFault
  • Redshift.Client.exceptions.TagLimitExceededFault
  • Redshift.Client.exceptions.UnsupportedOperationFault