list_usage_limits

RedshiftServerless.Client.list_usage_limits(**kwargs)

Lists all usage limits within Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.list_usage_limits(
    maxResults=123,
    nextToken='string',
    resourceArn='string',
    usageType='serverless-compute'|'cross-region-datasharing'
)

Parameters

• maxResults (integer) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.
• nextToken (string) -- If your initial ListUsageLimits operation returns a nextToken , you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.
• resourceArn (string) -- The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
• usageType (string) -- The Amazon Redshift Serverless feature whose limits you want to see.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'usageLimits': [
        {
            '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) --

  • nextToken (string) --

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • usageLimits (list) --

    An array of returned usage limit objects.

    • (dict) --

      The 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.InvalidPaginationException
• RedshiftServerless.Client.exceptions.ResourceNotFoundException
• RedshiftServerless.Client.exceptions.ConflictException
• RedshiftServerless.Client.exceptions.ValidationException