aws-sdk-sns 1.55.0 → 1.60.0

data/lib/aws-sdk-sns/plugins/endpoints.rb

@@ -0,0 +1,152 @@
+# 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/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::SNS
+  module Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: 'Aws::SNS::EndpointProvider',
+        docstring: 'The endpoint provider used to resolve endpoints. Any '\
+                   'object that responds to `#resolve_endpoint(parameters)` '\
+                   'where `parameters` is a Struct similar to '\
+                   '`Aws::SNS::EndpointParameters`'
+      ) do |cfg|
+        Aws::SNS::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          # If endpoint was discovered, do not resolve or apply the endpoint.
+          unless context[:discovered_endpoint]
+            params = parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+          end
+
+          context[:endpoint_params] = params
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            context.http_request.headers[key] = value
+          end
+        end
+
+        def parameters_for_operation(context)
+          case context.operation_name
+          when :add_permission
+            Aws::SNS::Endpoints::AddPermission.build(context)
+          when :check_if_phone_number_is_opted_out
+            Aws::SNS::Endpoints::CheckIfPhoneNumberIsOptedOut.build(context)
+          when :confirm_subscription
+            Aws::SNS::Endpoints::ConfirmSubscription.build(context)
+          when :create_platform_application
+            Aws::SNS::Endpoints::CreatePlatformApplication.build(context)
+          when :create_platform_endpoint
+            Aws::SNS::Endpoints::CreatePlatformEndpoint.build(context)
+          when :create_sms_sandbox_phone_number
+            Aws::SNS::Endpoints::CreateSMSSandboxPhoneNumber.build(context)
+          when :create_topic
+            Aws::SNS::Endpoints::CreateTopic.build(context)
+          when :delete_endpoint
+            Aws::SNS::Endpoints::DeleteEndpoint.build(context)
+          when :delete_platform_application
+            Aws::SNS::Endpoints::DeletePlatformApplication.build(context)
+          when :delete_sms_sandbox_phone_number
+            Aws::SNS::Endpoints::DeleteSMSSandboxPhoneNumber.build(context)
+          when :delete_topic
+            Aws::SNS::Endpoints::DeleteTopic.build(context)
+          when :get_data_protection_policy
+            Aws::SNS::Endpoints::GetDataProtectionPolicy.build(context)
+          when :get_endpoint_attributes
+            Aws::SNS::Endpoints::GetEndpointAttributes.build(context)
+          when :get_platform_application_attributes
+            Aws::SNS::Endpoints::GetPlatformApplicationAttributes.build(context)
+          when :get_sms_attributes
+            Aws::SNS::Endpoints::GetSMSAttributes.build(context)
+          when :get_sms_sandbox_account_status
+            Aws::SNS::Endpoints::GetSMSSandboxAccountStatus.build(context)
+          when :get_subscription_attributes
+            Aws::SNS::Endpoints::GetSubscriptionAttributes.build(context)
+          when :get_topic_attributes
+            Aws::SNS::Endpoints::GetTopicAttributes.build(context)
+          when :list_endpoints_by_platform_application
+            Aws::SNS::Endpoints::ListEndpointsByPlatformApplication.build(context)
+          when :list_origination_numbers
+            Aws::SNS::Endpoints::ListOriginationNumbers.build(context)
+          when :list_phone_numbers_opted_out
+            Aws::SNS::Endpoints::ListPhoneNumbersOptedOut.build(context)
+          when :list_platform_applications
+            Aws::SNS::Endpoints::ListPlatformApplications.build(context)
+          when :list_sms_sandbox_phone_numbers
+            Aws::SNS::Endpoints::ListSMSSandboxPhoneNumbers.build(context)
+          when :list_subscriptions
+            Aws::SNS::Endpoints::ListSubscriptions.build(context)
+          when :list_subscriptions_by_topic
+            Aws::SNS::Endpoints::ListSubscriptionsByTopic.build(context)
+          when :list_tags_for_resource
+            Aws::SNS::Endpoints::ListTagsForResource.build(context)
+          when :list_topics
+            Aws::SNS::Endpoints::ListTopics.build(context)
+          when :opt_in_phone_number
+            Aws::SNS::Endpoints::OptInPhoneNumber.build(context)
+          when :publish
+            Aws::SNS::Endpoints::Publish.build(context)
+          when :publish_batch
+            Aws::SNS::Endpoints::PublishBatch.build(context)
+          when :put_data_protection_policy
+            Aws::SNS::Endpoints::PutDataProtectionPolicy.build(context)
+          when :remove_permission
+            Aws::SNS::Endpoints::RemovePermission.build(context)
+          when :set_endpoint_attributes
+            Aws::SNS::Endpoints::SetEndpointAttributes.build(context)
+          when :set_platform_application_attributes
+            Aws::SNS::Endpoints::SetPlatformApplicationAttributes.build(context)
+          when :set_sms_attributes
+            Aws::SNS::Endpoints::SetSMSAttributes.build(context)
+          when :set_subscription_attributes
+            Aws::SNS::Endpoints::SetSubscriptionAttributes.build(context)
+          when :set_topic_attributes
+            Aws::SNS::Endpoints::SetTopicAttributes.build(context)
+          when :subscribe
+            Aws::SNS::Endpoints::Subscribe.build(context)
+          when :tag_resource
+            Aws::SNS::Endpoints::TagResource.build(context)
+          when :unsubscribe
+            Aws::SNS::Endpoints::Unsubscribe.build(context)
+          when :untag_resource
+            Aws::SNS::Endpoints::UntagResource.build(context)
+          when :verify_sms_sandbox_phone_number
+            Aws::SNS::Endpoints::VerifySMSSandboxPhoneNumber.build(context)
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end

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

