Skip to content

unsubscribe

Operation

unsubscribe

unsubscribe(request: UnsubscribeInput | UnsubscribeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnsubscribeInputDict]) -> 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
request UnsubscribeInput | UnsubscribeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UnsubscribeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UnsubscribeOutput

An instance of UnsubscribeOutput.

unsubscribe async

unsubscribe(request: UnsubscribeInput | UnsubscribeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnsubscribeInputDict]) -> 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
request UnsubscribeInput | UnsubscribeInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UnsubscribeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UnsubscribeOutput

An instance of UnsubscribeOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UnsubscribeInputDict

Bases: TypedDict

Dictionary form of UnsubscribeInput.

Attributes

subscription_arn instance-attribute
subscription_arn: Required[str]

The ARN of the subscription to be deleted.

UnsubscribeInput dataclass

Bases: _SerdeShape

Input for Unsubscribe action.

Attributes

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

The ARN of the subscription to be deleted.

Output

UnsubscribeOutput dataclass

Bases: _SerdeShape

Dataclass for UnsubscribeOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.