aws-sdk-sns 1.42.0 → 1.77.0

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

@@ -28,13 +28,18 @@ module Aws::SNS
   #
   # ## Error Classes
   # * {AuthorizationErrorException}
+  # * {BatchEntryIdsNotDistinctException}
+  # * {BatchRequestTooLongException}
   # * {ConcurrentAccessException}
+  # * {EmptyBatchRequestException}
   # * {EndpointDisabledException}
   # * {FilterPolicyLimitExceededException}
   # * {InternalErrorException}
+  # * {InvalidBatchEntryIdException}
   # * {InvalidParameterException}
   # * {InvalidParameterValueException}
   # * {InvalidSecurityException}
+  # * {InvalidStateException}
   # * {KMSAccessDeniedException}
   # * {KMSDisabledException}
   # * {KMSInvalidStateException}
@@ -44,12 +49,14 @@ module Aws::SNS
   # * {NotFoundException}
   # * {OptedOutException}
   # * {PlatformApplicationDisabledException}
+  # * {ReplayLimitExceededException}
   # * {ResourceNotFoundException}
   # * {StaleTagException}
   # * {SubscriptionLimitExceededException}
   # * {TagLimitExceededException}
   # * {TagPolicyException}
   # * {ThrottledException}
+  # * {TooManyEntriesInBatchRequestException}
   # * {TopicLimitExceededException}
   # * {UserErrorException}
   # * {ValidationException}
@@ -76,6 +83,36 @@ module Aws::SNS
       end
     end
 
+    class BatchEntryIdsNotDistinctException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::BatchEntryIdsNotDistinctException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class BatchRequestTooLongException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::BatchRequestTooLongException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class ConcurrentAccessException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -91,6 +128,21 @@ module Aws::SNS
       end
     end
 
+    class EmptyBatchRequestException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::EmptyBatchRequestException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class EndpointDisabledException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -136,6 +188,21 @@ module Aws::SNS
       end
     end
 
+    class InvalidBatchEntryIdException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::InvalidBatchEntryIdException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class InvalidParameterException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -181,6 +248,21 @@ module Aws::SNS
       end
     end
 
+    class InvalidStateException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::InvalidStateException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class KMSAccessDeniedException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -316,6 +398,21 @@ module Aws::SNS
       end
     end
 
+    class ReplayLimitExceededException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::ReplayLimitExceededException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class ResourceNotFoundException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -406,6 +503,21 @@ module Aws::SNS
       end
     end
 
+    class TooManyEntriesInBatchRequestException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SNS::Types::TooManyEntriesInBatchRequestException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class TopicLimitExceededException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

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

@@ -65,11 +65,15 @@ module Aws
       def authenticate!(message_body)
         msg = Json.load(message_body)
         msg = convert_lambda_msg(msg) if is_from_lambda(msg)
-        if public_key(msg).verify(sha1, signature(msg), canonical_string(msg))
-          true
+
+        case msg['SignatureVersion']
+        when '1'
+          verify!(msg, sha1)
+        when '2'
+          verify!(msg, sha256)
         else
-          msg = 'the authenticity of the message cannot be verified'
-          raise VerificationError, msg
+          error_msg = 'Invalid SignatureVersion'
+          raise VerificationError, error_msg
         end
       end
 
@@ -88,10 +92,23 @@ module Aws
         message
       end
 
+      def verify!(msg, hash_alg)
+        if public_key(msg).verify(hash_alg, signature(msg), canonical_string(msg))
+          true
+        else
+          msg = 'the authenticity of the message cannot be verified'
+          raise VerificationError, msg
+        end
+      end
+
       def sha1
         OpenSSL::Digest::SHA1.new
       end
 
+      def sha256
+        OpenSSL::Digest::SHA256.new
+      end
+
       def signature(message)
         Base64.decode64(message['Signature'])
       end
@@ -123,7 +140,9 @@ module Aws
 
       def download_pem(uri)
         verify_uri!(uri)
-        https_get(uri)
+        pem = https_get(uri)
+        verify_pem_format!(pem)
+        pem
       end
 
       def verify_uri!(uri)
@@ -153,6 +172,14 @@ module Aws
         end
       end
 
+      def verify_pem_format!(pem)
+        cert_regex = /\A[\s]*-----BEGIN [A-Z]+-----\n[A-Za-z\d+\/\n]+[=]{0,2}\n-----END [A-Z]+-----[\s]*\Z/
+        unless pem =~ cert_regex
+          msg = 'The certificate does not match expected X509 PEM format.'
+          raise VerificationError, msg
+        end
+      end
+
       def https_get(uri, failed_attempts = 0)
         args = []
         args << uri.host

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

@@ -36,6 +36,23 @@ module Aws::SNS
 
     # Attributes include the following:
     #
