RDS / Client / describe_event_subscriptions

describe_event_subscriptions#

RDS.Client.describe_event_subscriptions(**kwargs)#

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_subscriptions(
    SubscriptionName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • SubscriptionName (string) – The name of the RDS event notification subscription you want to describe.

  • Filters (list) –

    This parameter isn’t currently supported.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

      Note

      Currently, wildcards are not supported in filters.

      The following actions can be filtered:

      • DescribeDBClusterBacktracks

      • DescribeDBClusterEndpoints

      • DescribeDBClusters

      • DescribeDBInstances

      • DescribeDBRecommendations

      • DescribeDBShardGroups

      • DescribePendingMaintenanceActions

      • Name (string) – [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Values (list) – [REQUIRED]

        One or more filter values. Filter values are case-sensitive.

        • (string) –

  • MaxRecords (integer) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker (string) – An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'EventSubscriptionsList': [
        {
            'CustomerAwsId': 'string',
            'CustSubscriptionId': 'string',
            'SnsTopicArn': 'string',
            'Status': 'string',
            'SubscriptionCreationTime': 'string',
            'SourceType': 'string',
            'SourceIdsList': [
                'string',
            ],
            'EventCategoriesList': [
                'string',
            ],
            'Enabled': True|False,
            'EventSubscriptionArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    Data returned by the DescribeEventSubscriptions action.

    • Marker (string) –

      An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • EventSubscriptionsList (list) –

      A list of EventSubscriptions data types.

      • (dict) –

        Contains the results of a successful invocation of the DescribeEventSubscriptions action.

        • CustomerAwsId (string) –

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

        • CustSubscriptionId (string) –

          The RDS event notification subscription Id.

        • SnsTopicArn (string) –

          The topic ARN of the RDS event notification subscription.

        • Status (string) –

          The status of the RDS event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

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

        • SubscriptionCreationTime (string) –

          The time the RDS event notification subscription was created.

        • SourceType (string) –

          The source type for the RDS event notification subscription.

        • SourceIdsList (list) –

          A list of source IDs for the RDS event notification subscription.

          • (string) –

        • EventCategoriesList (list) –

          A list of event categories for the RDS event notification subscription.

          • (string) –

        • Enabled (boolean) –

          Specifies whether the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn (string) –

          The Amazon Resource Name (ARN) for the event subscription.

Exceptions

Examples

This example lists information for the specified DB event notification subscription.

response = client.describe_event_subscriptions(
    SubscriptionName='mymysqleventsubscription',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}