|« PreviousNext »|
|Did this page help you? Yes | No | Tell us about it...|
Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a
subscription, the endpoint owner must call the
action with the token from the confirmation message. Confirmation tokens are
valid for three days.
For information about the common parameters that all actions use, see Common Parameters.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
httpprotocol, the endpoint is an URL beginning with "http://"
httpsprotocol, the endpoint is a URL beginning with "https://"
email-jsonprotocol, the endpoint is an email address
smsprotocol, the endpoint is a phone number of an SMS-enabled device
sqsprotocol, the endpoint is the ARN of an Amazon SQS queue
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-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
The ARN of the topic you want to subscribe to.
returned in a structure named
The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).
For information about the errors that are common to all actions, see Common Errors.
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
Indicates an internal service error.
HTTP Status Code: 500
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
Indicates that the requested resource does not exist.
HTTP Status Code: 404
Indicates that the customer already owns the maximum allowed number of subscriptions.
HTTP Status Code: 403
http://sns.us-east-1.amazonaws.com/ ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic &Endpoint=example%40amazon.com &Protocol=email &Action=Subscribe &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access Key ID) &Signature=1%2FeGaDphxXq%2Fa89x6HvKh%2Fc1yLGXzuhS7vS2MslToDM%3D
<SubscribeResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/"> <SubscribeResult> <SubscriptionArn>pending confirmation</SubscriptionArn> </SubscribeResult> <ResponseMetadata> <RequestId>a169c740-3766-11df-8963-01868b7c937a</RequestId> </ResponseMetadata> </SubscribeResponse>