| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
ConfirmSubscription
Description
The ConfirmSubscription action 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".
Request Parameters
For information about the common parameters that all actions use, see Common Parameters.
- AuthenticateOnUnsubscribe
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is
trueand the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action will require AWS authentication.Type: String
Required: No
- Token
Short-lived token sent to an endpoint during the
Subscribeaction.Type: String
Required: Yes
- TopicArn
The ARN of the topic for which you wish to confirm a subscription.
Type: String
Required: Yes
Response Elements
The following
element is
returned in a ConfirmSubscriptionResult structure.
- SubscriptionArn
The ARN of the created subscription.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationError
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
- InternalError
Indicates an internal service error.
HTTP Status Code: 500
- InvalidParameter
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- NotFound
Indicates that the requested resource does not exist.
HTTP Status Code: 404
- SubscriptionLimitExceeded
Indicates that the customer already owns the maximum allowed number of subscriptions.
HTTP Status Code: 403
Examples
Sample Request
https://sns.us-east-1.amazonaws.com/ ?Action=ConfirmSubscription &TopicArn=arn:aws:sns:us-east-1:123456789012:My-Topic &Token=51b2ff3edb475b7d91550e0ab6edf0c1de2a34e6ebaf6 c2262a001bcb7e051c43aa00022ceecce70bd2a67b2042da8d8 eb47fef7a4e4e942d23e7fa56146b9ee35da040b4b8af564cc4 184a7391c834cb75d75c22981f776ad1ce8805e9bab29da2329 985337bb8095627907b46c8577c8440556b6f86582a95475802 6f41fc62041c4b3f67b0f5921232b5dae5aaca1
Sample Response
<ConfirmSubscriptionResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/">
<ConfirmSubscriptionResult>
<SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>
</ConfirmSubscriptionResult>
<ResponseMetadata>
<RequestId>7a50221f-3774-11df-a9b7-05d48da6f042</RequestId>
</ResponseMetadata>
</ConfirmSubscriptionResponse>
