Skip to content

confirm_subscription

Operation

confirm_subscription

confirm_subscription(request: ConfirmSubscriptionInput | ConfirmSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ConfirmSubscriptionInputDict]) -> ConfirmSubscriptionOutput

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

Parameters:

Name Type Description Default
request ConfirmSubscriptionInput | ConfirmSubscriptionInputDict | 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[ConfirmSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ConfirmSubscriptionOutput

An instance of ConfirmSubscriptionOutput.

confirm_subscription async

confirm_subscription(request: ConfirmSubscriptionInput | ConfirmSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ConfirmSubscriptionInputDict]) -> ConfirmSubscriptionOutput

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

Parameters:

Name Type Description Default
request ConfirmSubscriptionInput | ConfirmSubscriptionInputDict | 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[ConfirmSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ConfirmSubscriptionOutput

An instance of ConfirmSubscriptionOutput.

Input

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

ConfirmSubscriptionInputDict

Bases: TypedDict

Dictionary form of ConfirmSubscriptionInput.

Attributes

authenticate_on_unsubscribe instance-attribute
authenticate_on_unsubscribe: str | None

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

token instance-attribute
token: Required[str]

Short-lived token sent to an endpoint during the Subscribe action.

topic_arn instance-attribute
topic_arn: Required[str]

The ARN of the topic for which you wish to confirm a subscription.

ConfirmSubscriptionInput dataclass

Bases: _SerdeShape

Input for ConfirmSubscription action.

Attributes

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

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

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

Short-lived token sent to an endpoint during the Subscribe action.

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

The ARN of the topic for which you wish to confirm a subscription.

Output

ConfirmSubscriptionOutput dataclass

Bases: _SerdeShape

Response for ConfirmSubscriptions action.

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.

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

The ARN of the created subscription.