aws-sdk-sns 1.88.0 → 1.112.0

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

@@ -108,17 +108,9 @@ 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.
     #
-    #   * `SignatureVersion` – The signature version corresponds to the
-    #     hashing algorithm used while creating the signature of the
-    #     notifications, subscription confirmations, or unsubscribe
-    #     confirmation messages sent by Amazon SNS. By default,
-    #     `SignatureVersion` is set to `1`.
-    #
     #   * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
     #     `TracingConfig` is set to `PassThrough`, and the topic passes
     #     through the tracing header it receives from an Amazon SNS publisher
@@ -126,24 +118,107 @@ module Aws::SNS
     #     segment data to topic owner account if the sampled flag in the
     #     tracing header is true. This is only supported on standard topics.
     #
-    #   The following attribute applies only to [server-side encryption][1]:
+    #   * HTTP
+    #
+    #     * `HTTPSuccessFeedbackRoleArn` – Indicates successful message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       HTTP endpoint.
+    #
+    #     * `HTTPSuccessFeedbackSampleRate` – Indicates percentage of
+    #       successful messages to sample for an Amazon SNS topic that is
+    #       subscribed to an HTTP endpoint.
+    #
+    #     * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
+    #       status for an Amazon SNS topic that is subscribed to an HTTP
+    #       endpoint.
+    #   * Amazon Data Firehose
+    #
+    #     * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Amazon Data Firehose endpoint.
+    #
+    #     * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
+    #       successful messages to sample for an Amazon SNS topic that is
+    #       subscribed to an Amazon Data Firehose endpoint.
+    #
+    #     * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Amazon Data Firehose endpoint.
+    #   * Lambda
+    #
+    #     * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Lambda endpoint.
+    #
+    #     * `LambdaSuccessFeedbackSampleRate` – Indicates percentage of
+    #       successful messages to sample for an Amazon SNS topic that is
+    #       subscribed to an Lambda endpoint.
+    #
+    #     * `LambdaFailureFeedbackRoleArn` – Indicates failed message delivery
+    #       status for an Amazon SNS topic that is subscribed to an Lambda
+    #       endpoint.
+    #   * Platform application endpoint
+    #
+    #     * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
+    #       delivery status for an Amazon SNS topic that is subscribed to a
+    #       platform application endpoint.
+    #
+    #     * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
+    #       successful messages to sample for an Amazon SNS topic that is
+    #       subscribed to an platform application endpoint.
+    #
+    #     * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       platform application endpoint.
+    #     <note markdown="1"> In addition to being able to configure topic attributes for message
+    #     delivery status of notification messages sent to Amazon SNS
+    #     application endpoints, you can also configure application attributes
+    #     for the delivery status of push notification messages sent to push
+    #     notification services.
+    #
+    #      For example, For more information, see [Using Amazon SNS Application
+    #     Attributes for Message Delivery Status][1].
+    #
+    #      </note>
+    #
+    #   * Amazon SQS
+    #
+    #     * `SQSSuccessFeedbackRoleArn` – Indicates successful message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Amazon SQS endpoint.
+    #
+    #     * `SQSSuccessFeedbackSampleRate` – Indicates percentage of
+    #       successful messages to sample for an Amazon SNS topic that is
+    #       subscribed to an Amazon SQS endpoint.
+    #
+    #     * `SQSFailureFeedbackRoleArn` – Indicates failed message delivery
+    #       status for an Amazon SNS topic that is subscribed to an Amazon SQS
+    #       endpoint.
+    #
+    #   <note markdown="1"> The &lt;ENDPOINT&gt;SuccessFeedbackRoleArn and
+    #   &lt;ENDPOINT&gt;FailureFeedbackRoleArn attributes are used to give
+    #   Amazon SNS write access to use CloudWatch Logs on your behalf. The
+    #   &lt;ENDPOINT&gt;SuccessFeedbackSampleRate attribute is for specifying
+    #   the sample rate percentage (0-100) of successfully delivered messages.
+    #   After you configure the &lt;ENDPOINT&gt;FailureFeedbackRoleArn
+    #   attribute, then all failed message deliveries generate CloudWatch
+    #   Logs.
+    #
+    #    </note>
+    #
+    #   The following attribute applies only to [server-side encryption][2]:
     #
     #   * `KmsMasterKeyId` – The ID of an Amazon Web Services 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]
