aws-sdk-sns 1.23.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3894b5b22dc0342f12d95671c956e0882159fb2933d55312efc3bf686c8d354e
-  data.tar.gz: c14cd8e726026183608f9d5ecffa861be9532ce6c4c045e4625a52be7a354c49
+  metadata.gz: 45b8acdaa8ab119ccffadab846b65abd4c95c10d4721cf74a5ff3f6ab601f2bf
+  data.tar.gz: f289d6e41b035a989bf9c6a7eea842d29914ea012572d293b04c3c2a92bf6d59
 SHA512:
-  metadata.gz: 7bca415a7bab5f9d6d41b72d43806c88cf276c9c465faa908bdb93c32417c844eaf1d2b8e1501dc274a9f423fd578e72859f6fd74e052b2b16746f386ba79005
-  data.tar.gz: a88a9fc4d1d6b56df49c9703bc45417e4631838c32e13c8f5e772f7db39e8ad9de05a750d02adc8beadb61acf7d76e1fe621f98ddf1194c9ff1f39379a6c1d82
+  metadata.gz: a4efacd88554360f4ab4a1f08589b4ee5a8794f9a77eb470f3a0c9f5859ab0cf87944cf5772e5d9e27f8e753795c4eda5749b5224c1f3758c1c03ea84a38ff1b
+  data.tar.gz: 391eb3b717fec77c7e07fa22ca56126c426b7dc5d2dd39d76ca30ae456bb2e62b15af6f3a036ee345a485819717d0fcf39e6ef90812e926480cbec0783e04294

data/lib/aws-sdk-sns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -49,6 +51,6 @@ require_relative 'aws-sdk-sns/customizations'
 # @service
 module Aws::SNS
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.28.0'
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/query.rb'
 
@@ -69,6 +72,7 @@ module Aws::SNS
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::Query)
 
@@ -161,7 +165,7 @@ module Aws::SNS
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be a valid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::SNS
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -425,25 +429,34 @@ module Aws::SNS
     end
 
     # Creates a platform application object for one of the supported push
-    # notification services, such as APNS and FCM, to which devices and
-    # mobile apps may register. You must specify PlatformPrincipal and
-    # PlatformCredential attributes when using the
-    # `CreatePlatformApplication` action. The PlatformPrincipal is received
-    # from the notification service. For APNS/APNS\_SANDBOX,
-    # PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal
-    # is not applicable. For ADM, PlatformPrincipal is "client id". The
-    # PlatformCredential is also received from the notification service. For
-    # WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
-    # PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal
-    # is "API key".
-    #
-    # For APNS/APNS\_SANDBOX, PlatformCredential is "private key". For
-    # FCM, PlatformCredential is "API key". For ADM, PlatformCredential is
-    # "client secret". For WNS, PlatformCredential is "secret key". For
-    # MPNS, PlatformCredential is "private key". For Baidu,
-    # PlatformCredential is "secret key". The PlatformApplicationArn that
-    # is returned when using `CreatePlatformApplication` is then used as an
-    # attribute for the `CreatePlatformEndpoint` action.
+    # notification services, such as APNS and GCM (Firebase Cloud
+    # Messaging), to which devices and mobile apps may register. You must
+    # specify `PlatformPrincipal` and `PlatformCredential` attributes when
+    # using the `CreatePlatformApplication` action.
+    #
+    # `PlatformPrincipal` and `PlatformCredential` are received from the
+    # notification service.
+    #
+    # * For `ADM`, `PlatformPrincipal` is `client id` and
+    #   `PlatformCredential` is `client secret`.
+    #
+    # * For `Baidu`, `PlatformPrincipal` is `API key` and
+    #   `PlatformCredential` is `secret key`.
+    #
+    # * For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
+    #   certificate` and `PlatformCredential` is `private key`.
+    #
+    # * For `GCM` (Firebase Cloud Messaging), there is no
+    #   `PlatformPrincipal` and the `PlatformCredential` is `API key`.
+    #
+    # * For `MPNS`, `PlatformPrincipal` is `TLS certificate` and
+    #   `PlatformCredential` is `private key`.
+    #
+    # * For `WNS`, `PlatformPrincipal` is `Package Security Identifier` and
+    #   `PlatformCredential` is `secret key`.
+    #
+    # You can use the returned `PlatformApplicationArn` as an attribute for
+    # the `CreatePlatformEndpoint` action.
     #
     # @option params [required, String] :name
     #   Application names must be made up of only uppercase and lowercase
