Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UnsubscribeCommand

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

This action is throttled at 100 transactions per second (TPS).

example

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

import { SNSClient, UnsubscribeCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, UnsubscribeCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const command = new UnsubscribeCommand(input);
const response = await client.send(command);
see

UnsubscribeCommandInput for command's input shape.

see

UnsubscribeCommandOutput for command's response shape.

see

config for SNSClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: UnsubscribeCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<UnsubscribeCommandInput, UnsubscribeCommandOutput>