SNS / Client / confirm_subscription

confirm_subscription#

SNS.Client.confirm_subscription(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.confirm_subscription(
    TopicArn='string',
    Token='string',
    AuthenticateOnUnsubscribe='string'
)
Parameters:

  • TopicArn (string) –

    [REQUIRED]

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

  • Token (string) –

    [REQUIRED]

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

  • AuthenticateOnUnsubscribe (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'SubscriptionArn': 'string'
}

Response Structure

  • (dict) –

    Response for ConfirmSubscriptions action.

    • SubscriptionArn (string) –

      The ARN of the created subscription.

Exceptions

  • SNS.Client.exceptions.SubscriptionLimitExceededException

  • SNS.Client.exceptions.InvalidParameterException

  • SNS.Client.exceptions.NotFoundException

  • SNS.Client.exceptions.InternalErrorException

  • SNS.Client.exceptions.AuthorizationErrorException

  • SNS.Client.exceptions.FilterPolicyLimitExceededException