aws-sdk-sqs 1.64.0 → 1.73.0

data/lib/aws-sdk-sqs/endpoint_provider.rb

@@ -32,8 +32,8 @@ module Aws::SQS
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
-              if Aws::Endpoints::Matchers.string_equals?("aws-us-gov", Aws::Endpoints::Matchers.attr(partition_result, "name"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
+              if Aws::Endpoints::Matchers.string_equals?(Aws::Endpoints::Matchers.attr(partition_result, "name"), "aws-us-gov")
                 return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{region}.amazonaws.com", headers: {}, properties: {})
               end
               return Aws::Endpoints::Endpoint.new(url: "https://sqs-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})

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

@@ -30,10 +30,20 @@ module Aws::SQS
   # * {BatchEntryIdsNotDistinct}
   # * {BatchRequestTooLong}
   # * {EmptyBatchRequest}
+  # * {InvalidAddress}
   # * {InvalidAttributeName}
+  # * {InvalidAttributeValue}
   # * {InvalidBatchEntryId}
   # * {InvalidIdFormat}
   # * {InvalidMessageContents}
+  # * {InvalidSecurity}
+  # * {KmsAccessDenied}
+  # * {KmsDisabled}
+  # * {KmsInvalidKeyUsage}
+  # * {KmsInvalidState}
+  # * {KmsNotFound}
+  # * {KmsOptInRequired}
+  # * {KmsThrottled}
   # * {MessageNotInflight}
   # * {OverLimit}
   # * {PurgeQueueInProgress}
@@ -41,6 +51,7 @@ module Aws::SQS
   # * {QueueDoesNotExist}
   # * {QueueNameExists}
   # * {ReceiptHandleIsInvalid}
+  # * {RequestThrottled}
   # * {ResourceNotFoundException}
   # * {TooManyEntriesInBatchRequest}
   # * {UnsupportedOperation}
@@ -59,6 +70,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class BatchRequestTooLong < ServiceError
@@ -69,6 +85,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class EmptyBatchRequest < ServiceError
@@ -79,6 +100,26 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class InvalidAddress < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidAddress] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class InvalidAttributeName < ServiceError
@@ -89,6 +130,26 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class InvalidAttributeValue < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidAttributeValue] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class InvalidBatchEntryId < ServiceError
@@ -99,6 +160,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class InvalidIdFormat < ServiceError
@@ -119,6 +185,131 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class InvalidSecurity < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidSecurity] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsAccessDenied < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsAccessDenied] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsDisabled < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsDisabled] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsInvalidKeyUsage < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsInvalidKeyUsage] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsInvalidState < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsInvalidState] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsNotFound < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsNotFound] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsOptInRequired < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsOptInRequired] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KmsThrottled < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::KmsThrottled] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class MessageNotInflight < ServiceError
@@ -139,6 +330,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class PurgeQueueInProgress < ServiceError
@@ -149,6 +345,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class QueueDeletedRecently < ServiceError
@@ -159,6 +360,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class QueueDoesNotExist < ServiceError
@@ -169,6 +375,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class QueueNameExists < ServiceError
@@ -179,6 +390,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class ReceiptHandleIsInvalid < ServiceError
@@ -189,6 +405,26 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class RequestThrottled < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::RequestThrottled] 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
@@ -199,6 +435,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class TooManyEntriesInBatchRequest < ServiceError
@@ -209,6 +450,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class UnsupportedOperation < ServiceError
@@ -219,6 +465,11 @@ module Aws::SQS
       def initialize(context, message, data = Aws::EmptyStructure.new)
         super(context, message, data)
       end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
   end

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

@@ -14,6 +14,7 @@ module Aws::SQS
       option(
         :endpoint_provider,
         doc_type: 'Aws::SQS::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 '\
@@ -25,16 +26,17 @@ module Aws::SQS
       # @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)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
           end
 
-          context[:endpoint_params] = params
           context[:auth_scheme] =
             Aws::Endpoints.resolve_auth_scheme(context, endpoint)
 

data/lib/aws-sdk-sqs/plugins/md5s.rb

@@ -6,7 +6,6 @@ module Aws
   module SQS
     module Plugins
       class Md5s < Seahorse::Client::Plugin
-
         # @api private
         class Handler < Seahorse::Client::Handler
           def call(context)
@@ -26,16 +25,17 @@ module Aws
             'String' => 1,
             'Binary' => 2,
             'Number' => 1
-          }
+          }.freeze
 
-          DATA_TYPE = /\A(String|Binary|Number)(\..+)?\z/
+          DATA_TYPE = /\A(String|Binary|Number)(\..+)?\z/.freeze
 
           NORMALIZED_ENCODING = Encoding::UTF_8
 
           def validate_send_message(context, response)
             body = context.params[:message_body]
             attributes = context.params[:message_attributes]
-            validate_single_message(body, attributes, response)
+            system_attributes = context.params[:message_system_attributes]
+            validate_single_message(body, attributes, system_attributes, response)
           end
 
           def validate_send_message_batch(context, response)
