get_usage_limit

RedshiftServerless.Client.get_usage_limit(**kwargs)

Returns information about a usage limit.

See also: AWS API Documentation

Request Syntax

response = client.get_usage_limit(
    usageLimitId='string'
)

Parameters

usageLimitId (string) --

[REQUIRED]

The unique identifier of the usage limit to return information for.

Return type

dict

Returns

Response Syntax

{
    'usageLimit': {
        'amount': 123,
        'breachAction': 'log'|'emit-metric'|'deactivate',
        'period': 'daily'|'weekly'|'monthly',
        'resourceArn': 'string',
        'usageLimitArn': 'string',
        'usageLimitId': 'string',
        'usageType': 'serverless-compute'|'cross-region-datasharing'
    }
}

Response Structure

• (dict) --
  • usageLimit (dict) --

    The returned usage limit object.

    • amount (integer) --

      The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

    • breachAction (string) --

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

    • period (string) --

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

    • resourceArn (string) --

      The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

    • usageLimitArn (string) --

      The Amazon Resource Name (ARN) of the resource associated with the usage limit.

    • usageLimitId (string) --

      The identifier of the usage limit.

    • usageType (string) --

      The Amazon Redshift Serverless feature to limit.

Exceptions

• RedshiftServerless.Client.exceptions.InternalServerException
• RedshiftServerless.Client.exceptions.ResourceNotFoundException
• RedshiftServerless.Client.exceptions.ConflictException
• RedshiftServerless.Client.exceptions.ValidationException