Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see https://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
", + "service": "Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
", "operations": { "AddPermission": "Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
", "CheckIfPhoneNumberIsOptedOut": "Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
Removes a statement from a topic's access control policy.
", "SetEndpointAttributes": "Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
", "SetPlatformApplicationAttributes": "Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
", - "SetSMSAttributes": "Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.
To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.
Allows a subscription owner to set an attribute of the subscription to a new value.
", "SetTopicAttributes": "Allows a topic owner to set an attribute of the topic to a new value.
", "Subscribe": "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 AWS 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).
", @@ -524,8 +524,8 @@ "SubscriptionAttributesMap": { "base": null, "refs": { - "GetSubscriptionAttributesResponse$Attributes": "A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.
DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
Owner – The AWS account ID of the subscription's owner.
PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
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.
SubscriptionArn – The subscription's ARN.
TopicArn – The topic ARN that the subscription is associated with.
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.
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.
A map of the subscription's attributes. Attributes in this map include the following:
ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.
DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
Owner – The AWS account ID of the subscription's owner.
PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
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.
SubscriptionArn – The subscription's ARN.
TopicArn – The topic ARN that the subscription is associated with.
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.
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.
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.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this 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.
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.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this 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.
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.
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.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the (public) endpoint is a URL beginning with http://
For the https protocol, the (public) 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 Amazon Lambda function.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
For the http protocol, the (public) endpoint is a URL beginning with http://.
For the https protocol, the (public) 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.
For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
The subscription's endpoint (format depends on the protocol).
" } }, @@ -732,7 +732,7 @@ "protocol": { "base": null, "refs": { - "SubscribeInput$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 Amazon Lambda function.
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 – 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
firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The subscription's protocol.
" } }, diff --git a/service/sns/api.go b/service/sns/api.go index b916003cbc7..54746a3ebf9 100644 --- a/service/sns/api.go +++ b/service/sns/api.go @@ -2865,6 +2865,9 @@ func (c *SNS) SetSMSAttributesRequest(input *SetSMSAttributesInput) (req *reques // information, see Publishing to a mobile phone (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html) // in the Amazon SNS Developer Guide. // +// To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) +// permission to perform the s3:ListBucket action. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4590,6 +4593,17 @@ type GetSubscriptionAttributesOutput struct { // * SubscriptionArn – The subscription's ARN. // // * TopicArn – The topic ARN that the subscription is associated with. + // + // 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 + // (https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html) + // in the Amazon SNS Developer Guide. Attributes map[string]*string `type:"map"` } @@ -5991,6 +6005,17 @@ type SetSubscriptionAttributesInput struct { // 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 + // (https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html) + // in the Amazon SNS Developer Guide. + // // AttributeName is a required field AttributeName *string `type:"string" required:"true"` @@ -6194,33 +6219,46 @@ type SubscribeInput struct { // 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 + // (https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html) + // in the Amazon SNS Developer Guide. Attributes map[string]*string `type:"map"` // The endpoint that you want to receive notifications. Endpoints vary by protocol: // // * For the http protocol, the (public) endpoint is a URL beginning with - // http:// + // http://. // // * For the https protocol, the (public) endpoint is a URL beginning with - // https:// + // https://. // - // * For the email protocol, the endpoint is an email address + // * For the email protocol, the endpoint is an email address. // - // * For the email-json 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 + // device. // - // * For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue + // * 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 Amazon Lambda - // function. + // * For the lambda protocol, the endpoint is the ARN of an AWS Lambda function. + // + // * For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis + // Data Firehose delivery stream. Endpoint *string `type:"string"` - // The protocol you want to use. Supported protocols include: + // The protocol that you want to use. Supported protocols include: // // * http – delivery of JSON-encoded message via HTTP POST // @@ -6235,9 +6273,12 @@ type SubscribeInput struct { // * 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. + // a mobile app and device + // + // * lambda – delivery of JSON-encoded message to an AWS Lambda function // - // * lambda – delivery of JSON-encoded message to an Amazon Lambda function. + // * firehose – delivery of JSON-encoded message to an Amazon Kinesis Data + // Firehose delivery stream. // // Protocol is a required field Protocol *string `type:"string" required:"true"` diff --git a/service/sns/doc.go b/service/sns/doc.go index 45588677de2..714e3b87f6e 100644 --- a/service/sns/doc.go +++ b/service/sns/doc.go @@ -7,7 +7,7 @@ // you to build distributed web-enabled applications. Applications can use Amazon // SNS to easily push real-time notification messages to interested subscribers // over multiple delivery protocols. For more information about this product -// see https://aws.amazon.com/sns (http://aws.amazon.com/sns/). For detailed +// see the Amazon SNS product page (http://aws.amazon.com/sns/). For detailed // information about Amazon SNS features and their associated API calls, see // the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/). //