aws-sdk-sqs 1.5.0 → 1.80.0

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

@@ -1,14 +1,476 @@
+# 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/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SQS
+
+  # When SQS returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::SQS::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all SQS errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::SQS::Errors::ServiceError
+  #       # rescues all SQS API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {BatchEntryIdsNotDistinct}
+  # * {BatchRequestTooLong}
+  # * {EmptyBatchRequest}
+  # * {InvalidAddress}
+  # * {InvalidAttributeName}
+  # * {InvalidAttributeValue}
+  # * {InvalidBatchEntryId}
+  # * {InvalidIdFormat}
+  # * {InvalidMessageContents}
+  # * {InvalidSecurity}
+  # * {KmsAccessDenied}
+  # * {KmsDisabled}
+  # * {KmsInvalidKeyUsage}
+  # * {KmsInvalidState}
+  # * {KmsNotFound}
+  # * {KmsOptInRequired}
+  # * {KmsThrottled}
+  # * {MessageNotInflight}
+  # * {OverLimit}
+  # * {PurgeQueueInProgress}
+  # * {QueueDeletedRecently}
+  # * {QueueDoesNotExist}
+  # * {QueueNameExists}
+  # * {ReceiptHandleIsInvalid}
+  # * {RequestThrottled}
+  # * {ResourceNotFoundException}
+  # * {TooManyEntriesInBatchRequest}
+  # * {UnsupportedOperation}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
 
+    class BatchEntryIdsNotDistinct < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::BatchEntryIdsNotDistinct] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::BatchRequestTooLong] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::EmptyBatchRequest] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidAttributeName] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidBatchEntryId] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidIdFormat] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
+    class InvalidMessageContents < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::InvalidMessageContents] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::MessageNotInflight] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
+    class OverLimit < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::OverLimit] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::PurgeQueueInProgress] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::QueueDeletedRecently] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::QueueDoesNotExist] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::QueueNameExists] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::ReceiptHandleIsInvalid] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::ResourceNotFoundException] 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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::TooManyEntriesInBatchRequest] data
+      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
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::SQS::Types::UnsupportedOperation] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
   end
 end

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

@@ -1,11 +1,14 @@
+# 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/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SQS
+
   class Message
 
     extend Aws::Deprecations
@@ -24,6 +27,7 @@ module Aws::SQS
       @receipt_handle = extract_receipt_handle(args, options)
       @data = options.delete(:data)
       @client = options.delete(:client) || Client.new(options)
+      @waiter_block_warned = false
     end
 
     # @!group Read-Only Attributes
@@ -39,7 +43,8 @@ module Aws::SQS
     end
 
     # A unique identifier for the message. A `MessageId`is considered unique
-    # across all AWS accounts for an extended period of time.
+    # across all Amazon Web Services accounts for an extended period of
+    # time.
     # @return [String]
     def message_id
       data[:message_id]
@@ -57,10 +62,26 @@ module Aws::SQS
       data[:body]
     end
 
-    # `SenderId`, `SentTimestamp`, `ApproximateReceiveCount`, and/or
-    # `ApproximateFirstReceiveTimestamp`. `SentTimestamp` and
-    # `ApproximateFirstReceiveTimestamp` are each returned as an integer
-    # representing the [epoch time][1] in milliseconds.
+    # A map of the attributes requested in ` ReceiveMessage ` to their
+    # respective values. Supported attributes:
+    #
+    # * `ApproximateReceiveCount`
+    #
+    # * `ApproximateFirstReceiveTimestamp`
+    #
+    # * `MessageDeduplicationId`
+    #
+    # * `MessageGroupId`
+    #
+    # * `SenderId`
+    #
+    # * `SentTimestamp`
+    #
+    # * `SequenceNumber`
+    #
+    # `ApproximateFirstReceiveTimestamp` and `SentTimestamp` are each
+    # returned as an integer representing the [epoch time][1] in
+    # milliseconds.
     #
     #
     #
@@ -84,12 +105,12 @@ module Aws::SQS
     end
 
     # Each message attribute consists of a `Name`, `Type`, and `Value`. For
-    # more information, see [Message Attribute Items and Validation][1] in
-    # the *Amazon Simple Queue Service Developer Guide*.
+    # more information, see [Amazon SQS message attributes][1] in the
+    # *Amazon SQS Developer Guide*.
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
+    # [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
     # @return [Hash<String,Types::MessageAttributeValue>]
     def message_attributes
       data[:message_attributes]
@@ -135,14 +156,16 @@ module Aws::SQS
     # @param [Hash] options ({})
     # @option options [required, Integer] :visibility_timeout
     #   The new value for the message's visibility timeout (in seconds).
-    #   Values values: `0` to `43200`. Maximum: 12 hours.
+    #   Values range: `0` to `43200`. Maximum: 12 hours.
     # @return [EmptyStructure]
     def change_visibility(options = {})
       options = options.merge(
         queue_url: @queue_url,
         receipt_handle: @receipt_handle
       )
-      resp = @client.change_message_visibility(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.change_message_visibility(options)
+      end
       resp.data
     end
 
@@ -156,7 +179,9 @@ module Aws::SQS
         queue_url: @queue_url,
         receipt_handle: @receipt_handle
       )
-      resp = @client.delete_message(options)
+      resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+        @client.delete_message(options)
+      end
       resp.data
     end
 
@@ -221,7 +246,9 @@ module Aws::SQS
               receipt_handle: item.receipt_handle
             }
           end
-          batch[0].client.delete_message_batch(params)
+          Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
+            batch[0].client.delete_message_batch(params)
+          end
         end
         nil
       end

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

@@ -0,0 +1,116 @@
+# 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',
+        rbs_type: 'untyped',
+        docstring: 'The endpoint provider used to resolve endpoints. Any '\
+                   'object that responds to `#resolve_endpoint(parameters)` '\
+                   'where `parameters` is a Struct similar to '\
+                   '`Aws::SQS::EndpointParameters`'
+      ) do |cfg|
+        Aws::SQS::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          unless context[:discovered_endpoint]
+            params = parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
+          end
+
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            context.http_request.headers[key] = value
+          end
+        end
+
+        def parameters_for_operation(context)
+          case context.operation_name
+          when :add_permission
+            Aws::SQS::Endpoints::AddPermission.build(context)
+          when :cancel_message_move_task
+            Aws::SQS::Endpoints::CancelMessageMoveTask.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_message_move_tasks
+            Aws::SQS::Endpoints::ListMessageMoveTasks.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 :start_message_move_task
+            Aws::SQS::Endpoints::StartMessageMoveTask.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