aws-sdk-sns 1.19.0 → 1.24.0

data/lib/aws-sdk-sns/errors.rb

@@ -6,6 +6,51 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SNS
+
+  # When SNS returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::SNS::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all SNS errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::SNS::Errors::ServiceError
+  #       # rescues all SNS API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {AuthorizationErrorException}
+  # * {ConcurrentAccessException}
+  # * {EndpointDisabledException}
+  # * {FilterPolicyLimitExceededException}
+  # * {InternalErrorException}
+  # * {InvalidParameterException}
+  # * {InvalidParameterValueException}
+  # * {InvalidSecurityException}
+  # * {KMSAccessDeniedException}
+  # * {KMSDisabledException}
+  # * {KMSInvalidStateException}
+  # * {KMSNotFoundException}
+  # * {KMSOptInRequired}
+  # * {KMSThrottlingException}
+  # * {NotFoundException}
+  # * {PlatformApplicationDisabledException}
+  # * {ResourceNotFoundException}
+  # * {StaleTagException}
+  # * {SubscriptionLimitExceededException}
+  # * {TagLimitExceededException}
+  # * {TagPolicyException}
+  # * {ThrottledException}
+  # * {TopicLimitExceededException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +68,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class ConcurrentAccessException < ServiceError
@@ -39,7 +83,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class EndpointDisabledException < ServiceError
@@ -55,7 +98,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class FilterPolicyLimitExceededException < ServiceError
@@ -71,7 +113,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalErrorException < ServiceError
@@ -87,7 +128,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidParameterException < ServiceError
@@ -103,7 +143,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidParameterValueException < ServiceError
@@ -119,7 +158,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidSecurityException < ServiceError
@@ -135,7 +173,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSAccessDeniedException < ServiceError
@@ -151,7 +188,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSDisabledException < ServiceError
@@ -167,7 +203,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSInvalidStateException < ServiceError
@@ -183,7 +218,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSNotFoundException < ServiceError
@@ -199,7 +233,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSOptInRequired < ServiceError
@@ -215,7 +248,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSThrottlingException < ServiceError
@@ -231,7 +263,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class NotFoundException < ServiceError
@@ -247,7 +278,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class PlatformApplicationDisabledException < ServiceError
@@ -263,7 +293,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -279,7 +308,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class StaleTagException < ServiceError
@@ -295,7 +323,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class SubscriptionLimitExceededException < ServiceError
@@ -311,7 +338,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class TagLimitExceededException < ServiceError
@@ -327,7 +353,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class TagPolicyException < ServiceError
@@ -343,7 +368,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottledException < ServiceError
@@ -359,7 +383,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
     class TopicLimitExceededException < ServiceError
@@ -375,7 +398,6 @@ module Aws::SNS
       def message
         @message || @data[:message]
       end
-
     end
 
   end

data/lib/aws-sdk-sns/platform_application.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SNS
+
   class PlatformApplication
 
     extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
       @arn = extract_arn(args, options)
       @data = options.delete(:data)
       @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
     end
 
     # @!group Read-Only Attributes
@@ -101,7 +103,7 @@ module Aws::SNS
     #   device. The specific name for Token will vary, depending on which
     #   notification service is being used. For example, when using APNS as
     #   the notification service, you need the device token. Alternatively,
-    #   when using GCM or ADM, the device token equivalent is called the
+    #   when using FCM or ADM, the device token equivalent is called the
     #   registration ID.
     # @option options [String] :custom_user_data
     #   Arbitrary user data to associate with the endpoint. Amazon SNS does
@@ -147,12 +149,12 @@ module Aws::SNS
     #
     #   * `PlatformCredential` – The credential received from the notification
     #     service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
-    #     For GCM, PlatformCredential is "API key". For ADM,
+    #     For FCM, PlatformCredential is "API key". For ADM,
     #     PlatformCredential is "client secret".
     #
     #   * `PlatformPrincipal` – The principal received from the notification
     #     service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
-    #     certificate. For GCM, PlatformPrincipal is not applicable. For ADM,
+    #     certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
     #     PlatformPrincipal is "client id".
     #
     #   * `EventEndpointCreated` – Topic ARN to which EndpointCreated event