+    #     information, see [Key Terms][3]. For more examples, see [KeyId][4]
     #     in the *Key Management Service API Reference*.
     #
     #   ^
     #
-    #   The following attributes apply only to [FIFO topics][4]:
+    #   The following attributes apply only to [FIFO topics][5]:
     #
-    #   * `ArchivePolicy` – Adds or updates an inline policy document to
-    #     archive messages stored in the specified Amazon SNS topic.
-    #
-    #   * `BeginningArchiveTime` – The earliest starting point at which a
-    #     message in the topic’s archive can be replayed from. This point in
-    #     time is based on the configured message retention period set by the
-    #     topic’s message archiving policy.
+    #   * `ArchivePolicy` – The policy that sets the retention period for
+    #     messages stored in the message archive of an Amazon SNS FIFO topic.
     #
     #   * `ContentBasedDeduplication` – Enables content-based deduplication
     #     for FIFO topics.
@@ -151,7 +226,7 @@ module Aws::SNS
     #     * 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.
+    #       [Publish][6] action.
     #
     #     * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
     #       uses a SHA-256 hash to generate the `MessageDeduplicationId` using
@@ -160,14 +235,32 @@ module Aws::SNS
     #       (Optional) To override the generated value, you can specify a
     #       value for the `MessageDeduplicationId` parameter for the `Publish`
     #       action.
+    #   ^
+    #
+    #   * `FifoThroughputScope` – Enables higher throughput for your FIFO
+    #     topic by adjusting the scope of deduplication. This attribute has
+    #     two possible values:
+    #
+    #     * `Topic` – The scope of message deduplication is across the entire
+    #       topic. This is the default value and maintains existing behavior,
+    #       with a maximum throughput of 3000 messages per second or 20MB per
+    #       second, whichever comes first.
+    #
+    #     * `MessageGroup` – The scope of deduplication is within each
+    #       individual message group, which enables higher throughput per
+    #       topic subject to regional quotas. For more information on quotas
+    #       or to request an increase, see [Amazon SNS service quotas][7] in
+    #       the Amazon Web Services General Reference.
     #
     #
     #
-    #   [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
+    #   [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
+    #   [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
+    #   [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
+    #   [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
+    #   [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
+    #   [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
+    #   [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
     # @option options [Array<Types::Tag>] :tags
     #   The list of tags to add to a new topic.
     #

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

@@ -58,7 +58,6 @@ module Aws::SNS
     #     message attributes.
     #
     #   * `MessageBody` – The filter is applied on the message body.
-    #
     # * `Owner` – The Amazon Web Services account ID of the subscription's
     #   owner.
     #
@@ -90,7 +89,6 @@ module Aws::SNS
     #   * Permission to write to the Firehose delivery stream
     #
     #   * Amazon SNS listed as a trusted entity
-    #
     #   Specifying a valid ARN for this attribute is required for Firehose
     #   delivery stream subscriptions. For more information, see [Fanout to
     #   Firehose delivery streams][2] in the *Amazon SNS Developer Guide*.
@@ -183,7 +181,6 @@ module Aws::SNS
     #       message attributes.
     #
     #     * `MessageBody` – The filter is applied on the message body.
-    #
     #   * `RawMessageDelivery` – When set to `true`, enables raw message
     #     delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need
     #     for the endpoints to process JSON formatting, which is otherwise
@@ -205,7 +202,6 @@ module Aws::SNS
     #     * Permission to write to the Firehose delivery stream
     #
     #     * Amazon SNS listed as a trusted entity
-    #
     #     Specifying a valid ARN for this attribute is required for Firehose
     #     delivery stream subscriptions. For more information, see [Fanout to
     #     Firehose delivery streams][1] in the *Amazon SNS Developer Guide*.

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

@@ -67,7 +67,6 @@ module Aws::SNS
     #     value **1**.
     #
     #      </note>
-    #
     # * `SubscriptionsConfirmed` – The number of confirmed subscriptions for
     #   the topic.
     #
@@ -97,7 +96,13 @@ module Aws::SNS
     #
     # The following attributes apply only to [FIFO topics][4]:
     #