@@ -43,63 +43,87 @@ module Aws
               id = entry[:id]
               body = entry[:message_body]
               attributes = entry[:message_attributes]
+              system_attributes = entry[:message_system_attributes]
               message_response = response.successful.select { |r| r.id == id }[0]
               unless message_response.nil?
-                validate_single_message(body, attributes, message_response)
+                validate_single_message(body, attributes, system_attributes, message_response)
               end
             end
           end
 
-          def validate_single_message(body, attributes, response)
+          def validate_single_message(body, attributes, system_attributes, response)
             validate_body(body, response)
             unless attributes.nil? || attributes.empty?
               validate_attributes(attributes, response)
             end
+            unless system_attributes.nil? || system_attributes.empty?
+              validate_system_attributes(system_attributes, response)
+            end
           end
 
           def validate_body(body, response)
             calculated_md5 = md5_of_message_body(body)
             returned_md5 = response.md5_of_message_body
-            if calculated_md5 != returned_md5
-              error_message =  mismatch_error_message(
-                'message body',
-                calculated_md5,
-                returned_md5,
-                response)
-              raise Aws::Errors::ChecksumError, error_message
-            end
+            return unless calculated_md5 != returned_md5
+
+            error_message = mismatch_error_message(
+              'message body',
+              calculated_md5,
+              returned_md5,
+              response
+            )
+            raise Aws::Errors::ChecksumError, error_message
           end
 
           def validate_attributes(attributes, response)
             calculated_md5 = md5_of_message_attributes(attributes)
             returned_md5 = response.md5_of_message_attributes
-            if returned_md5 != calculated_md5
-              error_message =  mismatch_error_message(
-                'message attributes',
-                calculated_md5,
-                returned_md5,
-                response)
-              raise Aws::Errors::ChecksumError, error_message
-            end
+            return unless returned_md5 != calculated_md5
+
+            error_message = mismatch_error_message(
+              'message attributes',
+              calculated_md5,
+              returned_md5,
+              response
+            )
+            raise Aws::Errors::ChecksumError, error_message
+          end
+
+          def validate_system_attributes(system_attributes, response)
+            calculated_md5 = md5_of_message_system_attributes(system_attributes)
+            returned_md5 = response.md5_of_message_system_attributes
+            return unless returned_md5 != calculated_md5
+
+            error_message = mismatch_error_message(
+              'message system attributes',
+              calculated_md5,
+              returned_md5,
+              response
+            )
+            raise Aws::Errors::ChecksumError, error_message
           end
 
           def md5_of_message_body(message_body)
             OpenSSL::Digest::MD5.hexdigest(message_body)
           end
 
+          # MD5 of Message Attributes and System Attributes are effectively
+          # the same calculation. However, keeping these as two methods because
+          # they are modeled as two different shapes.
+          ###
           def md5_of_message_attributes(message_attributes)
-            encoded = { }
+            encoded = {}
             message_attributes.each do |name, attribute|
               name = name.to_s
               encoded[name] = String.new
               data_type_without_label = DATA_TYPE.match(attribute[:data_type])[1]
               encoded[name] << encode_length_and_bytes(name) <<
-              encode_length_and_bytes(attribute[:data_type]) <<
-              [TRANSPORT_TYPE_ENCODINGS[data_type_without_label]].pack('C'.freeze)
+                encode_length_and_bytes(attribute[:data_type]) <<
+                [TRANSPORT_TYPE_ENCODINGS[data_type_without_label]].pack('C')
 
-              if attribute[:string_value] != nil
+              if !attribute[:string_value].nil?
                 encoded[name] << encode_length_and_string(attribute[:string_value])
-              elsif attribute[:binary_value] != nil
+              elsif !attribute[:binary_value].nil?
                 encoded[name] << encode_length_and_bytes(attribute[:binary_value])
               end
             end
@@ -110,6 +134,30 @@ module Aws
             OpenSSL::Digest::MD5.hexdigest(buffer)
           end
 
+          def md5_of_message_system_attributes(message_system_attributes)
+            encoded = {}
+            message_system_attributes.each do |name, attribute|
+              name = name.to_s
+              encoded[name] = String.new
+              data_type_without_label = DATA_TYPE.match(attribute[:data_type])[1]
+              encoded[name] << encode_length_and_bytes(name) <<
+                encode_length_and_bytes(attribute[:data_type]) <<
+                [TRANSPORT_TYPE_ENCODINGS[data_type_without_label]].pack('C')
+
+              if !attribute[:string_value].nil?
+                encoded[name] << encode_length_and_string(attribute[:string_value])
+              elsif !attribute[:binary_value].nil?
+                encoded[name] << encode_length_and_bytes(attribute[:binary_value])
+              end
+            end
+
+            buffer = encoded.keys.sort.reduce(String.new) do |string, name|
+              string << encoded[name]
+            end
+            OpenSSL::Digest::MD5.hexdigest(buffer)
+          end
+          ###
+
           def encode_length_and_string(string)
             string = String.new(string)
             string.encode!(NORMALIZED_ENCODING)
@@ -117,7 +165,7 @@ module Aws
           end
 
           def encode_length_and_bytes(bytes)
