Redshift / Paginator / DescribeEventSubscriptions

DescribeEventSubscriptions

class Redshift.Paginator.DescribeEventSubscriptions

paginator = client.get_paginator('describe_event_subscriptions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SubscriptionName='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• SubscriptionName (string) – The name of the Amazon Redshift event notification subscription to be described.

• TagKeys (list) –

  A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions 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 subscriptions that 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 event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions 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 subscriptions 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

{
    'EventSubscriptionsList': [
        {
            'CustomerAwsId': 'string',
            'CustSubscriptionId': 'string',
            'SnsTopicArn': 'string',
            'Status': 'string',
            'SubscriptionCreationTime': datetime(2015, 1, 1),
            'SourceType': 'string',
            'SourceIdsList': [
                'string',
            ],
            'EventCategoriesList': [
                'string',
            ],
            'Severity': 'string',
            'Enabled': True|False,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • EventSubscriptionsList (list) –

    A list of event subscriptions.

    • (dict) –

      Describes event subscriptions.

      • CustomerAwsId (string) –

        The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

      • CustSubscriptionId (string) –

        The name of the Amazon Redshift event notification subscription.

      • SnsTopicArn (string) –

        The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

      • Status (string) –

        The status of the Amazon Redshift event notification subscription.

        Constraints:

        • Can be one of the following: active | no-permission | topic-not-exist

        • The status “no-permission” indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status “topic-not-exist” indicates that the topic was deleted after the subscription was created.

      • SubscriptionCreationTime (datetime) –

        The date and time the Amazon Redshift event notification subscription was created.

      • SourceType (string) –

        The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

      • SourceIdsList (list) –

        A list of the sources that publish events to the Amazon Redshift event notification subscription.

        • (string) –

      • EventCategoriesList (list) –

        The list of Amazon Redshift event categories specified in the event notification subscription.

        Values: Configuration, Management, Monitoring, Security, Pending

        • (string) –

      • Severity (string) –

        The event severity specified in the Amazon Redshift event notification subscription.

        Values: ERROR, INFO

      • Enabled (boolean) –

        A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

      • Tags (list) –

        The list of tags for the event subscription.

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