@@ -110,6 +110,19 @@ module Aws::SNS
     #   * `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
+    #     to its subscriptions. If set to `Active`, Amazon SNS will vend X-Ray
+    #     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]\:
     #
     #   * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer

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

@@ -51,6 +51,14 @@ module Aws::SNS
     #   subscription. For more information, see [Amazon SNS Message
     #   Filtering][1] in the *Amazon SNS Developer Guide*.
     #
+    # * `FilterPolicyScope` – This attribute lets you choose the filtering
+    #   scope by using one of the following string value types:
+    #
+    #   * `MessageAttributes` (default) – The filter is applied on the
+    #     message attributes.
+    #
+    #   * `MessageBody` – The filter is applied on the message body.
+    #
     # * `Owner` – The Amazon Web Services account ID of the subscription's
     #   owner.
     #
@@ -165,6 +173,14 @@ module Aws::SNS
     #     receive only a subset of messages, rather than receiving every
     #     message published to the topic.
     #
+    #   * `FilterPolicyScope` – This attribute lets you choose the filtering
+    #     scope by using one of the following string value types:
+    #
+    #     * `MessageAttributes` (default) – The filter is applied on the
+    #       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

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

@@ -43,11 +43,31 @@ module Aws::SNS
     # * `DisplayName` – The human-readable name used in the `From` field for
     #   notifications to `email` and `email-json` endpoints.
     #
+    # * `EffectiveDeliveryPolicy` – The JSON serialization of the effective
+    #   delivery policy, taking system defaults into account.
+    #
     # * `Owner` – The Amazon Web Services account ID of the topic's owner.
     #
     # * `Policy` – The JSON serialization of the topic's access control
     #   policy.
     #
+    # * `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**. The signature is a
+    #     Base64-encoded **SHA1withRSA** signature.
+    #
+    #   * When you set `SignatureVersion` to **2**. Amazon SNS uses a
+    #     Base64-encoded **SHA256withRSA** signature.
+    #
+    #     <note markdown="1"> If the API response does not include the `SignatureVersion`
+    #     attribute, it means that the `SignatureVersion` for the topic has
+    #     value **1**.
+    #
+    #      </note>
+    #
     # * `SubscriptionsConfirmed` – The number of confirmed subscriptions for
     #   the topic.
     #
@@ -59,8 +79,12 @@ module Aws::SNS
     #
     # * `TopicArn` – The topic's ARN.
     #
-    # * `EffectiveDeliveryPolicy` – The JSON serialization of the effective
-    #   delivery policy, taking system defaults into account.
+    # * `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
+    #   to its subscriptions. If set to `Active`, Amazon SNS will vend X-Ray
+    #   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]\:
     #
@@ -371,6 +395,10 @@ 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.
     #
@@ -380,16 +408,119 @@ module Aws::SNS
     #   * `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]\:
+    #   * `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
+    #     to its subscriptions. If set to `Active`, Amazon SNS will vend X-Ray
+    #     segment data to topic owner account if the sampled flag in the
+    #     tracing header is true. This is only supported on standard topics.
+    #
+    #   * 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 Kinesis Data Firehose
+    #
+    #     * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Amazon Kinesis 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.
+    #
+    #     * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Amazon Kinesis 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 an
+    #       Amazon Web Services 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.
+    #
+    #     * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
+    #       delivery status for an Amazon SNS topic that is subscribed to an
+    #       Amazon Web Services 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*.
     #
-    #   ^
+    #   * `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`.
     #
-    #   The following attribute applies only to [FIFO topics][4]\:
+    #   The following attribute applies only to [FIFO topics][5]\:
     #
     #   * `ContentBasedDeduplication` – Enables content-based deduplication
     #     for FIFO topics.
@@ -397,7 +528,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
@@ -409,11 +540,12 @@ module Aws::SNS
     #
     #
     #
-    #   [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
     # @option options [String] :attribute_value
     #   The new value for the attribute.
     # @return [EmptyStructure]
@@ -497,6 +629,14 @@ module Aws::SNS
     #     receive only a subset of messages, rather than receiving every
     #     message published to the topic.
     #
+    #   * `FilterPolicyScope` – This attribute lets you choose the filtering
+    #     scope by using one of the following string value types:
+    #
+    #     * `MessageAttributes` (default) – The filter is applied on the
+    #       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