Amazon Simple Notification Service
API Reference (API Version 2010-03-31)

Subscribe

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

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.

Attributes
Attributes.entry.N.key (key)
Attributes.entry.N.value (value)

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

Type: String to string map

Required: No

Endpoint

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with "https://"

  • For the https protocol, the endpoint is a URL beginning with "https://"

  • For the email protocol, the endpoint is an email address

  • For the email-json protocol, the endpoint is an email address

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

Type: String

Required: No

Protocol

The protocol you want to use. Supported protocols include:

  • http – delivery of JSON-encoded message via HTTP POST

  • https – delivery of JSON-encoded message via HTTPS POST

  • email – delivery of message via SMTP

  • email-json – delivery of JSON-encoded message via SMTP

  • sms – delivery of message via SMS

  • sqs – delivery of JSON-encoded message to an Amazon SQS queue

  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device.

  • lambda – delivery of JSON-encoded message to an AWS Lambda function.

Type: String

Required: Yes

ReturnSubscriptionArn

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.

The default value is false.

Type: Boolean

Required: No

TopicArn

The ARN of the topic you want to subscribe to.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

SubscriptionArn

The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.

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

FilterPolicyLimitExceeded

Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the AWS Support Center.

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

SubscriptionLimitExceeded

Indicates that the customer already owns the maximum allowed number of subscriptions.

HTTP Status Code: 403

Example

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of Signed Signature Version 4 Requests in the Amazon Web Services General Reference.

Example

The following example Query request subscribes an SQS queue to an SNS topic. For more information, see Subscribe Queue to Amazon SNS Topic in the Amazon SQS Developer Guide.

Sample Request

https://sns.us-west-2.amazonaws.com/?Action=Subscribe &TopicArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3AMyTopic &Endpoint=arn%3Aaws%3Asqs%3Aus-west-2%3A123456789012%3AMyQueue &Protocol=sqs &Version=2010-03-31 &AUTHPARAMS

Sample Response

<SubscribeResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/"> <SubscribeResult> <SubscriptionArn>arn:aws:sns:us-west-2:123456789012:MyTopic:6b0e71bd-7e97-4d97-80ce-4a0994e55286</SubscriptionArn> </SubscribeResult> <ResponseMetadata> <RequestId>c4407779-24a4-56fa-982c-3d927f93a775</RequestId> </ResponseMetadata> </SubscribeResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: