aws-sdk-sqs 1.60.0 → 1.93.0

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

@@ -54,7 +54,7 @@ module Aws::SQS
     #
     # @return [self]
     def load
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.get_queue_attributes(
         queue_url: @url,
         attribute_names: ["All"]
@@ -125,7 +125,7 @@ module Aws::SQS
     # @return [EmptyStructure]
     def add_permission(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.add_permission(options)
       end
       resp.data
@@ -149,7 +149,7 @@ module Aws::SQS
     # @return [Types::ChangeMessageVisibilityBatchResult]
     def change_message_visibility_batch(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.change_message_visibility_batch(options)
       end
       resp.data
@@ -162,7 +162,7 @@ module Aws::SQS
     # @return [EmptyStructure]
     def delete(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.delete_queue(options)
       end
       resp.data
@@ -184,7 +184,7 @@ module Aws::SQS
     # @return [Types::DeleteMessageBatchResult]
     def delete_messages(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.delete_message_batch(options)
       end
       resp.data
@@ -197,7 +197,7 @@ module Aws::SQS
     # @return [EmptyStructure]
     def purge(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.purge_queue(options)
       end
       resp.data
@@ -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,10 @@ module Aws::SQS
     #   })
     # @param [Hash] options ({})
     # @option options [Array<String>] :attribute_names
+    #   This parameter has been discontinued 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:
     #
@@ -235,7 +240,48 @@ module Aws::SQS
     #
     #     * 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:
+    #
+    #   * `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).
     #
@@ -285,13 +331,46 @@ module Aws::SQS
     # @option options [Integer] :visibility_timeout
     #   The duration (in seconds) that the received messages are hidden from
     #   subsequent retrieve requests after being retrieved by a
-    #   `ReceiveMessage` request.
+    #   `ReceiveMessage` request. If not specified, the default visibility
+    #   timeout for the queue is used, which is 30 seconds.
+    #
+    #   Understanding `VisibilityTimeout`:
+    #
+    #   * When a message is received from a queue, it becomes temporarily
+    #     invisible to other consumers for the duration of the visibility
+    #     timeout. This prevents multiple consumers from processing the same
+    #     message simultaneously. If the message is not deleted or its
+    #     visibility timeout is not extended before the timeout expires, it
+    #     becomes visible again and can be retrieved by other consumers.
+    #
+    #   * Setting an appropriate visibility timeout is crucial. If it's too
+    #     short, the message might become visible again before processing is
+    #     complete, leading to duplicate processing. If it's too long, it
+    #     delays the reprocessing of messages if the initial processing fails.
+    #
+    #   * You can adjust the visibility timeout using the
+    #     `--visibility-timeout` parameter in the `receive-message` command to
+    #     match the processing time required by your application.
+    #
+    #   * A message that isn't deleted or a message whose visibility isn't
+    #     extended before the visibility timeout expires counts as a failed
+    #     receive. Depending on the configuration of the queue, the message
+    #     might be sent to the dead-letter queue.
+    #
+    #   For more information, see [Visibility Timeout][1] in the *Amazon SQS
+    #   Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
     # @option options [Integer] :wait_time_seconds
     #   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. If you are using the Java SDK, it returns a
+    #   `ReceiveMessageResponse` object, which has a empty list instead of a
+    #   Null object.
     #
     #   To avoid HTTP errors, ensure that the HTTP response timeout for
     #   `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
@@ -319,10 +398,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).
@@ -356,7 +431,7 @@ module Aws::SQS
     #
     #   The maximum length of `ReceiveRequestAttemptId` is 128 characters.
     #   `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
-    #   `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
+    #   `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
     #   ``).
     #
     #   For best practices of using `ReceiveRequestAttemptId`, see [Using the
@@ -371,7 +446,7 @@ module Aws::SQS
     def receive_messages(options = {})
       batch = []
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.receive_message(options)
       end
       resp.data.messages.each do |m|
@@ -397,7 +472,7 @@ module Aws::SQS
     # @return [EmptyStructure]
     def remove_permission(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.remove_permission(options)
       end
       resp.data
@@ -435,13 +510,17 @@ module Aws::SQS
     #   size is 256 KiB.
     #
     #   A message can include only XML, JSON, and unformatted text. The
-    #   following Unicode characters are allowed:
+    #   following Unicode characters are allowed. For more information, see
+    #   the [W3C specification for characters][1].
     #
     #    `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
     #   \| `#x10000` to `#x10FFFF`
     #
-    #    Any characters not included in this list will be rejected. For more
-    #   information, see the [W3C specification for characters][1].
+    #    Amazon SQS does not throw an exception or completely reject the
+    #   message if it contains invalid characters. Instead, it replaces those
+    #   invalid characters with `U+FFFD` before storing the message in the
+    #   queue, as long as the message body contains at least one valid
+    #   character.
     #
     #
     #
@@ -500,7 +579,6 @@ module Aws::SQS
     #
     #     * If the queue has `ContentBasedDeduplication` set, your
     #       `MessageDeduplicationId` overrides the generated one.
-    #
     #   * When `ContentBasedDeduplication` is in effect, messages with
     #     identical content sent within the deduplication interval are treated
     #     as duplicates and only one copy of the message is delivered.
@@ -525,7 +603,7 @@ module Aws::SQS
     #
     #   The maximum length of `MessageDeduplicationId` is 128 characters.
     #   `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
-    #   `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
+    #   `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
     #   ``).
     #
     #   For best practices of using `MessageDeduplicationId`, see [Using the
@@ -555,9 +633,9 @@ 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
     #   MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
@@ -571,7 +649,7 @@ module Aws::SQS
     # @return [Types::SendMessageResult]
     def send_message(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.send_message(options)
       end
       resp.data
@@ -614,7 +692,7 @@ module Aws::SQS
     # @return [Types::SendMessageBatchResult]
     def send_messages(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.send_message_batch(options)
       end
       resp.data
@@ -683,7 +761,6 @@ module Aws::SQS
     #       Default: 10. When the `ReceiveCount` for a message exceeds the
     #       `maxReceiveCount` for a queue, Amazon SQS moves the message to the
     #       dead-letter-queue.
-    #
     #   * `RedriveAllowPolicy` – The string that includes the parameters for
     #     the permissions for the dead-letter queue redrive permission and
     #     which source queues can specify dead-letter queues as a JSON object.
@@ -702,7 +779,6 @@ module Aws::SQS
     #
     #       * `byQueue` – Only queues specified by the `sourceQueueArns`
     #         parameter can specify this queue as the dead-letter queue.
-    #
     #     * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
     #       queues that can specify this queue as the dead-letter queue and
     #       redrive messages. You can specify this parameter only when the
@@ -762,7 +838,6 @@ module Aws::SQS
     #
     #       * If the queue has `ContentBasedDeduplication` set, your
     #         `MessageDeduplicationId` overrides the generated one.
-    #
     #     * When `ContentBasedDeduplication` is in effect, messages with
     #       identical content sent within the deduplication interval are
     #       treated as duplicates and only one copy of the message is
@@ -819,7 +894,7 @@ module Aws::SQS
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(queue_url: @url)
-      resp = Aws::Plugins::UserAgent.feature('resource') do
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         @client.set_queue_attributes(options)
       end
       resp.data
@@ -835,7 +910,7 @@ module Aws::SQS
     def dead_letter_source_queues(options = {})
       batches = Enumerator.new do |y|
         options = options.merge(queue_url: @url)
-        resp = Aws::Plugins::UserAgent.feature('resource') do
+        resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
           @client.list_dead_letter_source_queues(options)
         end
         resp.each_page do |page|