Skip to content

Sns  >  Operations  >  unsubscribe

unsubscribe

Operation

unsubscribe async

unsubscribe(input: UnsubscribeInput, plugins: list[Plugin] | None = None) -> UnsubscribeOutput

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).

Parameters:

Name Type Description Default
input UnsubscribeInput

An instance of UnsubscribeInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
UnsubscribeOutput

An instance of UnsubscribeOutput.

Input

UnsubscribeInput dataclass

Input for Unsubscribe action.

Attributes

subscription_arn class-attribute instance-attribute
subscription_arn: str | None = None

The ARN of the subscription to be deleted.

Output

UnsubscribeOutput dataclass

Dataclass for UnsubscribeOutput structure.