data/lib/aws-sdk-sns/platform_endpoint.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SNS
+
   class PlatformEndpoint
 
     extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
       @arn = extract_arn(args, options)
       @data = options.delete(:data)
       @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
     end
 
     # @!group Read-Only Attributes
@@ -45,6 +47,10 @@ module Aws::SNS
     #   an app and mobile device. This is returned from the notification
     #   service when an app and mobile device are registered with the
     #   notification service.
+    #
+    #   <note markdown="1"> The device token for the iOS platform is returned in lowercase.
+    #
+    #    </note>
     # @return [Hash<String,String>]
     def attributes
       data[:attributes]
@@ -129,10 +135,6 @@ module Aws::SNS
     # @option options [required, String] :message
     #   The message you want to send.
     #
-    #   The `Message` parameter is always a string. If you set
-    #   `MessageStructure` to `json`, you must string-encode the `Message`
-    #   parameter.
-    #
     #   If you are publishing to a topic and you want to send the same message
     #   to all transport protocols, include the text of the message as a
     #   String value. If you want to send different messages for each
@@ -208,16 +210,7 @@ module Aws::SNS
     #   You can define other top-level keys that define the message you want
     #   to send to a specific transport protocol (e.g., "http").
     #
-    #   For information about sending different messages for each protocol
-    #   using the AWS Management Console, go to [Create Different Messages for
-    #   Each Protocol][1] in the *Amazon Simple Notification Service Getting
-    #   Started Guide*.
-    #
     #   Valid value: `json`
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
     # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
     #   Message attributes for Publish action.
     # @return [Types::PublishResponse]

data/lib/aws-sdk-sns/resource.rb

@@ -6,6 +6,18 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SNS
+
+  # This class provides a resource oriented interface for SNS.
+  # To create a resource object:
+  #
+  #     resource = Aws::SNS::Resource.new(region: 'us-west-2')
+  #
+  # You can supply a client object with custom configuration that will be used for all resource operations.
+  # If you do not pass `:client`, a default client will be constructed.
+  #
+  #     client = Aws::SNS::Client.new(region: 'us-west-2')
+  #     resource = Aws::SNS::Resource.new(client: client)
+  #
   class Resource
 
     # @param options ({})
@@ -37,8 +49,8 @@ module Aws::SNS
     #   between 1 and 256 characters long.
     # @option options [required, String] :platform
     #   The following platforms are supported: ADM (Amazon Device Messaging),
-    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
-    #   Cloud Messaging).
+    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
+    #   (Firebase Cloud Messaging).
     # @option options [required, Hash<String,String>] :attributes
     #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
     #
@@ -106,6 +118,11 @@ module Aws::SNS
     #   [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
     # @option options [Array<Types::Tag>] :tags
     #   The list of tags to add to a new topic.
+    #
+    #   <note markdown="1"> To be able to tag a topic on creation, you must have the
+    #   `sns:CreateTopic` and `sns:TagResource` permissions.
+    #
+    #    </note>
     # @return [Topic]
     def create_topic(options = {})
       resp = @client.create_topic(options)

data/lib/aws-sdk-sns/subscription.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SNS
+
   class Subscription
 
     extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
       @arn = extract_arn(args, options)
       @data = options.delete(:data)
       @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
     end
 
     # @!group Read-Only Attributes
@@ -56,6 +58,13 @@ module Aws::SNS
     #   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.
@@ -136,6 +145,13 @@ module Aws::SNS
     #     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.
     # @option options [String] :attribute_value
     #   The new value for the attribute in JSON format.
     # @return [EmptyStructure]

data/lib/aws-sdk-sns/topic.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SNS
+
   class Topic
 
     extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::SNS
       @arn = extract_arn(args, options)
       @data = options.delete(:data)
       @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
     end
 
     # @!group Read-Only Attributes
@@ -33,30 +35,45 @@ module Aws::SNS
     # A map of the topic's attributes. Attributes in this map include the
     # following:
     #
-    # * `TopicArn` – the topic's ARN
+    # * `DeliveryPolicy` – The JSON serialization of the topic's delivery
+    #   policy.
+    #
+    # * `DisplayName` – The human-readable name used in the `From` field for
+    #   notifications to `email` and `email-json` endpoints.
+    #
+    # * `Owner` – The AWS account ID of the topic's owner.
+    #
+    # * `Policy` – The JSON serialization of the topic's access control
+    #   policy.
     #
