aws-sdk-sqs 1.6.0 → 1.7.0

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

@@ -332,6 +332,7 @@ module Aws::SQS
         "protocol" => "query",
         "serviceAbbreviation" => "Amazon SQS",
         "serviceFullName" => "Amazon Simple Queue Service",
+        "serviceId" => "SQS",
         "signatureVersion" => "v4",
         "uid" => "sqs-2012-11-05",
         "xmlNamespace" => "http://queue.amazonaws.com/doc/2012-11-05/",

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

@@ -57,10 +57,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 +100,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 Simple Queue Service Developer Guide*.
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
+    # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
     # @return [Hash<String,Types::MessageAttributeValue>]
     def message_attributes
       data[:message_attributes]

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

@@ -99,27 +99,14 @@ 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/AWSCredentials.html
+    #   [2]: http://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. The
-    #   following values are valid:
+    #   The action the client wants to allow for the specified principal.
+    #   Valid values: the name of any action or `*`.
     #
-    #   * `*`
-    #
-    #   * `ChangeMessageVisibility`
-    #
-    #   * `DeleteMessage`
-    #
-    #   * `GetQueueAttributes`
-    #
-    #   * `GetQueueUrl`
-    #
-    #   * `ReceiveMessage`
-    #
-    #   * `SendMessage`
-    #
-    #   For more information about these actions, see [Understanding
-    #   Permissions][1] in the *Amazon Simple Queue Service Developer Guide*.
+    #   For more information about these actions, see [Overview of Managing
+    #   Access Permissions to Your Amazon Simple Queue Service Resource][1] in
+    #   the *Amazon Simple Queue Service Developer Guide*.
     #
     #   Specifying `SendMessage`, `DeleteMessage`, or
     #   `ChangeMessageVisibility` for `ActionName.n` also grants permissions
@@ -129,7 +116,7 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes
+    #   [1]: http://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)
@@ -213,8 +200,8 @@ module Aws::SQS
     #   })
     # @param [Hash] options ({})
     # @option options [Array<String>] :attribute_names
-    #   A list of attributes that need to be returned along with each message.
-    #   These attributes include:
+    #   A list of s that need to be returned along with each message. These
+    #   attributes include:
     #
     #   * `All` - Returns all values.
     #
@@ -235,48 +222,15 @@ module Aws::SQS
     #   * `SentTimestamp` - Returns the time the message was sent to the queue
     #     ([epoch time][1] in milliseconds).
     #
-    #   * `MessageDeduplicationId` - Returns the value provided by the sender
-    #     that calls the ` SendMessage ` action.
+    #   * `MessageDeduplicationId` - Returns the value provided by the
+    #     producer that calls the ` SendMessage ` action.
     #
-    #   * `MessageGroupId` - Returns the value provided by the sender 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.
     #
-    #   Any other valid special request parameters (such as the following) are
-    #   ignored:
-    #
-    #   * `ApproximateNumberOfMessages`
-    #
-    #   * `ApproximateNumberOfMessagesDelayed`
-    #
-    #   * `ApproximateNumberOfMessagesNotVisible`
-    #
-    #   * `CreatedTimestamp`
-    #
-    #   * `ContentBasedDeduplication`
-    #
-    #   * `DelaySeconds`
-    #
-    #   * `FifoQueue`
-    #
-    #   * `LastModifiedTimestamp`
-    #
-    #   * `MaximumMessageSize`
-    #
-    #   * `MessageRetentionPeriod`
-    #
-    #   * `Policy`
-    #
-    #   * `QueueArn`,
-    #
-    #   * `ReceiveMessageWaitTimeSeconds`
-    #
-    #   * `RedrivePolicy`
-    #
-    #   * `VisibilityTimeout`
-    #
     #
     #
     #   [1]: http://en.wikipedia.org/wiki/Unix_time
@@ -304,7 +258,7 @@ module Aws::SQS
     # @option options [Integer] :max_number_of_messages
     #   The maximum number of messages to return. Amazon SQS never returns
     #   more messages than this value (however, fewer messages might be
-    #   returned). Valid values are 1 to 10. Default is 1.
+    #   returned). Valid values: 1 to 10. Default: 1.
     # @option options [Integer] :visibility_timeout
     #   The duration (in seconds) that the received messages are hidden from
     #   subsequent retrieve requests after being retrieved by a
@@ -345,13 +299,12 @@ module Aws::SQS
     #     resets the visibility timeout. For more information, see [Visibility
     #     Timeout][1] in the *Amazon Simple Queue Service Developer Guide*.
     #
