Unsubscribe
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 AWS
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.
Note
Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required AWS signature.
This action is throttled at 100 transactions per second (TPS).
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- SubscriptionArn
-
The ARN of the subscription to be deleted.
Type: String
Required: Yes
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
- InvalidSecurity
-
The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
HTTP Status Code: 403
- NotFound
-
Indicates that the requested resource does not exist.
HTTP Status Code: 404
Examples
The structure of AUTHPARAMS depends on the signature of the API request.
For more information, see Examples
of the complete Signature Version 4 signing process (Python) in the
AWS General Reference.
Example
This example illustrates one usage of Unsubscribe.
Sample Request
https://sns.us-east-2.amazonaws.com/?Action=Unsubscribe
&SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-2%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca
&Version=2010-03-31
&AUTHPARAMSSample Response
<UnsubscribeResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
<ResponseMetadata>
<RequestId>18e0ac39-3776-11df-84c0-b93cc1666b84</RequestId>
</ResponseMetadata>
</UnsubscribeResponse> See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
