aws-sdk-sqs 1.10.0 → 1.34.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'openssl'
 
 module Aws
@@ -50,7 +52,9 @@ module Aws
 
           def validate_single_message(body, attributes, response)
             validate_body(body, response)
-            validate_attributes(attributes, response) unless attributes.nil?
+            unless attributes.nil? || attributes.empty?
+              validate_attributes(attributes, response)
+            end
           end
 
           def validate_body(body, response)
@@ -117,14 +121,12 @@ module Aws
           end
 
           def mismatch_error_message(section, local_md5, returned_md5, response)
-            m = "MD5 returned by SQS does not match " <<
-            "the calculation on the original request. ("
-
+            m = 'MD5 returned by SQS does not match '\
+                'the calculation on the original request. ('
             if response.respond_to?(:id) && !response.id.nil?
-              m << "Message ID: #{response.id}, "
+              m = "#{m}Message ID: #{response.id}, "
             end
-
-            m << "MD5 calculated by the #{section}: " <<
+            "#{m}MD5 calculated by the #{section}: "\
             "'#{local_md5}', MD5 checksum returned: '#{returned_md5}')"
           end
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
   module SQS
     module Plugins
@@ -22,7 +24,7 @@ module Aws
           # region, then we will modify the request to have
           # a sigv4 signer for the proper region.
           def update_region(context, queue_url)
-            if queue_region = queue_url.to_s.split('.')[1]
+            if queue_region = parse_region(queue_url)
               if queue_region != context.config.region
                 config = context.config.dup
                 config.region = queue_region
@@ -33,6 +35,16 @@ module Aws
             end
           end
 
+          private
+
+          # take the first component after service delimiter
+          # https://sqs.us-east-1.amazonaws.com/1234567890/demo
+          # https://vpce-x-y.sqs.us-east-1.vpce.amazonaws.com/1234567890/demo
+          def parse_region(url)
+            parts = url.split('sqs.')
+            parts[1].split('.').first if parts.size > 1
+          end
+
         end
 
         handler(Handler)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SQS
+
   class Queue
 
     extend Aws::Deprecations
@@ -21,6 +24,7 @@ module Aws::SQS
       @url = extract_url(args, options)
       @data = options.delete(:data)
       @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
     end
 
     # @!group Read-Only Attributes
@@ -98,8 +102,8 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P
-    #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P
+    #   [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication
     # @option options [required, Array<String>] :actions
     #   The action the client wants to allow for the specified principal.
     #   Valid values: the name of any action or `*`.
@@ -116,7 +120,7 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html
     # @return [EmptyStructure]
     def add_permission(options = {})
       options = options.merge(queue_url: @url)
@@ -200,16 +204,18 @@ module Aws::SQS
     #   })
     # @param [Hash] options ({})
     # @option options [Array<String>] :attribute_names
-    #   A list of s that need to be returned along with each message. These
-    #   attributes include:
+    #   A list of attributes that need to be returned along with each message.
+    #   These attributes include:
     #
-    #   * `All` - Returns all values.
+    #   * `All` – Returns all values.
     #
-    #   * `ApproximateFirstReceiveTimestamp` - Returns the time the message
+    #   * `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 from the queue but not deleted.
+    #   * `ApproximateReceiveCount` – Returns the number of times a message
+    #     has been received across all queues but not deleted.
+    #
+    #   * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
     #
     #   * `SenderId`
     #
@@ -219,17 +225,17 @@ 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
+    #   * `SentTimestamp` – Returns the time the message was sent to the queue
     #     ([epoch time][1] in milliseconds).
     #
-    #   * `MessageDeduplicationId` - Returns the value provided by the
+    #   * `MessageDeduplicationId` – Returns the value provided by the
     #     producer that calls the ` SendMessage ` action.
     #
-    #   * `MessageGroupId` - Returns the value provided by the producer that
+    #   * `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.
+    #   * `SequenceNumber` – Returns the value provided by Amazon SQS.
     #
     #
     #
@@ -269,14 +275,25 @@ module Aws::SQS
     #   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.
+    #
+    #   To avoid HTTP errors, ensure that the HTTP response timeout for
+    #   `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
+    #   parameter. For example, with the Java SDK, you can set HTTP transport
+    #   settings using the [ NettyNioAsyncHttpClient][1] for asynchronous
+    #   clients, or the [ ApacheHttpClient][2] for synchronous clients.
+    #
+    #
+    #
+    #   [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
+    #   [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
     # @option options [String] :receive_request_attempt_id
     #   This parameter applies only to FIFO (first-in-first-out) queues.
     #
     #   The token used for deduplication of `ReceiveMessage` calls. If a
     #   networking issue occurs after a `ReceiveMessage` action, and instead