-            [bytes.bytesize, bytes].pack('L>a*'.freeze)
+            [bytes.bytesize, bytes].pack('L>a*')
           end
 
           def mismatch_error_message(section, local_md5, returned_md5, response)
@@ -154,13 +202,14 @@ not match.
         end
 
         def add_handlers(handlers, config)
-          if config.verify_checksums
-            handlers.add(Handler, {
-              priority: 10 ,
-              step: :validate,
-              operations: [:send_message, :send_message_batch]
-            })
-          end
+          return unless config.verify_checksums
+
+          handlers.add(
+            Handler,
+            priority: 10,
+            step: :validate,
+            operations: %i[send_message send_message_batch]
+          )
         end
       end
     end

data/lib/aws-sdk-sqs/queue.rb

@@ -207,6 +207,7 @@ module Aws::SQS
     #
     #   message = queue.receive_messages({
     #     attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
+    #     message_system_attribute_names: ["All"], # accepts All, SenderId, SentTimestamp, ApproximateReceiveCount, ApproximateFirstReceiveTimestamp, SequenceNumber, MessageDeduplicationId, MessageGroupId, AWSTraceHeader, DeadLetterQueueSourceArn
     #     message_attribute_names: ["MessageAttributeName"],
     #     max_number_of_messages: 1,
     #     visibility_timeout: 1,
@@ -215,6 +216,53 @@ module Aws::SQS
     #   })
     # @param [Hash] options ({})
     # @option options [Array<String>] :attribute_names
+    #   This parameter has been deprecated but will be supported for backward
+    #   compatibility. To provide attribute names, you are encouraged to use
+    #   `MessageSystemAttributeNames`.
+    #
+    #   A list of attributes that need to be returned along with each message.
+    #   These attributes include:
+    #
+    #   * `All` – Returns all values.
+    #
+    #   * `ApproximateFirstReceiveTimestamp` – Returns the time the message
+    #     was first received from the queue ([epoch time][1] in milliseconds).
+    #
+    #   * `ApproximateReceiveCount` – Returns the number of times a message
+    #     has been received across all queues but not deleted.
+    #
+    #   * `AWSTraceHeader` – Returns the X-Ray trace header string.
+    #
+    #   * `SenderId`
+    #
+    #     * For a user, returns the user ID, for example
+    #       `ABCDEFGHI1JKLMNOPQ23R`.
+    #
+    #     * For an IAM role, returns the IAM role ID, for example
+    #       `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
+    #
+    #   * `SentTimestamp` – Returns the time the message was sent to the queue
+    #     ([epoch time][1] in milliseconds).
+    #
+    #   * `SqsManagedSseEnabled` – Enables server-side queue encryption using
+    #     SQS owned encryption keys. Only one server-side encryption option is
+    #     supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
+    #
+    #   * `MessageDeduplicationId` – Returns the value provided by the
+    #     producer that calls the ` SendMessage ` action.
+    #
+    #   * `MessageGroupId` – Returns the value provided by the producer that
+    #     calls the ` SendMessage ` action. Messages with the same
+    #     `MessageGroupId` are returned in sequence.
+    #
+    #   * `SequenceNumber` – Returns the value provided by Amazon SQS.
+    #
+    #
+    #
+    #   [1]: http://en.wikipedia.org/wiki/Unix_time
+    #   [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
+    #   [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
+    # @option options [Array<String>] :message_system_attribute_names
     #   A list of attributes that need to be returned along with each message.
     #   These attributes include:
     #
@@ -290,8 +338,8 @@ module Aws::SQS
     #   The duration (in seconds) for which the call waits for a message to
     #   arrive in the queue before returning. If a message is available, the
     #   call returns sooner than `WaitTimeSeconds`. If no messages are
-    #   available and the wait time expires, the call returns successfully
-    #   with an empty list of messages.
+    #   available and the wait time expires, the call does not return a
+    #   message list.
     #
     #   To avoid HTTP errors, ensure that the HTTP response timeout for
     #   `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
@@ -319,10 +367,6 @@ module Aws::SQS
     #   * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
     #     can provide a `ReceiveRequestAttemptId` explicitly.
     #
-    #   * If a caller of the `ReceiveMessage` action doesn't provide a
-    #     `ReceiveRequestAttemptId`, Amazon SQS generates a
-    #     `ReceiveRequestAttemptId`.
-    #
     #   * It is possible to retry the `ReceiveMessage` action with the same
     #     `ReceiveRequestAttemptId` if none of the messages have been modified
     #     (deleted or had their visibility changes).
@@ -555,8 +599,8 @@ module Aws::SQS
     #     `MessageGroupId` values. For each `MessageGroupId`, the messages are
     #     sorted by time sent. The caller can't specify a `MessageGroupId`.
     #
-    #   The length of `MessageGroupId` is 128 characters. Valid values:
-    #   alphanumeric characters and punctuation ``
+    #   The maximum length of `MessageGroupId` is 128 characters. Valid
+    #   values: alphanumeric characters and punctuation ``
     #   (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
     #
     #   For best practices of using `MessageGroupId`, see [Using the