-    # * `Owner` – the AWS account ID of the topic's owner
+    # * `SubscriptionsConfirmed` – The number of confirmed subscriptions for
+    #   the topic.
     #
-    # * `Policy` – the JSON serialization of the topic's access control
-    #   policy
+    # * `SubscriptionsDeleted` – The number of deleted subscriptions for the
+    #   topic.
     #
-    # * `DisplayName` – the human-readable name used in the "From" field
-    #   for notifications to email and email-json endpoints
+    # * `SubscriptionsPending` – The number of subscriptions pending
+    #   confirmation for the topic.
     #
-    # * `SubscriptionsPending` – the number of subscriptions pending
-    #   confirmation on this topic
+    # * `TopicArn` – The topic's ARN.
     #
-    # * `SubscriptionsConfirmed` – the number of confirmed subscriptions on
-    #   this topic
+    # * `EffectiveDeliveryPolicy` – Yhe JSON serialization of the effective
+    #   delivery policy, taking system defaults into account.
     #
-    # * `SubscriptionsDeleted` – the number of deleted subscriptions on this
-    #   topic
+    # The following attribute applies only to [server-side-encryption][1]\:
     #
-    # * `DeliveryPolicy` – the JSON serialization of the topic's delivery
-    #   policy
+    # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
+    #   (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
+    #   Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
+    #   Management Service API Reference*.
     #
-    # * `EffectiveDeliveryPolicy` – the JSON serialization of the effective
-    #   delivery policy that takes into account system defaults
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
+    # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
+    # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
     # @return [Hash<String,String>]
     def attributes
       data[:attributes]
@@ -116,7 +133,7 @@ module Aws::SNS
     # @option options [required, Array<String>] :action_name
     #   The action you want to allow for the specified principal(s).
     #
-    #   Valid values: any Amazon SNS action name.
+    #   Valid values: Any Amazon SNS action name, for example `Publish`.
     # @return [EmptyStructure]
     def add_permission(options = {})
       options = options.merge(topic_arn: @arn)
@@ -189,10 +206,6 @@ module Aws::SNS
     # @option options [required, String] :message
     #   The message you want to send.
     #
-    #   The `Message` parameter is always a string. If you set
-    #   `MessageStructure` to `json`, you must string-encode the `Message`
-    #   parameter.
-    #
     #   If you are publishing to a topic and you want to send the same message
     #   to all transport protocols, include the text of the message as a
     #   String value. If you want to send different messages for each
@@ -268,16 +281,7 @@ module Aws::SNS
     #   You can define other top-level keys that define the message you want
     #   to send to a specific transport protocol (e.g., "http").
     #
-    #   For information about sending different messages for each protocol
-    #   using the AWS Management Console, go to [Create Different Messages for
-    #   Each Protocol][1] in the *Amazon Simple Notification Service Getting
-    #   Started Guide*.
-    #
     #   Valid value: `json`
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
     # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
     #   Message attributes for Publish action.
     # @return [Types::PublishResponse]
@@ -376,17 +380,17 @@ module Aws::SNS
     #   * `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
+    #   * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
     #     function.
     # @option options [String] :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://"
+    #     `http://`
     #
     #   * For the `https` protocol, the endpoint is a URL beginning with
-    #     "https://"
+    #     `https://`
     #
     #   * For the `email` protocol, the endpoint is an email address
     #
@@ -401,8 +405,8 @@ module Aws::SNS
     #   * 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 `lambda` protocol, the endpoint is the ARN of an Amazon
+    #     Lambda function.
     # @option options [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
@@ -420,18 +424,27 @@ module Aws::SNS
     #     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.
     # @option options [Boolean] :return_subscription_arn
     #   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 have the subscription ARN returned, the response includes the
+    #     ARN in all cases, even if the subscription is not yet confirmed.
+    #
+    #   * If you don't have the subscription ARN returned, in addition to the
+    #     ARN for confirmed subscriptions, the response also includes the
+    #     `pending subscription` ARN value for subscriptions that aren't 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.
+    #   If you set this parameter to `true`, .
     #
     #   The default value is `false`.
     # @return [Subscription]