-    #     If a caller of the `ReceiveMessage` action is still processing
-    #     messages when the visibility timeout expires and messages become
-    #     visible, another worker reading from the same queue can receive the
-    #     same messages and therefore process duplicates. Also, if a reader
-    #     whose message processing time is longer than the visibility timeout
-    #     tries to delete the processed messages, the action fails with an
-    #     error.
+    #     If a caller of the `ReceiveMessage` action still processes messages
+    #     when the visibility timeout expires and messages become visible,
+    #     another worker consuming from the same queue can receive the same
+    #     messages and therefore process duplicates. Also, if a consumer whose
+    #     message processing time is longer than the visibility timeout tries
+    #     to delete the processed messages, the action fails with an error.
     #
     #      To mitigate this effect, ensure that your application observes a
     #     safe threshold before the visibility timeout expires and extend the
@@ -379,7 +332,7 @@ 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/FIFO-queue-recommendations.html#using-receiverequestattemptid-request-parameter
+    #   [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html
     # @return [Message::Collection]
     def receive_messages(options = {})
       batch = []
@@ -458,12 +411,12 @@ module Aws::SQS
     #    </note>
     # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
     #   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 Simple Queue Service Developer Guide*.
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
+    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
     # @option options [String] :message_deduplication_id
     #   This parameter applies only to FIFO (first-in-first-out) queues.
     #
@@ -500,13 +453,16 @@ module Aws::SQS
     #     the two messages are treated as duplicates and only one copy of the
     #     message is delivered.
     #
-    #   <note markdown="1"> The `MessageDeduplicationId` is available to the recipient of the
+    #   <note markdown="1"> The `MessageDeduplicationId` is available to the consumer of the
     #   message (this can be useful for troubleshooting delivery issues).
     #
     #    If a message is sent successfully but the acknowledgement is lost and
     #   the message is resent with the same `MessageDeduplicationId` after the
     #   deduplication interval, Amazon SQS can't detect duplicate messages.
     #
+    #    Amazon SQS continues to keep track of the message deduplication ID
+    #   even after the message is received and deleted.
+    #
     #    </note>
     #
     #   The length of `MessageDeduplicationId` is 128 characters.
@@ -521,7 +477,7 @@ 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/FIFO-queue-recommendations.html#using-messagededuplicationid-property
+    #   [2]: http://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.
     #
@@ -530,7 +486,7 @@ module Aws::SQS
     #   a FIFO manner (however, messages in different message groups might be
     #   processed out of order). To interleave multiple ordered streams within
     #   a single queue, use `MessageGroupId` values (for example, session data
-    #   for multiple users). In this scenario, multiple readers can process
+    #   for multiple users). In this scenario, multiple consumers can process
     #   the queue, but the session data of each user is processed in a FIFO
     #   fashion.
     #
@@ -541,7 +497,7 @@ 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 are
+    #   The length of `MessageGroupId` is 128 characters. Valid values:
     #   alphanumeric characters and punctuation ``
     #   (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
     #
@@ -554,7 +510,7 @@ module Aws::SQS
     #
     #
     #
-    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property
+    #   [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
     # @return [Types::SendMessageResult]
     def send_message(options = {})
       options = options.merge(queue_url: @url)
@@ -610,17 +566,17 @@ module Aws::SQS
     #
     #   * `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). The default is 0 (zero).
+    #     integer from 0 to 900 (15 minutes). Default: 0.
     #
     #   * `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). The default is
-    #     262,144 (256 KiB).
+    #     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
     #     Amazon SQS retains a message. Valid values: An integer representing
-    #     seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is
-    #     345,600 (4 days).
+    #     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
     #     information about policy structure, see [Overview of AWS IAM
@@ -628,7 +584,7 @@ module Aws::SQS
     #
     #   * `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). The default is 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
@@ -641,7 +597,9 @@ module Aws::SQS
     #       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.
+    #       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
@@ -649,10 +607,11 @@ module Aws::SQS
     #
     #      </note>
     #
-    #   * `VisibilityTimeout` - The visibility timeout for the queue. Valid
-    #     values: an integer from 0 to 43,200 (12 hours). The default is 30.
-    #     For more information about the visibility timeout, see [Visibility
-    #     Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
+    #   * `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]\:
     #
@@ -667,10 +626,10 @@ module Aws::SQS
     #     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
