Class: Aws::SQS::Queue

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-sqs/queue.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, options = {}) ⇒ Queue #initialize(options = {}) ⇒ Queue

Returns a new instance of Queue.

Overloads:

  • #initialize(url, options = {}) ⇒ Queue

    Parameters:

    • url (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Queue

    Options Hash (options):

    • :url (required, String)
    • :client (Client)

22
23
24
25
26
27
28
# File 'lib/aws-sdk-sqs/queue.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @url = extract_url(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#add_permission(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


queue.add_permission({
  label: "String", # required
  aws_account_ids: ["String"], # required
  actions: ["String"], # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)

124
125
126
127
128
# File 'lib/aws-sdk-sqs/queue.rb', line 124

def add_permission(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.add_permission(options)
  resp.data
end

#attributesHash<String,String>

A map of attributes to their respective values.

Returns:

  • (Hash<String,String>)

39
40
41
# File 'lib/aws-sdk-sqs/queue.rb', line 39

def attributes
  data[:attributes]
end

#change_message_visibility_batch(options = {}) ⇒ Types::ChangeMessageVisibilityBatchResult

Examples:

Request syntax with placeholder values


queue.change_message_visibility_batch({
  entries: [ # required
    {
      id: "String", # required
      receipt_handle: "String", # required
      visibility_timeout: 1,
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:


146
147
148
149
150
# File 'lib/aws-sdk-sqs/queue.rb', line 146

def change_message_visibility_batch(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.change_message_visibility_batch(options)
  resp.data
end

#clientClient

Returns:


46
47
48
# File 'lib/aws-sdk-sqs/queue.rb', line 46

def client
  @client
end

#dataTypes::GetQueueAttributesResult

Returns the data for this Aws::SQS::Queue. Calls Client#get_queue_attributes if #data_loaded? is `false`.

Returns:


69
70
71
72
# File 'lib/aws-sdk-sqs/queue.rb', line 69

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns `true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns `true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.


77
78
79
# File 'lib/aws-sdk-sqs/queue.rb', line 77

def data_loaded?
  !!@data
end

#dead_letter_source_queues(options = {}) ⇒ Queue::Collection

Examples:

Request syntax with placeholder values


queue.dead_letter_source_queues()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
# File 'lib/aws-sdk-sqs/queue.rb', line 779

def dead_letter_source_queues(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(queue_url: @url)
    resp = @client.list_dead_letter_source_queues(options)
    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
  end
  Queue::Collection.new(batches)
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


queue.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)

157
158
159
160
161
# File 'lib/aws-sdk-sqs/queue.rb', line 157

def delete(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.delete_queue(options)
  resp.data
end

#delete_messages(options = {}) ⇒ Types::DeleteMessageBatchResult

Examples:

Request syntax with placeholder values


queue.delete_messages({
  entries: [ # required
    {
      id: "String", # required
      receipt_handle: "String", # required
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:


177
178
179
180
181
# File 'lib/aws-sdk-sqs/queue.rb', line 177

def delete_messages(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.delete_message_batch(options)
  resp.data
end

#identifiersObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

809
810
811
# File 'lib/aws-sdk-sqs/queue.rb', line 809

def identifiers
  { url: @url }
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::SQS::Queue. Returns `self` making it possible to chain methods.

queue.reload.data

Returns:

  • (self)

56
57
58
59
60
61
62
63
# File 'lib/aws-sdk-sqs/queue.rb', line 56

def load
  resp = @client.get_queue_attributes(
    queue_url: @url,
    attribute_names: ["All"]
  )
  @data = resp.data
  self
end

#message(receipt_handle) ⇒ Message

Parameters:

  • receipt_handle (String)

Returns:


799
800
801
802
803
804
805
# File 'lib/aws-sdk-sqs/queue.rb', line 799

def message(receipt_handle)
  Message.new(
    queue_url: @url,
    receipt_handle: receipt_handle,
    client: @client
  )
end

#purge(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


queue.purge()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)

188
189
190
191
192
# File 'lib/aws-sdk-sqs/queue.rb', line 188

def purge(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.purge_queue(options)
  resp.data
end

#receive_messages(options = {}) ⇒ Message::Collection

Examples:

Request syntax with placeholder values


message = queue.receive_messages({
  attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
  message_attribute_names: ["MessageAttributeName"],
  max_number_of_messages: 1,
  visibility_timeout: 1,
  wait_time_seconds: 1,
  receive_request_attempt_id: "String",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :attribute_names (Array<String>)

    A list of attributes that need to be returned along with each message. These attributes include:

    • `All` – Returns all values.

    • `ApproximateFirstReceiveTimestamp` – Returns the time the message was first received from the queue ([epoch time] in milliseconds).

    • `ApproximateReceiveCount` – Returns the number of times a message has been received across all queues but not deleted.

    • `AWSTraceHeader` – Returns the X-Ray trace header string.

    • `SenderId`

      • For an IAM user, returns the IAM user ID, for example `ABCDEFGHI1JKLMNOPQ23R`.

      • 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 ([epoch time] in milliseconds).

    • `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] or [SSE-SQS]).

    • `MessageDeduplicationId` – Returns the value provided by the producer that calls the ` SendMessage ` action.

    • `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.

    [1]: en.wikipedia.org/wiki/Unix_time [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html [3]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html

  • :message_attribute_names (Array<String>)

    The name of the message attribute, where N is the index.

    • The name can contain alphanumeric characters and the underscore (`_`), hyphen (`-`), and period (`.`).

    • The name is case-sensitive and must be unique among all attribute names for the message.

    • The name must not start with AWS-reserved prefixes such as `AWS.` or `Amazon.` (or any casing variants).

    • The name must not start or end with a period (`.`), and it should not have periods in succession (`..`).

    • The name can be up to 256 characters long.

    When using `ReceiveMessage`, you can send a list of attribute names to receive, or you can return all of the attributes by specifying `All` or `.*` in your request. You can also use all message attributes starting with a prefix, for example `bar.*`.

  • :max_number_of_messages (Integer)

    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

  • :visibility_timeout (Integer)

    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a `ReceiveMessage` request.

  • :wait_time_seconds (Integer)

    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the 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] for asynchronous clients, or the [ ApacheHttpClient] for synchronous clients.

    [1]: sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html [2]: sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html

  • :receive_request_attempt_id (String)

    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, 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 `ReceiveMessage` action.

    • When you set `FifoQueue`, a caller of the `ReceiveMessage` action can provide a `ReceiveRequestAttemptId` explicitly.

    • If a caller of the `ReceiveMessage` action doesn't provide a `ReceiveRequestAttemptId`, Amazon SQS generates a `ReceiveRequestAttemptId`.

    • 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).

    • During a visibility timeout, subsequent calls with the same `ReceiveRequestAttemptId` return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see [Visibility Timeout] in the *Amazon SQS Developer Guide*.

      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 visibility timeout as necessary.

    • While messages with a particular `MessageGroupId` are invisible, no more messages belonging to the same `MessageGroupId` are returned until the visibility timeout expires. You can still receive messages with another `MessageGroupId` as long as it is also visible.

    • If a caller of `ReceiveMessage` can't track the `ReceiveRequestAttemptId`, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

    The maximum length of `ReceiveRequestAttemptId` is 128 characters. `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`, `A-Z`, `0-9`) and punctuation (“ !“#$%&'()*+,-./:;<=>[email protected][]^_`{|}~ “).

    For best practices of using `ReceiveRequestAttemptId`, see [Using the ReceiveRequestAttemptId Request Parameter] in the *Amazon SQS Developer Guide*.

    [1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html

Returns:


359
360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/aws-sdk-sqs/queue.rb', line 359

def receive_messages(options = {})
  batch = []
  options = options.merge(queue_url: @url)
  resp = @client.receive_message(options)
  resp.data.messages.each do |m|
    batch << Message.new(
      queue_url: @url,
      receipt_handle: m.receipt_handle,
      data: m,
      client: @client
    )
  end
  Message::Collection.new([batch], size: batch.size)
end

#remove_permission(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


queue.remove_permission({
  label: "String", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :label (required, String)

    The identification of the permission to remove. This is the label added using the ` AddPermission ` action.

Returns:

  • (EmptyStructure)

384
385
386
387
388
# File 'lib/aws-sdk-sqs/queue.rb', line 384

def remove_permission(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.remove_permission(options)
  resp.data
end

#send_message(options = {}) ⇒ Types::SendMessageResult

Examples:

Request syntax with placeholder values


queue.send_message({
  message_body: "String", # required
  delay_seconds: 1,
  message_attributes: {
    "String" => {
      string_value: "String",
      binary_value: "data",
      string_list_values: ["String"],
      binary_list_values: ["data"],
      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",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :message_body (required, String)

    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:

    `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
    

    | `#x10000` to `#x10FFFF`

    Any characters not included in this list will be rejected. For more
    

    information, see the [W3C specification for characters].

    [1]: www.w3.org/TR/REC-xml/#charsets

  • :delay_seconds (Integer)

    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive `DelaySeconds` value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

    <note markdown=“1”> When you set `FifoQueue`, you can't set `DelaySeconds` per message. You can set this parameter only on a queue level.

    </note>
    
  • :message_attributes (Hash<String,Types::MessageAttributeValue>)

    Each message attribute consists of a `Name`, `Type`, and `Value`. For more information, see [Amazon SQS message attributes] in the *Amazon SQS Developer Guide*.

    [1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes

  • :message_system_attributes (Hash<String,Types::MessageSystemAttributeValue>)

    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 X-Ray trace header string.

    • The size of a message system attribute doesn't count towards the total size of a message.

  • :message_deduplication_id (String)

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of sent messages. If a message with a particular `MessageDeduplicationId` is sent successfully, any messages sent with the same `MessageDeduplicationId` are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see [ Exactly-once processing] 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.

    • 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.

    <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 maximum length of `MessageDeduplicationId` is 128 characters. `MessageDeduplicationId` can contain alphanumeric characters (`a-z`, `A-Z`, `0-9`) and punctuation (“ !“#$%&'()*+,-./:;<=>[email protected][]^_`{|}~ “).

    For best practices of using `MessageDeduplicationId`, see [Using the MessageDeduplicationId Property] in the *Amazon SQS Developer Guide*.

    [1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html

  • :message_group_id (String)

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in 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 consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty `MessageGroupId` with a message. If you don't provide a `MessageGroupId`, the action fails.

    • `ReceiveMessage` might return messages with multiple `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: alphanumeric characters and punctuation “ (!“#$%&'()*+,-./:;<=>[email protected][]^_`{|}~) “.

    For best practices of using `MessageGroupId`, see [Using the MessageGroupId Property] in the *Amazon SQS Developer Guide*.

    `MessageGroupId` is required for FIFO queues. You can't use it for Standard queues.

    [1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html

Returns:


556
557
558
559
560
# File 'lib/aws-sdk-sqs/queue.rb', line 556

def send_message(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.send_message(options)
  resp.data
end

#send_messages(options = {}) ⇒ Types::SendMessageBatchResult

Examples:

Request syntax with placeholder values


queue.send_messages({
  entries: [ # required
    {
      id: "String", # required
      message_body: "String", # required
      delay_seconds: 1,
      message_attributes: {
        "String" => {
          string_value: "String",
          binary_value: "data",
          string_list_values: ["String"],
          binary_list_values: ["data"],
          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",
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:


597
598
599
600
601
# File 'lib/aws-sdk-sqs/queue.rb', line 597

def send_messages(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.send_message_batch(options)
  resp.data
end

#set_attributes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


queue.set_attributes({
  attributes: { # required
    "All" => "String",
  },
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

Returns:

  • (EmptyStructure)

766
767
768
769
770
# File 'lib/aws-sdk-sqs/queue.rb', line 766

def set_attributes(options = {})
  options = options.merge(queue_url: @url)
  resp = @client.set_queue_attributes(options)
  resp.data
end

#urlString

Returns:

  • (String)

33
34
35
# File 'lib/aws-sdk-sqs/queue.rb', line 33

def url
  @url
end