-    #   of a response you receive a generic error, you can retry the same
-    #   action with an identical `ReceiveRequestAttemptId` to retrieve the
-    #   same set of messages, even if their visibility timeout has not yet
+    #   of a response you receive a generic error, it is possible to retry the
+    #   same action with an identical `ReceiveRequestAttemptId` to retrieve
+    #   the same set of messages, even if their visibility timeout has not yet
     #   expired.
     #
     #   * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
@@ -289,7 +306,7 @@ module Aws::SQS
     #     `ReceiveRequestAttemptId`, Amazon SQS generates a
     #     `ReceiveRequestAttemptId`.
     #
-    #   * You can retry the `ReceiveMessage` action with the same
+    #   * 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).
     #
@@ -320,7 +337,7 @@ module Aws::SQS
     #     visibility timeout expires. As a result, delays might occur but the
     #     messages in the queue remain in a strict order.
     #
-    #   The length of `ReceiveRequestAttemptId` is 128 characters.
+    #   The maximum length of `ReceiveRequestAttemptId` is 128 characters.
     #   `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
     #   `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
     #   ``).
@@ -331,8 +348,8 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
-    #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
+    #   [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html
     # @return [Message::Collection]
     def receive_messages(options = {})
       batch = []
@@ -379,12 +396,22 @@ module Aws::SQS
     #         data_type: "String", # required
     #       },
     #     },
+    #     message_system_attributes: {
+    #       "AWSTraceHeader" => {
+    #         string_value: "String",
+    #         binary_value: "data",
+    #         string_list_values: ["String"],
+    #         binary_list_values: ["data"],
+    #         data_type: "String", # required
+    #       },
+    #     },
     #     message_deduplication_id: "String",
     #     message_group_id: "String",
     #   })
     # @param [Hash] options ({})
     # @option options [required, String] :message_body
-    #   The message to send. The maximum string size is 256 KB.
+    #   The message to send. The minimum size is one character. The maximum
+    #   size is 256 KB.
     #
     #   A message can include only XML, JSON, and unformatted text. The
     #   following Unicode characters are allowed:
@@ -416,7 +443,17 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
+    # @option options [Hash<String,Types::MessageSystemAttributeValue>] :message_system_attributes
+    #   The message system attribute to send. Each message system attribute
+    #   consists of a `Name`, `Type`, and `Value`.
+    #
+    #   * Currently, the only supported message system attribute is
+    #     `AWSTraceHeader`. Its type must be `String` and its value must be a
+    #     correctly formatted AWS X-Ray trace header string.
+    #
+    #   * The size of a message system attribute doesn't count towards the
+    #     total size of a message.
     # @option options [String] :message_deduplication_id
     #   This parameter applies only to FIFO (first-in-first-out) queues.
     #
@@ -465,7 +502,7 @@ module Aws::SQS
     #
     #    </note>
     #
-    #   The length of `MessageDeduplicationId` is 128 characters.
+    #   The maximum length of `MessageDeduplicationId` is 128 characters.
     #   `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
     #   `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
     #   ``).
@@ -476,8 +513,8 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
-    #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
+    #   [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
     # @option options [String] :message_group_id
     #   This parameter applies only to FIFO (first-in-first-out) queues.
     #
@@ -510,7 +547,7 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
+    #   [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
     # @return [Types::SendMessageResult]
     def send_message(options = {})
       options = options.merge(queue_url: @url)
@@ -535,6 +572,15 @@ module Aws::SQS
     #             data_type: "String", # required
     #           },
     #         },
+    #         message_system_attributes: {
+    #           "AWSTraceHeader" => {
+    #             string_value: "String",
+    #             binary_value: "data",
+    #             string_list_values: ["String"],
+    #             binary_list_values: ["data"],
+    #             data_type: "String", # required
+    #           },
+    #         },
     #         message_deduplication_id: "String",
     #         message_group_id: "String",
     #       },
@@ -564,39 +610,39 @@ module Aws::SQS
     #   The following lists the names, descriptions, and values of the special
     #   request parameters that the `SetQueueAttributes` action uses:
     #
-    #   * `DelaySeconds` - The length of time, in seconds, for which the
+    #   * `DelaySeconds` – The length of time, in seconds, for which the
     #     delivery of all messages in the queue is delayed. Valid values: An
     #     integer from 0 to 900 (15 minutes). Default: 0.
     #
-    #   * `MaximumMessageSize` - The limit of how many bytes a message can
+    #   * `MaximumMessageSize` – The limit of how many bytes a message can
     #     contain before Amazon SQS rejects it. Valid values: An integer from
     #     1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
     #     (256 KiB).
     #
-    #   * `MessageRetentionPeriod` - The length of time, in seconds, for which
+    #   * `MessageRetentionPeriod` – The length of time, in seconds, for which
     #     Amazon SQS retains a message. Valid values: An integer representing
     #     seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
     #     (4 days).
     #
