aws-sdk-sqs 1.50.0 → 1.54.0

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}
   # * {TooManyEntriesInBatchRequest}
   # * {UnsupportedOperation}
   #
@@ -58,6 +69,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
@@ -68,6 +84,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
@@ -78,6 +99,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
@@ -88,6 +129,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
@@ -98,6 +159,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
@@ -118,6 +184,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
@@ -138,6 +329,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
@@ -148,6 +344,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
@@ -158,6 +359,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
@@ -168,6 +374,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
@@ -178,6 +389,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
@@ -188,6 +404,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 TooManyEntriesInBatchRequest < ServiceError
@@ -198,6 +434,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
@@ -208,6 +449,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

@@ -0,0 +1,108 @@
+# 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::SQS
+  module Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: 'Aws::SQS::EndpointProvider',
+        docstring: 'The endpoint provider used to resolve endpoints. Any '\
+                   'object that responds to `#resolve_endpoint(parameters)` '\
+                   'where `parameters` is a Struct similar to '\
+                   '`Aws::SQS::EndpointParameters`'
+      ) do |cfg|
+        Aws::SQS::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          # If endpoint was discovered, do not resolve or apply the endpoint.
+          unless context[:discovered_endpoint]
+            params = parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+          end
+
+          context[:endpoint_params] = params
+          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::SQS::Endpoints::AddPermission.build(context)
+          when :change_message_visibility
+            Aws::SQS::Endpoints::ChangeMessageVisibility.build(context)
+          when :change_message_visibility_batch
+            Aws::SQS::Endpoints::ChangeMessageVisibilityBatch.build(context)
+          when :create_queue
+            Aws::SQS::Endpoints::CreateQueue.build(context)
+          when :delete_message
+            Aws::SQS::Endpoints::DeleteMessage.build(context)
+          when :delete_message_batch
+            Aws::SQS::Endpoints::DeleteMessageBatch.build(context)
+          when :delete_queue
+            Aws::SQS::Endpoints::DeleteQueue.build(context)
+          when :get_queue_attributes
+            Aws::SQS::Endpoints::GetQueueAttributes.build(context)
+          when :get_queue_url
+            Aws::SQS::Endpoints::GetQueueUrl.build(context)
+          when :list_dead_letter_source_queues
+            Aws::SQS::Endpoints::ListDeadLetterSourceQueues.build(context)
+          when :list_queue_tags
+            Aws::SQS::Endpoints::ListQueueTags.build(context)
+          when :list_queues
+            Aws::SQS::Endpoints::ListQueues.build(context)
+          when :purge_queue
+            Aws::SQS::Endpoints::PurgeQueue.build(context)
+          when :receive_message
+            Aws::SQS::Endpoints::ReceiveMessage.build(context)
+          when :remove_permission
+            Aws::SQS::Endpoints::RemovePermission.build(context)
+          when :send_message
+            Aws::SQS::Endpoints::SendMessage.build(context)
+          when :send_message_batch
+            Aws::SQS::Endpoints::SendMessageBatch.build(context)
+          when :set_queue_attributes
+            Aws::SQS::Endpoints::SetQueueAttributes.build(context)
+          when :tag_queue
+            Aws::SQS::Endpoints::TagQueue.build(context)
+          when :untag_queue
+            Aws::SQS::Endpoints::UntagQueue.build(context)
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end

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

@@ -5,11 +5,10 @@ module Aws
     module Plugins
       # @api private
       class QueueUrls < Seahorse::Client::Plugin
-
+        # Extract region from a provided queue_url
         class Handler < Seahorse::Client::Handler
-
           def call(context)
-            if queue_url = context.params[:queue_url]
+            if (queue_url = context.params[:queue_url])
               update_endpoint(context, queue_url)
               update_region(context, queue_url)
             end
@@ -21,28 +20,31 @@ module Aws
           end
 
           # If the region in the queue url is not the configured
-          # region, then we will modify the request to have
-          # a sigv4 signer for the proper region.
+          # region, then we will modify signing to use it
           def update_region(context, queue_url)
-            if queue_region = parse_region(queue_url)
-              if queue_region != context.config.region
-                config = context.config.dup
-                config.region = queue_region
-                config.sigv4_region = queue_region
-                config.sigv4_signer = Aws::Plugins::SignatureV4.build_signer(config)
-                context.config = config
-              end
+            if (queue_region = parse_region(queue_url)) &&
+               queue_region != context.config.region
+              context[:auth_scheme]['signingRegion'] = queue_region
             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
+          # take the first component after the SQS service component
+          # Will return us-east-1 for:
+          #   https://sqs.us-east-1.amazonaws.com/1234567890/demo
+          #   https://vpce-x-y.sqs.us-east-1.vpce.amazonaws.com/1234567890/demo
+          # Will not return for:
+          #   https://localstack-sqs.example.dev/queue/example
           def parse_region(url)
-            parts = url.split('sqs.')
-            parts[1].split('.').first if parts.size > 1
+            parts = URI.parse(url).host.split('.')
+            parts.each_with_index do |part, index|
+              if part == 'sqs'
+                # assume region is the part right after the 'sqs' part
+                return parts[index + 1]
+              end
+            end
+            nil # no region found
           end
 
         end

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

