class Aws::SQS::Types::ReceiveMessageRequest

@see docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessageRequest AWS API Documentation
@return [String] : docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html [1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html Developer Guide*.
the ReceiveRequestAttemptId Request Parameter] in the *Amazon SQS
For best practices of using ‘ReceiveRequestAttemptId`, see [Using !“#$%&’()*+,-./:;<=>?@^_`{|}~ “).
(‘a-z`, `A-Z`, `0-9`) and punctuation (“
`ReceiveRequestAttemptId` can contain alphanumeric characters
The maximum length of `ReceiveRequestAttemptId` is 128 characters.
the messages in the queue remain in a strict order.
visibility timeout expires. As a result, delays might occur but
`ReceiveRequestAttemptId`, no retries work until the original
* If a caller of `ReceiveMessage` can’t track the
queue as long as they are visible.
receive messages with another ‘MessageGroupId` from your FIFO
returned until the visibility timeout expires. You can still
no more messages belonging to the same `MessageGroupId` are
* While messages with a particular `MessageGroupId` are invisible,
the visibility timeout as necessary.
safe threshold before the visibility timeout expires and extend
To mitigate this effect, ensure that your application observes a
action fails with an error.
visibility timeout tries to delete the processed messages, the
consumer whose message processing time is longer than the
the same messages and therefore process duplicates. Also, if a
visible, another worker consuming from the same queue can receive
messages when the visibility timeout expires and messages become
If a caller of the `ReceiveMessage` action still processes
[Visibility Timeout] in the *Amazon SQS Developer Guide*.
resets the visibility timeout. For more information, see
handles. If a retry occurs within the deduplication interval, it
`ReceiveRequestAttemptId` return the same messages and receipt
* During a visibility timeout, subsequent calls with the same
modified (deleted or had their visibility changes).
`ReceiveRequestAttemptId` if none of the messages have been
* It is possible to retry the `ReceiveMessage` action with the same
can provide a `ReceiveRequestAttemptId` explicitly.
* When you set `FifoQueue`, a caller of the `ReceiveMessage` action
`ReceiveMessage` action.
* You can use `ReceiveRequestAttemptId` only for 5 minutes after a
has not yet expired.
retrieve the same set of messages, even if their visibility timeout
the same action with an identical `ReceiveRequestAttemptId` to
of a response you receive a generic error, it is possible to retry
networking issue occurs after a `ReceiveMessage` action, and instead
The token used for deduplication of `ReceiveMessage` calls. If a
This parameter applies only to FIFO (first-in-first-out) queues.
@!attribute [rw] receive_request_attempt_id
@return [Integer] : sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html [1]: sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html clients.
asynchronous clients, or the [ ApacheHttpClient] for synchronous
transport settings using the [ NettyNioAsyncHttpClient] for
parameter. For example, with the Java SDK, you can set HTTP
`ReceiveMessage` requests is longer than the `WaitTimeSeconds`
To avoid HTTP errors, ensure that the HTTP response timeout for
Null object.
`ReceiveMessageResponse` object, which has a empty list instead of a
message list. If you are using the Java SDK, it returns a
available and the wait time expires, the call does not return a
call returns sooner than `WaitTimeSeconds`. If no messages are
arrive in the queue before returning. If a message is available, the
The duration (in seconds) for which the call waits for a message to
@!attribute [rw] wait_time_seconds
@return [Integer] : docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html Developer Guide*.
For more information, see [Visibility Timeout] in the *Amazon SQS
might be sent to the dead-letter queue.
receive. Depending on the configuration of the queue, the message
extended before the visibility timeout expires counts as a failed
* A message that isn’t deleted or a message whose visibility isn’t
to match the processing time required by your application.
‘–visibility-timeout` parameter in the `receive-message` command
* You can adjust the visibility timeout using the
fails.
delays the reprocessing of messages if the initial processing
complete, leading to duplicate processing. If it’s too long, it
short, the message might become visible again before processing is
* Setting an appropriate visibility timeout is crucial. If it’s too
becomes visible again and can be retrieved by other consumers.
visibility timeout is not extended before the timeout expires, it
message simultaneously. If the message is not deleted or its
timeout. This prevents multiple consumers from processing the same
invisible to other consumers for the duration of the visibility
* When a message is received from a queue, it becomes temporarily
Understanding ‘VisibilityTimeout`:
timeout for the queue is used, which is 30 seconds.
`ReceiveMessage` request. If not specified, the default visibility
subsequent retrieve requests after being retrieved by a
The duration (in seconds) that the received messages are hidden from
@!attribute [rw] visibility_timeout
@return [Integer]
returned). Valid values: 1 to 10. Default: 1.
more messages than this value (however, fewer messages might be
The maximum number of messages to return. Amazon SQS never returns
@!attribute [rw] max_number_of_messages
@return [Array<String>]
attributes starting with a prefix, for example `bar.*`.
`All` or `.*` in your request. You can also use all message
to receive, or you can return all of the attributes by specifying
When using `ReceiveMessage`, you can send a list of attribute names
* The name can be up to 256 characters long.
not have periods in succession (`..`).
* The name must not start or end with a period (`.`), and it should
or `Amazon.` (or any casing variants).
* The name must not start with AWS-reserved prefixes such as `AWS.`
names for the message.
* The name is case-sensitive and must be unique among all attribute
(`_`), hyphen (`-`), and period (`.`).
* The name can contain alphanumeric characters and the underscore
The name of the message attribute, where N is the index.
@!attribute [rw] message_attribute_names
@return [Array<String>] : docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html [1]: en.wikipedia.org/wiki/Unix_time * `SequenceNumber` – Returns the value provided by Amazon SQS.
calls the ` SendMessage ` action.
* `MessageGroupId` – Returns the value provided by the producer that
producer that calls the ` SendMessage ` action.
* `MessageDeduplicationId` – Returns the value provided by the [3]).
option is supported per queue (for example, [SSE-KMS] or
using SQS owned encryption keys. Only one server-side encryption
* `SqsManagedSseEnabled` – Enables server-side queue encryption
queue ([epoch time] in milliseconds).
* `SentTimestamp` – Returns the time the message was sent to the
`ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
* For an IAM role, returns the IAM role ID, for example
`ABCDEFGHI1JKLMNOPQ23R`.
* For a user, returns the user ID, for example
* `SenderId`
* `AWSTraceHeader` – Returns the X-Ray trace header string.
has been received across all queues but not deleted.
* `ApproximateReceiveCount` – Returns the number of times a message
milliseconds).
was first received from the queue ([epoch time] in
* `ApproximateFirstReceiveTimestamp` – Returns the time the message
* `All` – Returns all values.
message. These attributes include:
A list of attributes that need to be returned along with each
@!attribute [rw] message_system_attribute_names
@return [Array<String>] : docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html [1]: en.wikipedia.org/wiki/Unix_time * `SequenceNumber` – Returns the value provided by Amazon SQS.
calls the ` SendMessage ` action.
* `MessageGroupId` – Returns the value provided by the producer that
producer that calls the ` SendMessage ` action.
* `MessageDeduplicationId` – Returns the value provided by the [3]).
option is supported per queue (for example, [SSE-KMS] or
using SQS owned encryption keys. Only one server-side encryption
* `SqsManagedSseEnabled` – Enables server-side queue encryption
queue ([epoch time] in milliseconds).
* `SentTimestamp` – Returns the time the message was sent to the
`ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
* For an IAM role, returns the IAM role ID, for example
`ABCDEFGHI1JKLMNOPQ23R`.
* For a user, returns the user ID, for example
* `SenderId`
* `AWSTraceHeader` – Returns the X-Ray trace header string.
has been received across all queues but not deleted.
* `ApproximateReceiveCount` – Returns the number of times a message
milliseconds).
was first received from the queue ([epoch time] in
* `ApproximateFirstReceiveTimestamp` – Returns the time the message
* `All` – Returns all values.
message. These attributes include:
A list of attributes that need to be returned along with each
encouraged to use `MessageSystemAttributeNames`.
backward compatibility. To provide attribute names, you are
This parameter has been discontinued but will be supported for
@!attribute [rw] attribute_names
@return [String]
Queue URLs and names are case-sensitive.
The URL of the Amazon SQS queue from which messages are received.
@!attribute [rw] queue_url
Retrieves one or more messages from a specified queue.

class Aws::SQS::Types::ReceiveMessageRequest

Namespace

Included Modules

Defined in