aws-sdk-sns 1.22.0 → 1.39.0

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -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'
 
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:sns)
 module Aws::SNS
   # An API client for SNS.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::SNS::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::SNS::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
   #
   # For details on configuring region and credentials see
   # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -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)
 
@@ -81,13 +85,28 @@ module Aws::SNS
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -97,15 +116,15 @@ module Aws::SNS
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -161,7 +180,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 avalid 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 +195,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.
@@ -229,15 +248,19 @@ module Aws::SNS
     #
     #   @option options [String] :retry_mode ("legacy")
     #     Specifies which retry algorithm to use. Values are:
-    #       * `legacy` - The pre-existing retry behavior.  This is default value if
-    #         no retry mode is provided.
-    #       * `standard` - A standardized set of retry rules across the AWS SDKs.
-    #         This includes support for retry quotas, which limit the number of
-    #         unsuccessful retries a client can make.
-    #       * `adaptive` - An experimental retry mode that includes all the
-    #         functionality of `standard` mode along with automatic client side
-    #         throttling.  This is a provisional mode that may change behavior
-    #         in the future.
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -265,8 +288,7 @@ module Aws::SNS
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yielded by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
     #     seconds a connection is allowed to sit idle before it is
@@ -278,7 +300,7 @@ module Aws::SNS
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yielded by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -422,25 +444,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
@@ -449,7 +480,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
@@ -487,16 +518,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
@@ -517,8 +548,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
@@ -560,10 +591,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.
     #
     #
     #
@@ -576,6 +608,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.
     #
@@ -588,23 +623,47 @@ 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 attributes apply only to [FIFO topics][4]\:
+    #
+    #   * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
+    #
+    #   * `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][5] 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.
+    #
     #
     #
     #   [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
+    #   [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
+    #   [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
     #
     # @option params [Array<Types::Tag>] :tags
     #   The list of tags to add to a new topic.
@@ -678,8 +737,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].
     #
     #
     #
@@ -731,8 +791,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].
     #
     #
     #
@@ -766,8 +827,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].
     #
     #
     #
@@ -901,11 +963,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
@@ -931,6 +993,8 @@ module Aws::SNS
     #   * {Types::ListEndpointsByPlatformApplicationResponse#endpoints #endpoints} => Array&lt;Types::Endpoint&gt;
     #   * {Types::ListEndpointsByPlatformApplicationResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_endpoints_by_platform_application({
@@ -998,14 +1062,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).
     #
@@ -1023,6 +1088,8 @@ module Aws::SNS
     #   * {Types::ListPlatformApplicationsResponse#platform_applications #platform_applications} => Array&lt;Types::PlatformApplication&gt;
     #   * {Types::ListPlatformApplicationsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_platform_applications({
@@ -1061,6 +1128,8 @@ module Aws::SNS
     #   * {Types::ListSubscriptionsResponse#subscriptions #subscriptions} => Array&lt;Types::Subscription&gt;
     #   * {Types::ListSubscriptionsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_subscriptions({
@@ -1105,6 +1174,8 @@ module Aws::SNS
     #   * {Types::ListSubscriptionsByTopicResponse#subscriptions #subscriptions} => Array&lt;Types::Subscription&gt;
     #   * {Types::ListSubscriptionsByTopicResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_subscriptions_by_topic({
@@ -1182,6 +1253,8 @@ module Aws::SNS
     #   * {Types::ListTopicsResponse#topics #topics} => Array&lt;Types::Topic&gt;
     #   * {Types::ListTopicsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_topics({
@@ -1228,8 +1301,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
@@ -1248,6 +1322,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
@@ -1354,9 +1431,37 @@ module Aws::SNS
     # @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
     #   Message attributes for Publish action.
     #
