confirm_subscription¶
Operation¶
async
¶
confirm_subscription(input: ConfirmSubscriptionInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
ConfirmSubscriptionInput
|
An instance of |
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 |
|---|---|
ConfirmSubscriptionOutput
|
An instance of |
Input¶
dataclass
¶
Input for ConfirmSubscription action.
Attributes¶
class-attribute
instance-attribute
¶
authenticate_on_unsubscribe: str | None = 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.
class-attribute
instance-attribute
¶
token: str | None = None
Short-lived token sent to an endpoint during the Subscribe action.
class-attribute
instance-attribute
¶
topic_arn: str | None = None
The ARN of the topic for which you wish to confirm a subscription.