-    #     hours). The default is 300 (5 minutes). A shorter time period
-    #     provides better security but results in more calls to KMS which
-    #     might incur charges after Free Tier. For more information, see [How
-    #     Does the Data Key Reuse Period Work?][8].
+    #     hours). Default: 300 (5 minutes). A shorter time period provides
+    #     better security but results in more calls to KMS which might incur
+    #     charges after Free Tier. For more information, see [How Does the
+    #     Data Key Reuse Period Work?][8].
     #
     #   The following attribute applies only to [FIFO (first-in-first-out)
     #   queues][9]\:
@@ -707,21 +666,6 @@ module Aws::SQS
     #       `MessageDeduplicationId`, the two messages are treated as
     #       duplicates and only one copy of the message is delivered.
     #
-    #   Any other valid special request parameters (such as the following) are
-    #   ignored:
-    #
-    #   * `ApproximateNumberOfMessages`
-    #
-    #   * `ApproximateNumberOfMessagesDelayed`
-    #
-    #   * `ApproximateNumberOfMessagesNotVisible`
-    #
-    #   * `CreatedTimestamp`
-    #
-    #   * `LastModifiedTimestamp`
-    #
-    #   * `QueueArn`
-    #
     #
     #
     #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html

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

@@ -40,7 +40,7 @@ module Aws::SQS
     #
     #   * A FIFO queue name must end with the `.fifo` suffix.
     #
-    #   Queue names are case-sensitive.
+    #   Queue URLs and names are case-sensitive.
     # @option options [Hash<String,String>] :attributes
     #   A map of attributes with their corresponding values.
     #
@@ -49,17 +49,17 @@ module Aws::SQS
     #
     #   * `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 seconds (15 minutes). The default is 0 (zero).
+    #     integer from 0 to 900 seconds (15 minutes). Default: 0.
     #
     #   * `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) to 262,144 bytes (256 KiB). The default is
-    #     262,144 (256 KiB).
+    #     1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
+    #     (256 KiB).
     #
     #   * `MessageRetentionPeriod` - The length of time, in seconds, for which
     #     Amazon SQS retains a message. Valid values: An integer from 60
-    #     seconds (1 minute) to 1,209,600 seconds (14 days). The default is
-    #     345,600 (4 days).
+    #     seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
+    #     (4 days).
     #
     #   * `Policy` - The queue's policy. A valid AWS policy. For more
     #     information about policy structure, see [Overview of AWS IAM
@@ -67,8 +67,7 @@ module Aws::SQS
     #
     #   * `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). The default is 0
-    #     (zero).
+    #     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
@@ -81,7 +80,9 @@ module Aws::SQS
     #       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.
+    #       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
@@ -89,10 +90,11 @@ module Aws::SQS
     #
     #      </note>
     #
-    #   * `VisibilityTimeout` - The visibility timeout for the queue. Valid
-    #     values: An integer from 0 to 43,200 (12 hours). The default is 30.
-    #     For more information about the visibility timeout, see [Visibility
-    #     Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
+    #   * `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]\:
     #
@@ -107,10 +109,10 @@ module Aws::SQS
     #     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
-    #     hours). The default is 300 (5 minutes). A shorter time period
-    #     provides better security but results in more calls to KMS which
-    #     might incur charges after Free Tier. For more information, see [How
-    #     Does the Data Key Reuse Period Work?][8].
+    #     hours). Default: 300 (5 minutes). A shorter time period provides
+    #     better security but results in more calls to KMS which might incur
+    #     charges after Free Tier. For more information, see [How Does the
+    #     Data Key Reuse Period Work?][8].
     #
     #   The following attributes apply only to [FIFO (first-in-first-out)
     #   queues][9]\:
@@ -157,21 +159,6 @@ module Aws::SQS
     #       `MessageDeduplicationId`, the two messages are treated as
     #       duplicates and only one copy of the message is delivered.
     #
-    #   Any other valid special request parameters (such as the following) are
-    #   ignored:
-    #
-    #   * `ApproximateNumberOfMessages`
-    #
-    #   * `ApproximateNumberOfMessagesDelayed`
-    #
-    #   * `ApproximateNumberOfMessagesNotVisible`
-    #
-    #   * `CreatedTimestamp`
-    #
-    #   * `LastModifiedTimestamp`
-    #
-    #   * `QueueArn`
-    #
     #
     #
     #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
@@ -206,7 +193,7 @@ module Aws::SQS
     #   characters. Valid values: alphanumeric characters, hyphens (`-`), and
     #   underscores (`_`).
     #
-    #   Queue names are case-sensitive.
+    #   Queue URLs and 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]
@@ -239,7 +226,7 @@ module Aws::SQS
     #   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.
+    #   Queue URLs and names are case-sensitive.
     # @return [Queue::Collection]
     def queues(options = {})
       batches = Enumerator.new do |y|