+    # @option params [String] :message_deduplication_id
+    #   This parameter applies only to FIFO (first-in-first-out) topics. The
+    #   `MessageDeduplicationId` can contain up to 128 alphanumeric characters
+    #   (a-z, A-Z, 0-9) and punctuation ``
+    #   (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
+    #
+    #   Every message must have a unique `MessageDeduplicationId`, which is a
+    #   token used for deduplication of sent messages. If a message with a
+    #   particular `MessageDeduplicationId` is sent successfully, any message
+    #   sent with the same `MessageDeduplicationId` during the 5-minute
+    #   deduplication interval is treated as a duplicate.
+    #
+    #   If the topic has `ContentBasedDeduplication` set, the system generates
+    #   a `MessageDeduplicationId` based on the contents of the message. Your
+    #   `MessageDeduplicationId` overrides the generated one.
+    #
+    # @option params [String] :message_group_id
+    #   This parameter applies only to FIFO (first-in-first-out) topics. The
+    #   `MessageGroupId` can contain up to 128 alphanumeric characters (a-z,
+    #   A-Z, 0-9) and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
+    #
+    #   The `MessageGroupId` is a tag that specifies that a message belongs to
+    #   a specific message group. Messages that belong to the same message
+    #   group are processed in a FIFO manner (however, messages in different
+    #   message groups might be processed out of order). Every message must
+    #   include a `MessageGroupId`.
+    #
     # @return [Types::PublishResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::PublishResponse#message_id #message_id} => String
+    #   * {Types::PublishResponse#sequence_number #sequence_number} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1374,11 +1479,14 @@ module Aws::SNS
     #         binary_value: "data",
     #       },
     #     },
+    #     message_deduplication_id: "String",
+    #     message_group_id: "String",
     #   })
     #
     # @example Response structure
     #
     #   resp.message_id #=> String
+    #   resp.sequence_number #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Publish AWS API Documentation
     #
@@ -1416,8 +1524,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].
     #
     #
     #
@@ -1465,11 +1574,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].
     #
     #
     #
@@ -1484,26 +1593,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
@@ -1540,8 +1650,14 @@ module Aws::SNS
     #
     # 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 [Sending an SMS Message][1] in
-    # the *Amazon SNS Developer Guide*.
+    # parameter. For more information, see [Publishing to a mobile phone][1]
+    # in the *Amazon SNS Developer Guide*.
+    #
+    # <note markdown="1"> To use this operation, you must grant the Amazon SNS service principal
+    # (`sns.amazonaws.com`) permission to perform the `s3:ListBucket`
+    # action.
+    #
+    #  </note>
     #
     #
     #
@@ -1660,7 +1776,7 @@ module Aws::SNS
     #   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:
+    #   request parameters that this action uses:
     #
     #   * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
     #     failed deliveries to HTTP/S endpoints.
@@ -1681,6 +1797,25 @@ module Aws::SNS
     #     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][1] in the
+    #     *Amazon SNS Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
+    #
     # @option params [String] :attribute_value
     #   The new value for the attribute in JSON format.
     #
@@ -1725,18 +1860,38 @@ 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][4]\:
+    #
+    #   * `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][5] 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.
+    #
     #
     #
     #   [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
+    #   [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
+    #   [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
     #
     # @option params [String] :attribute_value
     #   The new value for the attribute.
@@ -1760,11 +1915,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 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).
     #
@@ -1772,7 +1929,7 @@ module Aws::SNS
     #   The ARN of the topic you want to subscribe to.
     #
     # @option params [required, String] :protocol
-    #   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
     #
@@ -1787,36 +1944,42 @@ module Aws::SNS
     #   * `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.
+    #     for a mobile app and device
     #
-    #   * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
-    #     function.
+    #   * `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.
     #
     # @option params [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
-    #     `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
+    #   * 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
+    #     SMS-enabled device.
     #
     #   * For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS
-    #     queue
+    #     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.
     #
     # @option params [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
@@ -1843,20 +2006,37 @@ module Aws::SNS
     #     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][1] in the
+    #     *Amazon SNS Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
+    #
     # @option params [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 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`.
     #
@@ -2017,7 +2197,7 @@ module Aws::SNS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sns'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.39.0'
       Seahorse::Client::Request.new(handlers, context)
     end