@@ -452,7 +465,7 @@ module Aws::SNS
     #
     # @option params [required, String] :platform
     #   The following platforms are supported: ADM (Amazon Device Messaging),
-    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
+    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
     #   (Firebase Cloud Messaging).
     #
     # @option params [required, Hash<String,String>] :attributes
@@ -490,16 +503,16 @@ module Aws::SNS
     end
 
     # Creates an endpoint for a device and mobile app on one of the
-    # supported push notification services, such as FCM and APNS.
-    # `CreatePlatformEndpoint` requires the PlatformApplicationArn that is
-    # returned from `CreatePlatformApplication`. The EndpointArn that is
-    # returned when using `CreatePlatformEndpoint` can then be used by the
-    # `Publish` action to send a message to a mobile app or by the
-    # `Subscribe` action for subscription to a topic. The
-    # `CreatePlatformEndpoint` action is idempotent, so if the requester
-    # already owns an endpoint with the same device token and attributes,
-    # that endpoint's ARN is returned without creating a new endpoint. For
-    # more information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # supported push notification services, such as GCM (Firebase Cloud
+    # Messaging) and APNS. `CreatePlatformEndpoint` requires the
+    # `PlatformApplicationArn` that is returned from
+    # `CreatePlatformApplication`. You can use the returned `EndpointArn` to
+    # send a message to a mobile app or by the `Subscribe` action for
+    # subscription to a topic. The `CreatePlatformEndpoint` action is
+    # idempotent, so if the requester already owns an endpoint with the same
+    # device token and attributes, that endpoint's ARN is returned without
+    # creating a new endpoint. For more information, see [Using Amazon SNS
+    # Mobile Push Notifications][1].
     #
     # When using `CreatePlatformEndpoint` with Baidu, two attributes must be
     # provided: ChannelId and UserId. The token field must also contain the
@@ -520,8 +533,8 @@ 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 FCM or ADM, the device token equivalent is called the
-    #   registration ID.
+    #   when using GCM (Firebase Cloud Messaging) or ADM, the device token
+    #   equivalent is called the registration ID.
     #
     # @option params [String] :custom_user_data
     #   Arbitrary user data to associate with the endpoint. Amazon SNS does
@@ -563,10 +576,11 @@ module Aws::SNS
     end
 
     # Creates a topic to which notifications can be published. Users can
-    # create at most 100,000 topics. For more information, see
-    # [https://aws.amazon.com/sns][1]. This action is idempotent, so if the
-    # requester already owns a topic with the specified name, that topic's
-    # ARN is returned without creating a new topic.
+    # create at most 100,000 standard topics (at most 1,000 FIFO topics).
+    # For more information, see [https://aws.amazon.com/sns][1]. This action
+    # is idempotent, so if the requester already owns a topic with the
+    # specified name, that topic's ARN is returned without creating a new
+    # topic.
     #
     #
     #
@@ -579,6 +593,9 @@ module Aws::SNS
     #   lowercase ASCII letters, numbers, underscores, and hyphens, and must
     #   be between 1 and 256 characters long.
     #
+    #   For a FIFO (first-in-first-out) topic, the name must end with the
+    #   `.fifo` suffix.
+    #
     # @option params [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
@@ -591,18 +608,34 @@ module Aws::SNS
     #   * `DisplayName` – The display name to use for a topic with SMS
     #     subscriptions.
     #
+    #   * `FifoTopic` – Set to true to create a FIFO topic.
+    #
     #   * `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][1]\:
     #
-    #   * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
+    #   * `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*.
     #
     #   ^
     #
+    #   The following attribute applies only to FIFO topics:
+    #
+    #   * `ContentBasedDeduplication` – Enables content-based deduplication.
+    #     Amazon SNS uses a SHA-256 hash to generate the
+    #     `MessageDeduplicationId` using the body of the message (but not the
+    #     attributes of the message).
+    #
+    #   * When `ContentBasedDeduplication` is in effect, messages with
+    #     identical content sent within the deduplication interval are treated
+    #     as duplicates and only one copy of the message is delivered.
+    #
+    #   * If the queue has `ContentBasedDeduplication` set, your
+    #     `MessageDeduplicationId` overrides the generated one.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -681,8 +714,9 @@ module Aws::SNS
     end
 
     # Deletes a platform application object for one of the supported push