+    # * `AppleCertificateExpiryDate` – The expiry date of the SSL
+    #   certificate used to configure certificate-based authentication.
+    #
+    # * `ApplePlatformTeamID` – The Apple developer account ID used to
+    #   configure token-based authentication.
+    #
+    # * `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.
     #
@@ -67,7 +84,9 @@ module Aws::SNS
     #
     # @return [self]
     def load
-      resp = @client.get_platform_application_attributes(platform_application_arn: @arn)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.get_platform_application_attributes(platform_application_arn: @arn)
+      end
       @data = resp.data
       self
     end
@@ -111,7 +130,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].
     #
     #
     #
@@ -119,7 +138,9 @@ module Aws::SNS
     # @return [PlatformEndpoint]
     def create_platform_endpoint(options = {})
       options = options.merge(platform_application_arn: @arn)
-      resp = @client.create_platform_endpoint(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.create_platform_endpoint(options)
+      end
       PlatformEndpoint.new(
         arn: resp.data.endpoint_arn,
         client: @client
@@ -133,7 +154,9 @@ module Aws::SNS
     # @return [EmptyStructure]
     def delete(options = {})
       options = options.merge(platform_application_arn: @arn)
-      resp = @client.delete_platform_application(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.delete_platform_application(options)
+      end
       resp.data
     end
 
@@ -150,15 +173,42 @@ module Aws::SNS
     #   include the following:
     #
     #   * `PlatformCredential` – The credential received from the notification
-    #     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`.
+    #     service.
+    #
+    #     * For ADM, `PlatformCredential`is client secret.
+    #
+    #     * For Apple Services using certificate credentials,
+    #       `PlatformCredential` is private key.
+    #
+    #     * For Apple Services using token credentials, `PlatformCredential`
+    #       is signing 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
-    #     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`.
+    #     service.
+    #
+    #     * For ADM, `PlatformPrincipal`is client id.
+    #
+    #     * For Apple Services using certificate credentials,
+    #       `PlatformPrincipal` is SSL certificate.
+    #
+    #     * For Apple Services using token credentials, `PlatformPrincipal` is
+    #       signing key ID.
+    #
+    #     * For GCM (Firebase Cloud Messaging), there is no
+    #       `PlatformPrincipal`.
+    #   ^
     #
     #   * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
     #     notifications are sent.
@@ -181,10 +231,21 @@ module Aws::SNS
     #
     #   * `SuccessFeedbackSampleRate` – Sample rate percentage (0-100) of
     #     successfully delivered messages.
+    #
+    #   The following attributes only apply to `APNs` token-based
+    #   authentication:
+    #
+    #   * `ApplePlatformTeamID` – The identifier that's assigned to your
+    #     Apple developer account team.
+    #
+    #   * `ApplePlatformBundleID` – The bundle identifier that's assigned to
+    #     your iOS app.
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(platform_application_arn: @arn)
-      resp = @client.set_platform_application_attributes(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.set_platform_application_attributes(options)
+      end
       resp.data
     end
 
@@ -198,7 +259,9 @@ module Aws::SNS
     def endpoints(options = {})
       batches = Enumerator.new do |y|
         options = options.merge(platform_application_arn: @arn)
-        resp = @client.list_endpoints_by_platform_application(options)
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+          @client.list_endpoints_by_platform_application(options)
+        end
         resp.each_page do |page|
           batch = []
           page.data.endpoints.each do |e|

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

@@ -72,7 +72,9 @@ module Aws::SNS
     #
     # @return [self]
     def load
-      resp = @client.get_endpoint_attributes(endpoint_arn: @arn)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.get_endpoint_attributes(endpoint_arn: @arn)
+      end
       @data = resp.data
       self
     end
@@ -102,7 +104,9 @@ module Aws::SNS
     # @return [EmptyStructure]
     def delete(options = {})
       options = options.merge(endpoint_arn: @arn)
-      resp = @client.delete_endpoint(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.delete_endpoint(options)
+      end
       resp.data
     end
 
@@ -110,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",
@@ -196,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
@@ -220,7 +223,7 @@ module Aws::SNS
     # @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 ``
+    #   `(a-z, A-Z, 0-9)` and punctuation ``
     #   (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
     #
     #   Every message must have a unique `MessageDeduplicationId`, which is a
@@ -234,8 +237,8 @@ module Aws::SNS
     #   `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 `` (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
+    #   `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
@@ -245,7 +248,9 @@ module Aws::SNS
     # @return [Types::PublishResponse]
     def publish(options = {})
       options = options.merge(target_arn: @arn)
-      resp = @client.publish(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.publish(options)
+      end
       resp.data
     end
 
@@ -277,7 +282,9 @@ module Aws::SNS
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(endpoint_arn: @arn)
-      resp = @client.set_endpoint_attributes(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.set_endpoint_attributes(options)
+      end
       resp.data
     end
 

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

@@ -0,0 +1,154 @@
+# 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',
+        rbs_type: 'untyped',
+        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)
+          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)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
+          end
+
+          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