aws-sdk-sns 1.67.0 → 1.92.0

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

@@ -45,6 +45,13 @@ module Aws::SNS
     # * `ApplePlatformBundleID` – The app identifier used to configure
     #   token-based authentication.
     #
+    # * `AuthenticationMethod` – Returns the credential type used when
+    #   sending push notifications from application to APNS/APNS\_Sandbox,
+    #   or application to GCM.
+    #
+    #   * APNS – Returns the token or certificate.
+    #
+    #   * GCM – Returns the token or key.
     # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
     #   notifications should be sent.
     #
@@ -76,7 +83,7 @@ module Aws::SNS
     #
     # @return [self]
     def load
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.get_platform_application_attributes(platform_application_arn: @arn)
       end
       @data = resp.data
@@ -122,7 +129,7 @@ module Aws::SNS
     #   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.
     # @option options [Hash<String,String>] :attributes
-    #   For a list of attributes, see [SetEndpointAttributes][1].
+    #   For a list of attributes, see [ `SetEndpointAttributes` ][1].
     #
     #
     #
@@ -130,7 +137,7 @@ module Aws::SNS
     # @return [PlatformEndpoint]
     def create_platform_endpoint(options = {})
       options = options.merge(platform_application_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.create_platform_endpoint(options)
       end
       PlatformEndpoint.new(
@@ -146,7 +153,7 @@ module Aws::SNS
     # @return [EmptyStructure]
     def delete(options = {})
       options = options.merge(platform_application_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.delete_platform_application(options)
       end
       resp.data
@@ -175,8 +182,16 @@ module Aws::SNS
     #     * For Apple Services using token credentials, `PlatformCredential`
     #       is signing key.
     #
-    #     * For GCM (Firebase Cloud Messaging), `PlatformCredential` is API
-    #       key.
+    #     * For GCM (Firebase Cloud Messaging) using key credentials, there is
+    #       no `PlatformPrincipal`. The `PlatformCredential` is `API key`.
+    #
+    #     * For GCM (Firebase Cloud Messaging) using token credentials, there
+    #       is no `PlatformPrincipal`. The `PlatformCredential` is a JSON
+    #       formatted private key file. When using the Amazon Web Services
+    #       CLI, the file must be in string format and special characters must
+    #       be ignored. To format the file correctly, Amazon SNS recommends
+    #       using the following command: `` SERVICE_JSON=`jq @json <<< cat
+    #       service.json` ``.
     #   ^
     #
     #   * `PlatformPrincipal` – The principal received from the notification
@@ -227,7 +242,7 @@ module Aws::SNS
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(platform_application_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.set_platform_application_attributes(options)
       end
       resp.data
@@ -243,7 +258,7 @@ module Aws::SNS
     def endpoints(options = {})
       batches = Enumerator.new do |y|
         options = options.merge(platform_application_arn: @arn)
-        resp = Aws::Plugins::UserAgent.feature('resource') do
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
           @client.list_endpoints_by_platform_application(options)
         end
         resp.each_page do |page|

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

@@ -72,7 +72,7 @@ module Aws::SNS
     #
     # @return [self]
     def load
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.get_endpoint_attributes(endpoint_arn: @arn)
       end
       @data = resp.data
@@ -104,7 +104,7 @@ module Aws::SNS
     # @return [EmptyStructure]
     def delete(options = {})
       options = options.merge(endpoint_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.delete_endpoint(options)
       end
       resp.data
@@ -114,7 +114,7 @@ module Aws::SNS
     #
     #   platform_endpoint.publish({
     #     topic_arn: "topicARN",
-    #     phone_number: "String",
+    #     phone_number: "PhoneNumber",
     #     message: "message", # required
     #     subject: "subject",
     #     message_structure: "messageStructure",
@@ -200,9 +200,8 @@ module Aws::SNS
     #   is delivered to email endpoints. This field will also be included, if
     #   present, in the standard JSON messages delivered to other endpoints.
     #
-    #   Constraints: Subjects must be ASCII text that begins with a letter,
-    #   number, or punctuation mark; must not include line breaks or control
-    #   characters; and must be less than 100 characters long.
+    #   Constraints: Subjects must be UTF-8 text with no line breaks or
+    #   control characters, and less than 100 characters long.
     # @option options [String] :message_structure
     #   Set `MessageStructure` to `json` if you want to send a different
     #   message for each protocol. For example, using one publish action, you
@@ -225,7 +224,7 @@ module Aws::SNS
     #   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
@@ -239,7 +238,7 @@ module Aws::SNS
     # @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 `` (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
+    #   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
@@ -249,7 +248,7 @@ module Aws::SNS
     # @return [Types::PublishResponse]
     def publish(options = {})
       options = options.merge(target_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.publish(options)
       end
       resp.data
@@ -283,7 +282,7 @@ module Aws::SNS
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(endpoint_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.set_endpoint_attributes(options)
       end
       resp.data

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

@@ -14,35 +14,49 @@ module Aws::SNS
       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|
+        rbs_type: 'untyped',
+        docstring: <<~DOCS) do |_cfg|
+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`.
+        DOCS
         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)
+            params = Aws::SNS::Endpoints.parameters_for_operation(context)
             endpoint = context.config.endpoint_provider.resolve_endpoint(params)
 
             context.http_request.endpoint = endpoint.url
             apply_endpoint_headers(context, endpoint.headers)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
           end
 
-          context[:endpoint_params] = params
           context[:auth_scheme] =
             Aws::Endpoints.resolve_auth_scheme(context, endpoint)
 
-          @handler.call(context)
+          with_metrics(context) { @handler.call(context) }
         end
 
         private
 
+        def with_metrics(context, &block)
+          metrics = []
+          metrics << 'ENDPOINT_OVERRIDE' unless context.config.regional_endpoint
+          if context[:auth_scheme] && context[:auth_scheme]['name'] == 'sigv4a'
+            metrics << 'SIGV4A_SIGNING'
+          end
+          if context.config.credentials&.credentials&.account_id
+            metrics << 'RESOLVED_ACCOUNT_ID'
+          end
+          Aws::Plugins::UserAgent.metric(*metrics, &block)
+        end
+
         def apply_endpoint_headers(context, headers)
           headers.each do |key, values|
             value = values
@@ -53,95 +67,6 @@ module Aws::SNS
             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)

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

@@ -54,14 +54,15 @@ module Aws::SNS
     #   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].
+    #   For a list of attributes, see [ `SetPlatformApplicationAttributes`
+    #   ][1].
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
     # @return [PlatformApplication]
     def create_platform_application(options = {})
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.create_platform_application(options)
       end
       PlatformApplication.new(
@@ -98,7 +99,7 @@ module Aws::SNS
     # @option options [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
-    #   The following lists the names, descriptions, and values of the special
+    #   The following lists names, descriptions, and values of the special
     #   request parameters that the `CreateTopic` action uses:
     #
     #   * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
@@ -136,7 +137,8 @@ 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.
     #
     #   * `ContentBasedDeduplication` – Enables content-based deduplication
     #     for FIFO topics.
@@ -178,7 +180,7 @@ module Aws::SNS
     #   Length Constraints: Maximum length of 30,720.
     # @return [Topic]
     def create_topic(options = {})
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.create_topic(options)
       end
       Topic.new(
@@ -205,7 +207,7 @@ module Aws::SNS
     # @return [PlatformApplication::Collection]
     def platform_applications(options = {})
       batches = Enumerator.new do |y|
-        resp = Aws::Plugins::UserAgent.feature('resource') do
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
           @client.list_platform_applications(options)
         end
         resp.each_page do |page|
@@ -247,7 +249,7 @@ module Aws::SNS
     # @return [Subscription::Collection]
     def subscriptions(options = {})
       batches = Enumerator.new do |y|
-        resp = Aws::Plugins::UserAgent.feature('resource') do
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
           @client.list_subscriptions(options)
         end
         resp.each_page do |page|
@@ -280,7 +282,7 @@ module Aws::SNS
     # @return [Topic::Collection]
     def topics(options = {})
       batches = Enumerator.new do |y|
-        resp = Aws::Plugins::UserAgent.feature('resource') do
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
           @client.list_topics(options)
         end
         resp.each_page do |page|

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.
     #
@@ -81,20 +80,18 @@ 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:
+    # The following attribute applies only to Amazon 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
+    #   * 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 Kinesis
-    #   Data Firehose delivery stream subscriptions. For more information,
-    #   see [Fanout to Kinesis Data Firehose delivery streams][2] in the
-    #   *Amazon SNS Developer Guide*.
+    #   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*.
     #
     #
     #
@@ -119,7 +116,7 @@ module Aws::SNS
     #
     # @return [self]
     def load
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.get_subscription_attributes(subscription_arn: @arn)
       end
       @data = resp.data
@@ -151,7 +148,7 @@ module Aws::SNS
     # @return [EmptyStructure]
     def delete(options = {})
       options = options.merge(subscription_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.unsubscribe(options)
       end
       resp.data
@@ -184,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
@@ -197,20 +193,18 @@ module Aws::SNS
     #     service that powers the subscribed endpoint becomes unavailable) are
     #     held in the dead-letter queue for further analysis or reprocessing.
     #
-    #   The following attribute applies only to Amazon Kinesis Data Firehose
-    #   delivery stream subscriptions:
+    #   The following attribute applies only to Amazon 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
+    #     * 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 Kinesis
-    #     Data Firehose delivery stream subscriptions. For more information,
-    #     see [Fanout to Kinesis Data Firehose delivery streams][1] in the
-    #     *Amazon SNS Developer Guide*.
+    #     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*.
     #
     #
     #
@@ -220,7 +214,7 @@ module Aws::SNS
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(subscription_arn: @arn)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.set_subscription_attributes(options)
       end
       resp.data