DeleteTopicCommand

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SNSClient, DeleteTopicCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, DeleteTopicCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const input = { // DeleteTopicInput
  TopicArn: "STRING_VALUE", // required
};
const command = new DeleteTopicCommand(input);
const response = await client.send(command);
// {};

DeleteTopicCommand Input

See DeleteTopicCommandInput for more details

Parameter
Type
Description
TopicArn
Required
string | undefined

The ARN of the topic you want to delete.

DeleteTopicCommand Output

See DeleteTopicCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AuthorizationErrorException
client

Indicates that the user has been denied access to the requested resource.

ConcurrentAccessException
client

Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.

InternalErrorException
server

Indicates an internal service error.

InvalidParameterException
client

Indicates that a request parameter does not comply with the associated constraints.

InvalidStateException
client

Indicates that the specified state is not a valid state for an event source.

NotFoundException
client

Indicates that the requested resource does not exist.

StaleTagException
client

A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.

TagPolicyException
client

The request doesn't comply with the IAM tag policy. Correct your request and then retry it.

SNSServiceException
Base exception class for all service exceptions from SNS service.