-    # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
+    # * `ArchivePolicy` – The policy that sets the retention period for
+    #   messages stored in the message archive of an Amazon SNS FIFO topic.
+    #
+    # * `BeginningArchiveTime` – The earliest starting point at which a
+    #   message in the topic’s archive can be replayed from. This point in
+    #   time is based on the configured message retention period set by the
+    #   topic’s message archiving policy.
     #
     # * `ContentBasedDeduplication` – Enables content-based deduplication
     #   for FIFO topics.
@@ -114,6 +119,7 @@ module Aws::SNS
     #     (Optional) To override the generated value, you can specify a
     #     value for the `MessageDeduplicationId` parameter for the `Publish`
     #     action.
+    # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
     #
     #
     #
@@ -343,30 +349,70 @@ module Aws::SNS
     # @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
+    #   * 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 within the 5 minute
+    #     minimum deduplication interval.
+    #
+    #   * The scope of deduplication depends on the `FifoThroughputScope`
+    #     attribute, when set to `Topic` the message deduplication scope is
+    #     across the entire topic, when set to `MessageGroup` the message
+    #     deduplication scope is within each individual message group.
+    #
+    #   * If a message with a particular `MessageDeduplicationId` is sent
+    #     successfully, subsequent messages within the deduplication scope and
+    #     interval, with the same `MessageDeduplicationId`, are accepted
+    #     successfully but aren't delivered.
+    #
+    #   * Every message must have a unique `MessageDeduplicationId`:
+    #
+    #     * You may provide a `MessageDeduplicationId` explicitly.
+    #
+    #     * If you aren't able to provide a `MessageDeduplicationId` and you
+    #       enable `ContentBasedDeduplication` for your topic, Amazon SNS uses
+    #       a SHA-256 hash to generate the `MessageDeduplicationId` using the
+    #       body of the message (but not the attributes of the message).
+    #
+    #     * If you don't provide a `MessageDeduplicationId` and the topic
+    #       doesn't have `ContentBasedDeduplication` set, the action fails
+    #       with an error.
+    #
+    #     * If the topic has a `ContentBasedDeduplication` set, your
+    #       `MessageDeduplicationId` overrides the generated one.
+    #   * When `ContentBasedDeduplication` is in effect, messages with
+    #     identical content sent within the deduplication scope and interval
+    #     are treated as duplicates and only one copy of the message is
+    #     delivered.
+    #
+    #   * If you send one message with `ContentBasedDeduplication` enabled,
+    #     and then another message with a `MessageDeduplicationId` that is the
+    #     same as the one generated for the first `MessageDeduplicationId`,
+    #     the two messages are treated as duplicates, within the deduplication
+    #     scope and interval, and only one copy of the message is delivered.
+    # @option options [String] :message_group_id
+    #   The `MessageGroupId` 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.
+    #   For FIFO topics: 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`.
     #
-    #   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`.
+    #   For standard topics: The `MessageGroupId` is optional and is forwarded
+    #   only to Amazon SQS standard subscriptions to activate [fair
+    #   queues][1]. The `MessageGroupId` is not used for, or sent to, any
+    #   other endpoint types. When provided, the same validation rules apply
+    #   as for FIFO topics.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fair-queues.html
     # @return [Types::PublishResponse]
     def publish(options = {})
       options = options.merge(topic_arn: @arn)
@@ -406,10 +452,6 @@ module Aws::SNS
     #   The following lists the names, descriptions, and values of the special
     #   request parameters that the `SetTopicAttributes` action uses:
     #
-    #   * `ApplicationSuccessFeedbackRoleArn` – Indicates failed message
-    #     delivery status for an Amazon SNS topic that is subscribed to a
-    #     platform application endpoint.
-    #
     #   * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
     #     failed deliveries to HTTP/S endpoints.
     #
@@ -439,21 +481,19 @@ module Aws::SNS
     #     * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
     #       status for an Amazon SNS topic that is subscribed to an HTTP
     #       endpoint.
-    #
-    #   * Amazon Kinesis Data Firehose
+    #   * Amazon Data Firehose
     #
     #     * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
     #       delivery status for an Amazon SNS topic that is subscribed to an
-    #       Amazon Kinesis Data Firehose endpoint.
+    #       Amazon Data Firehose endpoint.
     #
     #     * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
     #       successful messages to sample for an Amazon SNS topic that is
-    #       subscribed to an Amazon Kinesis Data Firehose endpoint.
+    #       subscribed to an Amazon Data Firehose endpoint.
     #
     #     * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
     #       delivery status for an Amazon SNS topic that is subscribed to an
