Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same account, the endpoint owner must run the ConfirmSubscription
action to confirm the subscription.
You call the ConfirmSubscription
action with the token from the subscription response. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
subscribe
--topic-arn <value>
--protocol <value>
[--attributes <value>]
[--return-subscription-arn | --no-return-subscription-arn]
[--notification-endpoint <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--topic-arn
(string)
The ARN of the topic you want to subscribe to.
--protocol
(string)
The protocol that 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
application
– delivery of JSON-encoded message to an EndpointArn for a mobile app and device
lambda
– delivery of JSON-encoded message to an Lambda function
firehose
– delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
--attributes
(map)
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the
Subscribe
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 totrue
, 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.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can’t be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide .
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--return-subscription-arn
| --no-return-subscription-arn
(boolean)
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
true
, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes thepending subscription
ARN value for subscriptions that aren’t yet confirmed. A subscription becomes confirmed when the subscriber calls theConfirmSubscription
action with a confirmation token.The default value is
false
.
--notification-endpoint
(string)
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the
http
protocol, the (public) endpoint is a URL beginning withhttp://
.For the
https
protocol, the (public) endpoint is a URL beginning withhttps://
.For the
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 Lambda function.For the
firehose
protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To subscribe to a topic
The following subscribe
command subscribes an email address to the specified topic.
aws sns subscribe \
--topic-arn arn:aws:sns:us-west-2:123456789012:my-topic \
--protocol email \
--notification-endpoint my-email@example.com
Output:
{
"SubscriptionArn": "pending confirmation"
}
SubscriptionArn -> (string)
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.