Redshift / Client / describe_event_subscriptions

describe_event_subscriptions

Redshift.Client.describe_event_subscriptions(**kwargs)

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_subscriptions(
    SubscriptionName='string',
    MaxRecords=123,
    Marker='string',
    TagKeys=[
        'string',
    ],
    TagValues=[
        'string',
    ]
)

Parameters:

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

• MaxRecords (integer) –

  The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  Default: 100

  Constraints: minimum 20, maximum 100.

• Marker (string) – An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords , Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

• 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) –

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    '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'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • Marker (string) –

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

Exceptions

• Redshift.Client.exceptions.SubscriptionNotFoundFault

• Redshift.Client.exceptions.InvalidTagFault