-    #       Amazon Kinesis Data Firehose endpoint.
-    #
+    #       Amazon Data Firehose endpoint.
     #   * Lambda
     #
     #     * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
@@ -467,21 +507,19 @@ module Aws::SNS
     #     * `LambdaFailureFeedbackRoleArn` – Indicates failed message delivery
     #       status for an Amazon SNS topic that is subscribed to an Lambda
     #       endpoint.
-    #
     #   * Platform application endpoint
     #
     #     * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
     #       delivery status for an Amazon SNS topic that is subscribed to an
-    #       Amazon Web Services application endpoint.
+    #       platform application endpoint.
     #
     #     * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
     #       successful messages to sample for an Amazon SNS topic that is
-    #       subscribed to an Amazon Web Services application endpoint.
+    #       subscribed to an platform application endpoint.
     #
     #     * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
     #       delivery status for an Amazon SNS topic that is subscribed to an
-    #       Amazon Web Services application endpoint.
-    #
+    #       platform application endpoint.
     #     <note markdown="1"> In addition to being able to configure topic attributes for message
     #     delivery status of notification messages sent to Amazon SNS
     #     application endpoints, you can also configure application attributes
@@ -533,6 +571,9 @@ module Aws::SNS
     #
     #   The following attribute applies only to [FIFO topics][5]:
     #
+    #   * `ArchivePolicy` – The policy that sets the retention period for
+    #     messages stored in the message archive of an Amazon SNS FIFO topic.
+    #
     #   * `ContentBasedDeduplication` – Enables content-based deduplication
     #     for FIFO topics.
     #
@@ -548,6 +589,22 @@ module Aws::SNS
     #       (Optional) To override the generated value, you can specify a
     #       value for the `MessageDeduplicationId` parameter for the `Publish`
     #       action.
+    #   ^
+    #
+    #   * `FifoThroughputScope` – Enables higher throughput for your FIFO
+    #     topic by adjusting the scope of deduplication. This attribute has
+    #     two possible values:
+    #
+    #     * `Topic` – The scope of message deduplication is across the entire
+    #       topic. This is the default value and maintains existing behavior,
+    #       with a maximum throughput of 3000 messages per second or 20MB per
+    #       second, whichever comes first.
+    #
+    #     * `MessageGroup` – The scope of deduplication is within each
+    #       individual message group, which enables higher throughput per
+    #       topic subject to regional quotas. For more information on quotas
+    #       or to request an increase, see [Amazon SNS service quotas][7] in
+    #       the Amazon Web Services General Reference.
     #
     #
     #
@@ -557,6 +614,7 @@ module Aws::SNS
     #   [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
     #   [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
     #   [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
+    #   [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
     # @option options [String] :attribute_value
     #   The new value for the attribute.
     # @return [EmptyStructure]
@@ -599,8 +657,8 @@ module Aws::SNS
     #
     #   * `lambda` – delivery of JSON-encoded message to an Lambda function
     #
-    #   * `firehose` – delivery of JSON-encoded message to an Amazon Kinesis
-    #     Data Firehose delivery stream.
+    #   * `firehose` – delivery of JSON-encoded message to an Amazon Data
+    #     Firehose delivery stream.
     # @option options [String] :endpoint
     #   The endpoint that you want to receive notifications. Endpoints vary by
     #   protocol:
@@ -628,7 +686,7 @@ module Aws::SNS
     #     function.
     #
     #   * For the `firehose` protocol, the endpoint is the ARN of an Amazon
-    #     Kinesis Data Firehose delivery stream.
+    #     Data Firehose delivery stream.
     # @option options [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
@@ -649,7 +707,6 @@ module Aws::SNS
     #       message attributes.
     #
     #     * `MessageBody` – The filter is applied on the message body.
-    #
     #   * `RawMessageDelivery` – When set to `true`, enables raw message
     #     delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need
     #     for the endpoints to process JSON formatting, which is otherwise
@@ -671,7 +728,6 @@ module Aws::SNS
     #     * Permission to write to the Firehose delivery stream
     #
     #     * Amazon SNS listed as a trusted entity
-    #
     #     Specifying a valid ARN for this attribute is required for Firehose
     #     delivery stream subscriptions. For more information, see [Fanout to
     #     Firehose delivery streams][1] in the *Amazon SNS Developer Guide*.