DatabaseMigrationService / Client / describe_event_subscriptions

describe_event_subscriptions

DatabaseMigrationService.Client.describe_event_subscriptions(**kwargs)

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

If you specify SubscriptionName, this action 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 DMS event subscription to be described.

• Filters (list) –

  Filters applied to event subscriptions.

  Valid filter names: event-subscription-arn | event-subscription-id

  • (dict) –

    Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

    • Name (string) – [REQUIRED]

      The name of the filter as specified for a Describe* or similar operation.

    • Values (list) – [REQUIRED]

      The filter value, which can specify one or more values used to narrow the returned results.

      • (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 the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker (string) – An optional pagination token provided by a previous 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
        },
    ]
}

Response Structure

• (dict) –

  • Marker (string) –

    An optional pagination token provided by a previous 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 event subscriptions.

    • (dict) –

      Describes an event notification subscription created by the CreateEventSubscription operation.

      • CustomerAwsId (string) –

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

      • CustSubscriptionId (string) –

        The DMS event notification subscription Id.

      • SnsTopicArn (string) –

        The topic ARN of the DMS event notification subscription.

      • Status (string) –

        The status of the DMS 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 DMS 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 DMS event notification subscription was created.

      • SourceType (string) –

        The type of DMS resource that generates events.

        Valid values: replication-instance | replication-server | security-group | replication-task

      • SourceIdsList (list) –

        A list of source Ids for the event subscription.

        • (string) –

      • EventCategoriesList (list) –

        A lists of event categories.

        • (string) –

      • Enabled (boolean) –

        Boolean value that indicates if the event subscription is enabled.

Exceptions

• DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault