Redshift / Paginator / DescribeUsageLimits

DescribeUsageLimits

class Redshift.Paginator.DescribeUsageLimits

paginator = client.get_paginator('describe_usage_limits')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_usage_limits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    UsageLimitId='string',
    ClusterIdentifier='string',
    FeatureType='spectrum'|'concurrency-scaling'|'cross-region-datasharing',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• UsageLimitId (string) – The identifier of the usage limit to describe.

• ClusterIdentifier (string) – The identifier of the cluster for which you want to describe usage limits.

• FeatureType (string) – The feature type for which you want to describe usage limits.

• TagKeys (list) –

  A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

  • (string) –

• TagValues (list) –

  A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'UsageLimits': [
        {
            '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • UsageLimits (list) –

    Contains the output from the DescribeUsageLimits action.

    • (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.

  • NextToken (string) –

    A token to resume pagination.