aws-sdk-sqs 1.0.0.rc1 → 1.0.0.rc2

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

@@ -20,6 +20,201 @@ module Aws
         @client
       end
 
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   queue = sqs.create_queue({
+      #     queue_name: "String", # required
+      #     attributes: {
+      #       "All" => "String",
+      #     },
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :queue_name
+      #   The name of the new queue. The following limits apply to this name:
+      #
+      #   * A queue name can have up to 80 characters.
+      #
+      #   * The following are accepted: alphanumeric chatacters, hyphens (`-`),
+      #     and underscores (`_`).
+      #
+      #   * A FIFO queue name must end with the `.fifo` suffix.
+      #
+      #   Queue names are case-sensitive.
+      # @option options [Hash<String,String>] :attributes
+      #   A map of attributes with their corresponding values.
+      #
+      #   The following lists the names, descriptions, and values of the special
+      #   request parameters that the `CreateQueue` action uses:
+      #
+      #   * `DelaySeconds` - The number of seconds for which the delivery of all
+      #     messages in the queue is delayed. An integer from 0 to 900 (15
+      #     minutes). The default is 0 (zero).
+      #
+      #   * `MaximumMessageSize` - The limit of how many bytes a message can
+      #     contain before Amazon SQS rejects it. An integer from 1,024 bytes (1
+      #     KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256
+      #     KiB).
+      #
+      #   * `MessageRetentionPeriod` - The number of seconds for which Amazon
+      #     SQS retains a message. An integer representing seconds, from 60 (1
+      #     minute) to 120,9600 (14 days). The default is 345,600 (4 days).
+      #
+      #   * `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 number of seconds for which a
+      #     ReceiveMessage action will wait for a message to arrive. An integer
+      #     from 0 to 20 (seconds). The default is 0.
+      #
+      #   * `RedrivePolicy` - 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 SQS Developer Guide*.
+      #
+      #     <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. An
+      #     integer from 0 to 43200 (12 hours). The default is 30. For more
+      #     information about the visibility timeout, see [Visibility
+      #     Timeout][3] in the *Amazon SQS Developer Guide*.
+      #
+      #   The following attributes apply only to [FIFO (first-in-first-out)
+      #   queues][4]\:
+      #
+      #   * `FifoQueue` - Designates a queue as FIFO. You can provide this
+      #     attribute only during queue creation; you can't change it for an
+      #     existing queue. When you set this attribute, you must provide a
+      #     `MessageGroupId` explicitly.
+      #
+      #     For more information, see [FIFO Queue Logic][5] in the *Amazon SQS
+      #     Developer Guide*.
+      #
+      #   * `ContentBasedDeduplication` - Enables content-based deduplication.
+      #     For more information, see [Exactly-Once Processing][6] in the
+      #     *Amazon SQS Developer Guide*.
+      #
+      #     * Every message must have a unique `MessageDeduplicationId`,
+      #
+      #       * You may provide a `MessageDeduplicationId` explicitly.
+      #
+      #       * If you aren't able to provide a `MessageDeduplicationId` and
+      #         you enable `ContentBasedDeduplication` for your queue, Amazon
+      #         SQS uses a SHA-256 hash to generate the `MessageDeduplicationId`
+      #         using the body of the message (but not the attributes of the
+      #         message).
+      #
+      #       * If you don't provide a `MessageDeduplicationId` and the queue
+      #         doesn't have `ContentBasedDeduplication` set, the action fails
+      #         with an error.
+      #
+      #       * 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.
+      #
+      #     * You can also use `ContentBasedDeduplication` for messages with
+      #       identical content to be treated as duplicates.
+      #
+      #     * If you send one message with `ContentBasedDeduplication` enabled
+      #       and then another message with a `MessageDeduplicationId` that is
+      #       the same as the one generated for the first
+      #       `MessageDeduplicationId`, the two messages are treated as
+      #       duplicates and only one copy of the message is delivered.
+      #
+      #   Any other valid special request parameters that are specified (such as
+      #   `ApproximateNumberOfMessages`, `ApproximateNumberOfMessagesDelayed`,
+      #   `ApproximateNumberOfMessagesNotVisible`, `CreatedTimestamp`,
+      #   `LastModifiedTimestamp`, and `QueueArn`) will be ignored.
+      #
+      #
+      #
+      #   [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/FIFO-queues.html
+      #   [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
+      #   [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
+      # @return [Queue]
+      def create_queue(options = {})
+        resp = @client.create_queue(options)
+        Queue.new(
+          url: resp.data.queue_url,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   queue = sqs.get_queue_by_name({
+      #     queue_name: "String", # required
+      #     queue_owner_aws_account_id: "String",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :queue_name
+      #   The name of the queue whose URL must be fetched. Maximum 80
+      #   characters; alphanumeric characters, hyphens (-), and underscores (\_)
+      #   are allowed.
+      #
+      #   Queue names are case-sensitive.
+      # @option options [String] :queue_owner_aws_account_id
+      #   The AWS account ID of the account that created the queue.
+      # @return [Queue]
+      def get_queue_by_name(options = {})
+        resp = @client.get_queue_url(options)
+        Queue.new(
+          url: resp.data.queue_url,
+          client: @client
+        )
+      end
+
+      # @!group Associations
+
+      # @param [String] url
+      # @return [Queue]
+      def queue(url)
+        Queue.new(
+          url: url,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   queues = sqs.queues({
+      #     queue_name_prefix: "String",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :queue_name_prefix
+      #   A string to use for filtering the list results. Only those queues
+      #   whose name begins with the specified string are returned.
+      #
+      #   Queue names are case-sensitive.
+      # @return [Queue::Collection]
+      def queues(options = {})
+        batches = Enumerator.new do |y|
+          batch = []
+          resp = @client.list_queues(options)
+          resp.data.queue_urls.each do |q|
+            batch << Queue.new(
+              url: q,
+              client: @client
+            )
+          end
+          y.yield(batch)
+        end
+        Queue::Collection.new(batches)
+      end
+
     end
   end
 end

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

@@ -341,8 +341,8 @@ module Aws
       #
       #
       #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
-      #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html
-      #   [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.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/FIFO-queues.html
       #   [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
       #   [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
@@ -558,9 +558,9 @@ module Aws
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html
-      #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html
-      #   [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.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/FIFO-queues.html
       #   [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
       #   [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
@@ -715,12 +715,12 @@ module Aws
       #
       # @!attribute [rw] message_attributes
       #   Each message attribute consists of a Name, Type, and Value. For more
-      #   information, see [Message Attribute Items][1] in the *Amazon SQS
-      #   Developer Guide*.
+      #   information, see [Message Attribute Items and Validation][1] in the
+      #   *Amazon SQS Developer Guide*.
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
       #   @return [Hash<String,Types::MessageAttributeValue>]
       class Message < Struct.new(
         :message_id,
@@ -779,12 +779,12 @@ module Aws
       #   StringValue.
       #
       #   You can also append custom labels. For more information, see
-      #   [Message Attribute Data Types][1] in the *Amazon SQS Developer
-      #   Guide*.
+      #   [Message Attribute Data Types and Validation][1] in the *Amazon SQS
+      #   Developer Guide*.
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributes.DataTypes
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-data-types-validation
       #   @return [String]
       class MessageAttributeValue < Struct.new(
         :string_value,
@@ -998,7 +998,7 @@ module Aws
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
       #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-receiverequestattemptid-request-parameter
       #   @return [String]
       class ReceiveMessageRequest < Struct.new(
@@ -1127,12 +1127,12 @@ module Aws
       #
       # @!attribute [rw] message_attributes
       #   Each message attribute consists of a Name, Type, and Value. For more
-      #   information, see [Message Attribute Items][1] in the *Amazon SQS
-      #   Developer Guide*.
+      #   information, see [Message Attribute Items and Validation][1] in the
+      #   *Amazon SQS Developer Guide*.
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
       #   @return [Hash<String,Types::MessageAttributeValue>]
       #
       # @!attribute [rw] message_deduplication_id
@@ -1354,12 +1354,12 @@ module Aws
       #
       # @!attribute [rw] message_attributes
       #   Each message attribute consists of a Name, Type, and Value. For more
-      #   information, see [Message Attribute Items][1] in the *Amazon SQS
-      #   Developer Guide*.
+      #   information, see [Message Attribute Items and Validation][1] in the
+      #   *Amazon SQS Developer Guide*.
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
       #   @return [Hash<String,Types::MessageAttributeValue>]
       #
       # @!attribute [rw] message_deduplication_id
@@ -1500,7 +1500,7 @@ module Aws
       #
       #
       #
-      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html
+      #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html
       #   @return [String]
       #
       # @!attribute [rw] sequence_number
@@ -1626,8 +1626,8 @@ module Aws
       #
       #
       #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
-      #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html
-      #   [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.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/FIFO-queues.html
       #   [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
       #   @return [Hash<String,String>]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-sqs
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -51,8 +51,10 @@ files:
 - lib/aws-sdk-sqs/client_api.rb
 - lib/aws-sdk-sqs/customizations.rb
 - lib/aws-sdk-sqs/errors.rb
+- lib/aws-sdk-sqs/message.rb
 - lib/aws-sdk-sqs/plugins/md5s.rb
 - lib/aws-sdk-sqs/plugins/queue_urls.rb
+- lib/aws-sdk-sqs/queue.rb
 - lib/aws-sdk-sqs/queue_poller.rb
 - lib/aws-sdk-sqs/resource.rb
 - lib/aws-sdk-sqs/types.rb