aws-sdk-sns 1.22.0 → 1.39.0

data/lib/aws-sdk-sns/client_api.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
 
@@ -362,9 +364,12 @@ module Aws::SNS
     PublishInput.add_member(:subject, Shapes::ShapeRef.new(shape: subject, location_name: "Subject"))
     PublishInput.add_member(:message_structure, Shapes::ShapeRef.new(shape: messageStructure, location_name: "MessageStructure"))
     PublishInput.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
+    PublishInput.add_member(:message_deduplication_id, Shapes::ShapeRef.new(shape: String, location_name: "MessageDeduplicationId"))
+    PublishInput.add_member(:message_group_id, Shapes::ShapeRef.new(shape: String, location_name: "MessageGroupId"))
     PublishInput.struct_class = Types::PublishInput
 
     PublishResponse.add_member(:message_id, Shapes::ShapeRef.new(shape: messageId, location_name: "MessageId"))
+    PublishResponse.add_member(:sequence_number, Shapes::ShapeRef.new(shape: String, location_name: "SequenceNumber"))
     PublishResponse.struct_class = Types::PublishResponse
 
     RemovePermissionInput.add_member(:topic_arn, Shapes::ShapeRef.new(shape: topicARN, required: true, location_name: "TopicArn"))

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

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # utility classes
 require 'aws-sdk-sns/message_verifier'

data/lib/aws-sdk-sns/errors.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
 

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'openssl'
 require 'base64'
 
 module Aws
   module SNS
-
     # A utility class that can be used to verify the authenticity of messages
     # sent by Amazon SNS.
     #
@@ -31,16 +32,20 @@ module Aws
         'Timestamp',
         'Token',
         'TopicArn',
-        'Type',
+        'Type'
       ].freeze
 
       # @api private
       AWS_HOSTNAMES = [
         /^sns\.[a-zA-Z0-9\-]{3,}\.amazonaws\.com(\.cn)?$/
-      ]
+      ].freeze
 
-      def initialize
+      # @param [Hash] http_options Supported options to be passed to Net::HTTP.
+      # @option http_options [String] :http_proxy A proxy to send
+      #   requests through.  Formatted like 'http://proxy.com:123'.
+      def initialize(http_options = {})
         @cached_pems = {}
+        @http_proxy = http_options[:http_proxy]
       end
 
       # @param [String<JSON>] message_body
@@ -149,7 +154,11 @@ module Aws
       end
 
       def https_get(uri, failed_attempts = 0)
-        http = Net::HTTP.new(uri.host, uri.port)
+        args = []
+        args << uri.host
+        args << uri.port
+        args += http_proxy_parts
+        http = Net::HTTP.new(*args.compact)
         http.use_ssl = true
         http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         http.start
@@ -166,6 +175,16 @@ module Aws
         raise VerificationError, error.message
       end
 
+      def http_proxy_parts
+        # empty string if not configured, URI parts return nil
+        http_proxy = URI.parse(@http_proxy.to_s)
+        [
+          http_proxy.host,
+          http_proxy.port,
+          (http_proxy.user && CGI.unescape(http_proxy.user)),
+          (http_proxy.password && CGI.unescape(http_proxy.password))
+        ]
+      end
     end
   end
 end

data/lib/aws-sdk-sns/platform_application.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
 
@@ -103,8 +105,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 options [String] :custom_user_data
     #   Arbitrary user data to associate with the endpoint. Amazon SNS does
     #   not use this data. The data must be in UTF-8 format and less than 2KB.
@@ -148,26 +150,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

data/lib/aws-sdk-sns/platform_endpoint.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
 
@@ -119,6 +121,8 @@ module Aws::SNS
     #         binary_value: "data",
     #       },
     #     },
+    #     message_deduplication_id: "String",
+    #     message_group_id: "String",
     #   })
     # @param [Hash] options ({})
     # @option options [String] :topic_arn
@@ -213,6 +217,31 @@ module Aws::SNS
     #   Valid value: `json`
     # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
     #   Message attributes for Publish action.
+    # @option options [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 options [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]
     def publish(options = {})
       options = options.merge(target_arn: @arn)

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

@@ -1,18 +1,25 @@
+# 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
 
 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.
+  # 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 ({})
@@ -44,7 +51,7 @@ 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 FCM
+    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
     #   (Firebase Cloud Messaging).
     # @option options [required, Hash<String,String>] :attributes
     #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
@@ -82,6 +89,9 @@ module Aws::SNS
     #   Constraints: Topic names must be made up of only uppercase and
     #   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 options [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
@@ -94,23 +104,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 options [Array<Types::Tag>] :tags
     #   The list of tags to add to a new topic.
     #

data/lib/aws-sdk-sns/subscription.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
 
@@ -46,7 +48,8 @@ module Aws::SNS
     #   and account system defaults.
     #
     # * `FilterPolicy` – The filter policy JSON that is assigned to the
-    #   subscription.
+    #   subscription. For more information, see [Amazon SNS Message
+    #   Filtering][1] in the *Amazon SNS Developer Guide*.
     #
     # * `Owner` – The AWS account ID of the subscription's owner.
     #
@@ -68,6 +71,26 @@ module Aws::SNS
     # * `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][2] in the
+    #   *Amazon SNS Developer Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html
+    # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
     # @return [Hash<String,String>]
     def attributes
       data[:attributes]
@@ -132,7 +155,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.
@@ -152,6 +175,25 @@ module Aws::SNS
     #     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][1] in the
+    #     *Amazon SNS Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
     # @option options [String] :attribute_value
     #   The new value for the attribute in JSON format.
     # @return [EmptyStructure]

data/lib/aws-sdk-sns/topic.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
 
@@ -57,7 +59,7 @@ module Aws::SNS
     #
     # * `TopicArn` – The topic's ARN.
     #
-    # * `EffectiveDeliveryPolicy` – Yhe JSON serialization of the effective
+    # * `EffectiveDeliveryPolicy` – The JSON serialization of the effective
     #   delivery policy, taking system defaults into account.
     #
     # The following attribute applies only to [server-side-encryption][1]\:
@@ -69,11 +71,33 @@ module Aws::SNS
     #
     # ^
     #
+    # 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
     # @return [Hash<String,String>]
     def attributes
       data[:attributes]
@@ -192,6 +216,8 @@ module Aws::SNS
     #         binary_value: "data",
     #       },
     #     },
+    #     message_deduplication_id: "String",
+    #     message_group_id: "String",
     #   })
     # @param [Hash] options ({})
     # @option options [String] :target_arn
@@ -284,6 +310,31 @@ module Aws::SNS
     #   Valid value: `json`
     # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
     #   Message attributes for Publish action.
+    # @option options [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 options [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]
     def publish(options = {})
       options = options.merge(topic_arn: @arn)
@@ -330,18 +381,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 options [String] :attribute_value
     #   The new value for the attribute.
     # @return [EmptyStructure]
@@ -363,7 +434,7 @@ module Aws::SNS
     #   })
     # @param [Hash] options ({})
     # @option options [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
     #
@@ -378,35 +449,41 @@ 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 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
-    #     `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 options [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
@@ -431,20 +508,37 @@ module Aws::SNS
     #     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][1] in the
+    #     *Amazon SNS Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
     # @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 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`.
     # @return [Subscription]