aws-sdk-sns 1.34.0 → 1.39.0

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

@@ -3,7 +3,7 @@
 # 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
 
@@ -71,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]
@@ -366,25 +388,31 @@ module Aws::SNS
     #
     #   ^
     #
-    #   The following attribute applies only to FIFO topics:
+    #   The following attribute applies only to [FIFO topics][4]\:
     #
-    #   * `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).
+    #   * `ContentBasedDeduplication` – Enables content-based deduplication
+    #     for FIFO topics.
     #
-    #   * 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.
+    #     * 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.
     #
-    #   * If the queue has `ContentBasedDeduplication` set, your
-    #     `MessageDeduplicationId` overrides the generated one.
+    #     * 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]
@@ -406,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
     #
@@ -421,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 (public) endpoint is a URL beginning
-    #     with `http://`
+    #     with `http://`.
     #
     #   * For the `https` protocol, the (public) endpoint is a URL beginning
-    #     with `https://`
+    #     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.
     #
@@ -474,19 +508,35 @@ 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 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 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.
     #
     #
     #

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

@@ -3,7 +3,7 @@
 # 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
 
@@ -352,26 +352,34 @@ module Aws::SNS
     #
     #   ^
     #
-    #   The following attribute applies only to FIFO topics:
+    #   The following attributes apply only to [FIFO topics][4]\:
     #
-    #   * `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).
+    #   * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
     #
-    #   * 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.
+    #   * `ContentBasedDeduplication` – Enables content-based deduplication
+    #     for FIFO topics.
     #
-    #   * If the queue has `ContentBasedDeduplication` set, your
-    #     `MessageDeduplicationId` overrides the generated one.
+    #     * 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>]
     #
     # @!attribute [rw] tags
@@ -726,9 +734,25 @@ module Aws::SNS
     #   * `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>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse AWS API Documentation
@@ -801,11 +825,34 @@ 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>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributesResponse AWS API Documentation
@@ -1275,12 +1322,14 @@ module Aws::SNS
     # message body should not be empty or null. All parts of the message
     # attribute, including name, type, and value, are included in the
     # message size restriction, which is currently 256 KB (262,144 bytes).
-    # For more information, see [Using Amazon SNS Message Attributes][2].
+    # For more information, see [Amazon SNS message attributes][2] and
+    # [Publishing to a mobile phone][3] in the *Amazon SNS Developer Guide.*
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
     # [2]: https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
+    # [3]: https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html
     #
     # @note When making an API call, you may pass MessageAttributeValue
     #   data as a hash:
@@ -1883,8 +1932,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:
+    #   special request parameters that this action uses:
     #
     #   * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
     #     failed deliveries to HTTP/S endpoints.
@@ -1905,6 +1953,25 @@ module Aws::SNS
     #     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
     #   @return [String]
     #
     # @!attribute [rw] attribute_value
@@ -1963,26 +2030,32 @@ module Aws::SNS
     #
     #   ^
     #
-    #   The following attribute applies only to FIFO topics:
+    #   The following attribute applies only to [FIFO topics][4]\:
     #
-    #   * `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).
+    #   * `ContentBasedDeduplication` – Enables content-based deduplication
+    #     for FIFO topics.
     #
-    #   * 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.
+    #     * 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.
     #
-    #   * If the queue has `ContentBasedDeduplication` set, your
-    #     `MessageDeduplicationId` overrides the generated one.
+    #     * 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 [String]
     #
     # @!attribute [rw] attribute_value
@@ -2033,7 +2106,7 @@ module Aws::SNS
     #   @return [String]
     #
     # @!attribute [rw] 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
     #
@@ -2048,10 +2121,13 @@ 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 AWS Lambda
+    #     function
     #
-    #   * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
-    #     function.
+    #   * `firehose` – delivery of JSON-encoded message to an Amazon Kinesis
+    #     Data Firehose delivery stream.
     #   @return [String]
     #
     # @!attribute [rw] endpoint
@@ -2059,26 +2135,29 @@ module Aws::SNS
     #   by protocol:
     #
     #   * For the `http` protocol, the (public) endpoint is a URL beginning
-    #     with `http://`
+    #     with `http://`.
     #
     #   * For the `https` protocol, the (public) endpoint is a URL beginning
-    #     with `https://`
+    #     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
+    #   * 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.
     #   @return [String]
     #
     # @!attribute [rw] attributes
@@ -2107,21 +2186,38 @@ module Aws::SNS
     #     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
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] return_subscription_arn
     #   Sets whether the response from the `Subscribe` request includes the
     #   subscription ARN, even if the subscription is not yet confirmed.
     #
-    #   * If you set this parameter to `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 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.
     #
     #
     #