-    #   * `Policy` - The queue's policy. A valid AWS policy. For more
+    #   * `Policy` – The queue's policy. A valid AWS policy. For more
     #     information about policy structure, see [Overview of AWS IAM
     #     Policies][1] in the *Amazon IAM User Guide*.
     #
-    #   * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
+    #   * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
     #     for which a ` ReceiveMessage ` action waits for a message to arrive.
-    #     Valid values: an integer from 0 to 20 (seconds). Default: 0.
+    #     Valid values: An integer from 0 to 20 (seconds). Default: 0.
     #
-    #   * `RedrivePolicy` - The string that includes the parameters for the
-    #     dead-letter queue functionality of the source queue. For more
-    #     information about the redrive policy and dead-letter queues, see
-    #     [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple Queue
-    #     Service Developer Guide*.
+    #   * `RedrivePolicy` – The string that includes the parameters for the
+    #     dead-letter queue functionality of the source queue as a JSON
+    #     object. For more information about the redrive policy and
+    #     dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
+    #     the *Amazon Simple Queue Service Developer Guide*.
     #
-    #     * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
+    #     * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
     #       dead-letter queue to which Amazon SQS moves messages after the
     #       value of `maxReceiveCount` is exceeded.
     #
-    #     * `maxReceiveCount` - The number of times a message is delivered to
+    #     * `maxReceiveCount` – The number of times a message is delivered to
     #       the source queue before being moved to the dead-letter queue. When
     #       the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
     #       a queue, Amazon SQS moves the message to the dead-letter-queue.
@@ -607,22 +653,22 @@ module Aws::SQS
     #
     #      </note>
     #
-    #   * `VisibilityTimeout` - The visibility timeout for the queue, in
-    #     seconds. Valid values: an integer from 0 to 43,200 (12 hours).
+    #   * `VisibilityTimeout` – The visibility timeout for the queue, in
+    #     seconds. Valid values: An integer from 0 to 43,200 (12 hours).
     #     Default: 30. For more information about the visibility timeout, see
     #     [Visibility Timeout][3] in the *Amazon Simple Queue Service
     #     Developer Guide*.
     #
     #   The following attributes apply only to [server-side-encryption][4]\:
     #
-    #   * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
+    #   * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
     #     (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
     #     Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
     #     always `alias/aws/sqs`, the alias of a custom CMK can, for example,
     #     be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
     #     Key Management Service API Reference*.
     #
-    #   * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
+    #   * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
     #     which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
     #     messages before calling AWS KMS again. An integer representing
     #     seconds, between 60 seconds (1 minute) and 86,400 seconds (24
@@ -634,7 +680,7 @@ module Aws::SQS
     #   The following attribute applies only to [FIFO (first-in-first-out)
     #   queues][9]\:
     #
-    #   * `ContentBasedDeduplication` - Enables content-based deduplication.
+    #   * `ContentBasedDeduplication` – Enables content-based deduplication.
     #     For more information, see [Exactly-Once Processing][10] in the
     #     *Amazon Simple Queue Service Developer Guide*.
     #
@@ -668,16 +714,16 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
-    #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
-    #   [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
-    #   [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
-    #   [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
-    #   [6]: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
-    #   [7]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
-    #   [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
-    #   [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
-    #   [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
+    #   [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
+    #   [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
+    #   [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
+    #   [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
+    #   [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
+    #   [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
+    #   [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
+    #   [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
+    #   [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
     # @return [EmptyStructure]
     def set_attributes(options = {})
       options = options.merge(queue_url: @url)
@@ -694,16 +740,18 @@ module Aws::SQS
     # @return [Queue::Collection]
     def dead_letter_source_queues(options = {})
       batches = Enumerator.new do |y|
-        batch = []
         options = options.merge(queue_url: @url)
         resp = @client.list_dead_letter_source_queues(options)
-        resp.data.queue_urls.each do |q|
-          batch << Queue.new(
-            url: q,
-            client: @client
-          )
+        resp.each_page do |page|
+          batch = []
+          page.data.queue_urls.each do |q|
+            batch << Queue.new(
+              url: q,
+              client: @client
+            )
+          end
+          y.yield(batch)
         end
-        y.yield(batch)
       end
       Queue::Collection.new(batches)
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Aws
@@ -253,7 +255,7 @@ module Aws
       #
       # @return [void]
       def before_request(&block)
-        @default_config = @default_config.with(before_request: Proc.new)
+        @default_config = @default_config.with(before_request: block) if block_given?
       end
 
       # Polls the queue, yielded a message, or an array of messages.
@@ -288,7 +290,7 @@ module Aws
       # @option options [Integer] :visibility_timeout (nil)
       #   The number of seconds you have to process a message before
       #   it is put back into the queue and can be received again.
-      #   By default, the queue's
+      #   By default, the queue's visibility timeout is not set.
       #
       # @option options [Array<String>] :attribute_names ([])
       #   The list of attributes that need to be returned along with each