-    # notification services, such as APNS and FCM. For more information, see
-    # [Using Amazon SNS Mobile Push Notifications][1].
+    # notification services, such as APNS and GCM (Firebase Cloud
+    # Messaging). For more information, see [Using Amazon SNS Mobile Push
+    # Notifications][1].
     #
     #
     #
@@ -734,8 +768,9 @@ module Aws::SNS
     end
 
     # Retrieves the endpoint attributes for a device on one of the supported
-    # push notification services, such as FCM and APNS. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # push notification services, such as GCM (Firebase Cloud Messaging) and
+    # APNS. For more information, see [Using Amazon SNS Mobile Push
+    # Notifications][1].
     #
     #
     #
@@ -769,8 +804,9 @@ module Aws::SNS
     end
 
     # Retrieves the attributes of the platform application object for the
-    # supported push notification services, such as APNS and FCM. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # supported push notification services, such as APNS and GCM (Firebase
+    # Cloud Messaging). For more information, see [Using Amazon SNS Mobile
+    # Push Notifications][1].
     #
     #
     #
@@ -904,11 +940,11 @@ module Aws::SNS
     end
 
     # Lists the endpoints and endpoint attributes for devices in a supported
-    # push notification service, such as FCM and APNS. The results for
-    # `ListEndpointsByPlatformApplication` are paginated and return a
-    # limited list of endpoints, up to 100. If additional records are
-    # available after the first page results, then a NextToken string will
-    # be returned. To receive the next page, you call
+    # push notification service, such as GCM (Firebase Cloud Messaging) and
+    # APNS. The results for `ListEndpointsByPlatformApplication` are
+    # paginated and return a limited list of endpoints, up to 100. If
+    # additional records are available after the first page results, then a
+    # NextToken string will be returned. To receive the next page, you call
     # `ListEndpointsByPlatformApplication` again using the NextToken string
     # received from the previous call. When there are no more records to
     # return, NextToken will be null. For more information, see [Using
@@ -1003,14 +1039,15 @@ module Aws::SNS
     end
 
     # Lists the platform application objects for the supported push
-    # notification services, such as APNS and FCM. The results for
-    # `ListPlatformApplications` are paginated and return a limited list of
-    # applications, up to 100. If additional records are available after the
-    # first page results, then a NextToken string will be returned. To
-    # receive the next page, you call `ListPlatformApplications` using the
-    # NextToken string received from the previous call. When there are no
-    # more records to return, NextToken will be null. For more information,
-    # see [Using Amazon SNS Mobile Push Notifications][1].
+    # notification services, such as APNS and GCM (Firebase Cloud
+    # Messaging). The results for `ListPlatformApplications` are paginated
+    # and return a limited list of applications, up to 100. If additional
+    # records are available after the first page results, then a NextToken
+    # string will be returned. To receive the next page, you call
+    # `ListPlatformApplications` using the NextToken string received from
+    # the previous call. When there are no more records to return,
+    # `NextToken` will be null. For more information, see [Using Amazon SNS
+    # Mobile Push Notifications][1].
     #
     # This action is throttled at 15 transactions per second (TPS).
     #
@@ -1241,8 +1278,9 @@ module Aws::SNS
       req.send_request(options)
     end
 
-    # Sends a message to an Amazon SNS topic or sends a text message (SMS
-    # message) directly to a phone number.
+    # Sends a message to an Amazon SNS topic, a text message (SMS message)
+    # directly to a phone number, or a message to a mobile platform endpoint
+    # (when you specify the `TargetArn`).
     #
     # If you send a message to a topic, Amazon SNS delivers the message to
     # each endpoint that is subscribed to the topic. The format of the
@@ -1261,6 +1299,9 @@ module Aws::SNS
     # For more information about formatting messages, see [Send Custom
     # Platform-Specific Payloads in Messages to Mobile Devices][1].
     #
+    # You can publish messages only to topics and endpoints in the same AWS
+    # Region.
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html
@@ -1429,8 +1470,9 @@ module Aws::SNS
     end
 
     # Sets the attributes for an endpoint for a device on one of the
