DatabaseMigrationService / Client / delete_event_subscription
delete_event_subscription#
- DatabaseMigrationService.Client.delete_event_subscription(**kwargs)#
Deletes an DMS event subscription.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_subscription( SubscriptionName='string' )
- Parameters:
SubscriptionName (string) –
[REQUIRED]
The name of the DMS event notification subscription to be deleted.
- Return type:
dict
- Returns:
Response Syntax
{ 'EventSubscription': { 'CustomerAwsId': 'string', 'CustSubscriptionId': 'string', 'SnsTopicArn': 'string', 'Status': 'string', 'SubscriptionCreationTime': 'string', 'SourceType': 'string', 'SourceIdsList': [ 'string', ], 'EventCategoriesList': [ 'string', ], 'Enabled': True|False } }
Response Structure
(dict) –
EventSubscription (dict) –
The event subscription that was deleted.
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
DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault