- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteEventSubscriptionCommand
Deletes an DMS event subscription.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DatabaseMigrationServiceClient, DeleteEventSubscriptionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import
// const { DatabaseMigrationServiceClient, DeleteEventSubscriptionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import
const client = new DatabaseMigrationServiceClient(config);
const input = { // DeleteEventSubscriptionMessage
SubscriptionName: "STRING_VALUE", // required
};
const command = new DeleteEventSubscriptionCommand(input);
const response = await client.send(command);
// { // DeleteEventSubscriptionResponse
// EventSubscription: { // EventSubscription
// CustomerAwsId: "STRING_VALUE",
// CustSubscriptionId: "STRING_VALUE",
// SnsTopicArn: "STRING_VALUE",
// Status: "STRING_VALUE",
// SubscriptionCreationTime: "STRING_VALUE",
// SourceType: "STRING_VALUE",
// SourceIdsList: [ // SourceIdsList
// "STRING_VALUE",
// ],
// EventCategoriesList: [ // EventCategoriesList
// "STRING_VALUE",
// ],
// Enabled: true || false,
// },
// };
DeleteEventSubscriptionCommand Input
See DeleteEventSubscriptionCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
SubscriptionName Required | string | undefined | The name of the DMS event notification subscription to be deleted. |
DeleteEventSubscriptionCommand Output
See DeleteEventSubscriptionCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
EventSubscription | EventSubscription | undefined | The event subscription that was deleted. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedFault | client | DMS was denied access to the endpoint. Check that the role is correctly configured. |
InvalidResourceStateFault | client | The resource is in a state that prevents it from being used for database migration. |
ResourceNotFoundFault | client | The resource could not be found. |
DatabaseMigrationServiceServiceException | Base exception class for all service exceptions from DatabaseMigrationService service. |