-    # supported push notification services, such as FCM and APNS. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # supported push notification services, such as GCM (Firebase Cloud
+    # Messaging) and APNS. For more information, see [Using Amazon SNS
+    # Mobile Push Notifications][1].
     #
     #
     #
@@ -1478,11 +1520,11 @@ module Aws::SNS
     end
 
     # Sets the attributes of the platform application object for the
-    # supported push notification services, such as APNS and FCM. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
-    # information on configuring attributes for message delivery status, see
-    # [Using Amazon SNS Application Attributes for Message Delivery
-    # Status][2].
+    # supported push notification services, such as APNS and GCM (Firebase
+    # Cloud Messaging). For more information, see [Using Amazon SNS Mobile
+    # Push Notifications][1]. For information on configuring attributes for
+    # message delivery status, see [Using Amazon SNS Application Attributes
+    # for Message Delivery Status][2].
     #
     #
     #
@@ -1497,26 +1539,27 @@ module Aws::SNS
     #   include the following:
     #
     #   * `PlatformCredential` – The credential received from the notification
-    #     service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
-    #     For FCM, PlatformCredential is "API key". For ADM,
-    #     PlatformCredential is "client secret".
+    #     service. For `APNS` and `APNS_SANDBOX`, `PlatformCredential` is
+    #     `private key`. For `GCM` (Firebase Cloud Messaging),
+    #     `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 FCM, PlatformPrincipal is not applicable. For ADM,
-    #     PlatformPrincipal is "client id".
+    #     service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
+    #     certificate`. For `GCM` (Firebase Cloud Messaging), there is no
+    #     `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.
     #
-    #   * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
-    #     notifications should be sent.
+    #   * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
+    #     notifications are sent.
     #
-    #   * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
-    #     notifications should be sent.
+    #   * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
+    #     notifications are sent.
     #
-    #   * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
-    #     notifications should be sent.
+    #   * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
+    #     notifications are sent.
     #
-    #   * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
-    #     notifications should be sent upon Direct Publish delivery failure
+    #   * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event
+    #     notifications are sent upon Direct Publish delivery failure
     #     (permanent) to one of the application's endpoints.
     #
     #   * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
@@ -1738,13 +1781,27 @@ module Aws::SNS
     #
     #   The following attribute applies only to [server-side-encryption][1]\:
     #
-    #   * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
+    #   * `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*.
     #
     #   ^
     #
+    #   The following attribute applies only to FIFO topics:
+    #
+    #   * `ContentBasedDeduplication` – Enables content-based deduplication.
+    #     Amazon SNS uses a SHA-256 hash to generate the
+    #     `MessageDeduplicationId` using the body of the message (but not the
+    #     attributes of the message).
+    #
+    #   * When `ContentBasedDeduplication` is in effect, messages with
+    #     identical content sent within the deduplication interval are treated
+    #     as duplicates and only one copy of the message is delivered.
+    #
+    #   * If the queue has `ContentBasedDeduplication` set, your
+    #     `MessageDeduplicationId` overrides the generated one.
+    #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -1773,11 +1830,13 @@ module Aws::SNS
       req.send_request(options)
     end
 
-    # 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.
+    # 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 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).
     #
@@ -1809,11 +1868,11 @@ module Aws::SNS
     #   The endpoint that you want to receive notifications. Endpoints vary by
     #   protocol:
     #
-    #   * For the `http` protocol, the endpoint is an URL beginning with
-    #     `http://`
+    #   * For the `http` protocol, the (public) endpoint is a URL beginning
+    #     with `http://`
     #
-    #   * For the `https` protocol, the endpoint is a URL beginning with
-    #     `https://`
+    #   * For the `https` protocol, the (public) endpoint is a URL beginning
+    #     with `https://`
     #
     #   * For the `email` protocol, the endpoint is an email address
     #
@@ -1860,16 +1919,17 @@ module Aws::SNS
     #   Sets whether the response from the `Subscribe` request includes the
     #   subscription ARN, even if the subscription is not yet confirmed.
     #
-    #   * 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 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 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 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 default value is `false`.
     #
@@ -2030,7 +2090,7 @@ module Aws::SNS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sns'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end