@@ -218,7 +218,7 @@ module Aws::SQS
     #
     #   * `SenderId`
     #
-    #     * For an IAM user, returns the IAM user ID, for example
+    #     * For a user, returns the user ID, for example
     #       `ABCDEFGHI1JKLMNOPQ23R`.
     #
     #     * For an IAM role, returns the IAM role ID, for example
@@ -229,7 +229,7 @@ module Aws::SQS
     #
     #   * `SqsManagedSseEnabled` – Enables server-side queue encryption using
     #     SQS owned encryption keys. Only one server-side encryption option is
-    #     supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
+    #     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.
@@ -416,7 +416,7 @@ module Aws::SQS
     # @param [Hash] options ({})
     # @option options [required, String] :message_body
     #   The message to send. The minimum size is one character. The maximum
-    #   size is 256 KB.
+    #   size is 256 KiB.
     #
     #   A message can include only XML, JSON, and unformatted text. The
     #   following Unicode characters are allowed:
@@ -626,7 +626,13 @@ module Aws::SQS
     #   * `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).
+    #     (4 days). When you change a queue's attributes, the change can take
+    #     up to 60 seconds for most of the attributes to propagate throughout
+    #     the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
+    #     attribute can take up to 15 minutes and will impact existing
+    #     messages in the queue potentially causing them to be expired and
+    #     deleted if the `MessageRetentionPeriod` is reduced below the age of
+    #     existing messages.
     #
     #   * `Policy` – The queue's policy. A valid Amazon Web Services policy.
     #     For more information about policy structure, see [Overview of Amazon
@@ -637,33 +643,61 @@ module Aws::SQS
     #     for which a ` ReceiveMessage ` action waits for a message to arrive.
     #     Valid values: An integer from 0 to 20 (seconds). Default: 0.
     #
+    #   * `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][2] in the *Amazon SQS Developer Guide*.
+    #
+    #   The following attributes apply only to [dead-letter queues:][3]
+    #
     #   * `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 SQS Developer Guide*.
+    #     object. The parameters are as follows:
     #
     #     * `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
-    #       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.
-    #
-    #     <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
-    #     Similarly, the dead-letter queue of a standard queue must also be a
-    #     standard queue.
+    #       the source queue before being moved to the dead-letter queue.
+    #       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.
+    #     The parameters are as follows:
+    #
+    #     * `redrivePermission` – The permission type that defines which
+    #       source queues can specify the current queue as the dead-letter
+    #       queue. Valid values are:
+    #
+    #       * `allowAll` – (Default) Any source queues in this Amazon Web
+    #         Services account in the same Region can specify this queue as
+    #         the dead-letter queue.
+    #
+    #       * `denyAll` – No source queues can specify this queue as the
+    #         dead-letter queue.
+    #
+    #       * `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
+    #       `redrivePermission` parameter is set to `byQueue`. You can specify
+    #       up to 10 source queue ARNs. To allow more than 10 source queues to
+    #       specify dead-letter queues, set the `redrivePermission` parameter
+    #       to `allowAll`.
+    #
+    #   <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
+    #   Similarly, the dead-letter queue of a standard queue must also be a
+    #   standard queue.
     #
-    #      </note>
-    #
-    #   * `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 SQS Developer Guide*.
+    #    </note>
     #
-    #   The following attributes apply only to [server-side-encryption][4]\:
+    #   The following attributes apply only to [server-side-encryption][4]:
     #
     #   * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
     #     master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -683,10 +717,10 @@ module Aws::SQS
     #
     #   * `SqsManagedSseEnabled` – Enables server-side queue encryption using
     #     SQS owned encryption keys. Only one server-side encryption option is
-    #     supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
+    #     supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
     #
     #   The following attribute applies only to [FIFO (first-in-first-out)
-    #   queues][11]\:
+    #   queues][11]:
     #
     #   * `ContentBasedDeduplication` – Enables content-based deduplication.
     #     For more information, see [Exactly-once processing][12] in the
@@ -721,7 +755,7 @@ module Aws::SQS
     #       duplicates and only one copy of the message is delivered.
     #
     #   The following attributes apply only to [high throughput for FIFO
-    #   queues][13]\:
+    #   queues][13]:
     #
     #   * `DeduplicationScope` – Specifies whether message deduplication
     #     occurs at the message group or queue level. Valid values are
@@ -749,8 +783,8 @@ module Aws::SQS
     #
     #
     #   [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
+    #   [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
+    #   [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.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

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

@@ -498,6 +498,12 @@ module Aws
               raise ArgumentError, "invalid option #{opt_name.inspect}"
             end
           end
+
+          max_number_of_messages = @request_params[:max_number_of_messages]
+          unless max_number_of_messages.is_a?(Integer) && max_number_of_messages.positive?
+            raise ArgumentError, ':max_number_of_messages must be a positive integer'
+          end
+
           @request_params.freeze
           freeze
         end