pub struct ReceiveMessageFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to ReceiveMessage.
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Therefore, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
-
The message body.
-
An MD5 digest of the message body. For information about MD5, see RFC1321.
-
The
MessageIdyou received when you sent the message to the queue. -
The receipt handle.
-
The message attributes.
-
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. The default visibility timeout for a queue is 30 seconds.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Implementations§
Source§impl ReceiveMessageFluentBuilder
impl ReceiveMessageFluentBuilder
Sourcepub fn as_input(&self) -> &ReceiveMessageInputBuilder
pub fn as_input(&self) -> &ReceiveMessageInputBuilder
Access the ReceiveMessage as a reference.
Sourcepub async fn send(
self,
) -> Result<ReceiveMessageOutput, SdkError<ReceiveMessageError, HttpResponse>>
pub async fn send( self, ) -> Result<ReceiveMessageOutput, SdkError<ReceiveMessageError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<ReceiveMessageOutput, ReceiveMessageError, Self>
pub fn customize( self, ) -> CustomizableOperation<ReceiveMessageOutput, ReceiveMessageError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn queue_url(self, input: impl Into<String>) -> Self
pub fn queue_url(self, input: impl Into<String>) -> Self
The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
Sourcepub fn set_queue_url(self, input: Option<String>) -> Self
pub fn set_queue_url(self, input: Option<String>) -> Self
The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
Sourcepub fn get_queue_url(&self) -> &Option<String>
pub fn get_queue_url(&self) -> &Option<String>
The URL of the Amazon SQS queue from which messages are received.
Queue URLs and names are case-sensitive.
Sourcepub fn attribute_names(self, input: QueueAttributeName) -> Self
👎Deprecated: AttributeNames has been replaced by MessageSystemAttributeNames
pub fn attribute_names(self, input: QueueAttributeName) -> Self
Appends an item to AttributeNames.
To override the contents of this collection use set_attribute_names.
This parameter has been discontinued but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames.
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 a user, returns the 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 (for example, SSE-KMS or SSE-SQS). -
MessageDeduplicationId– Returns the value provided by the producer that calls theaction.SendMessage -
MessageGroupId– Returns the value provided by the producer that calls theaction.SendMessage -
SequenceNumber– Returns the value provided by Amazon SQS.
Sourcepub fn set_attribute_names(self, input: Option<Vec<QueueAttributeName>>) -> Self
👎Deprecated: AttributeNames has been replaced by MessageSystemAttributeNames
pub fn set_attribute_names(self, input: Option<Vec<QueueAttributeName>>) -> Self
This parameter has been discontinued but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames.
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 a user, returns the 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 (for example, SSE-KMS or SSE-SQS). -
MessageDeduplicationId– Returns the value provided by the producer that calls theaction.SendMessage -
MessageGroupId– Returns the value provided by the producer that calls theaction.SendMessage -
SequenceNumber– Returns the value provided by Amazon SQS.
Sourcepub fn get_attribute_names(&self) -> &Option<Vec<QueueAttributeName>>
👎Deprecated: AttributeNames has been replaced by MessageSystemAttributeNames
pub fn get_attribute_names(&self) -> &Option<Vec<QueueAttributeName>>
This parameter has been discontinued but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames.
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 a user, returns the 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 (for example, SSE-KMS or SSE-SQS). -
MessageDeduplicationId– Returns the value provided by the producer that calls theaction.SendMessage -
MessageGroupId– Returns the value provided by the producer that calls theaction.SendMessage -
SequenceNumber– Returns the value provided by Amazon SQS.
Sourcepub fn message_system_attribute_names(
self,
input: MessageSystemAttributeName,
) -> Self
pub fn message_system_attribute_names( self, input: MessageSystemAttributeName, ) -> Self
Appends an item to MessageSystemAttributeNames.
To override the contents of this collection use set_message_system_attribute_names.
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 a user, returns the 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 (for example, SSE-KMS or SSE-SQS). -
MessageDeduplicationId– Returns the value provided by the producer that calls theaction.SendMessage -
MessageGroupId– Returns the value provided by the producer that calls theaction.SendMessage -
SequenceNumber– Returns the value provided by Amazon SQS.
Sourcepub fn set_message_system_attribute_names(
self,
input: Option<Vec<MessageSystemAttributeName>>,
) -> Self
pub fn set_message_system_attribute_names( self, input: Option<Vec<MessageSystemAttributeName>>, ) -> Self
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 a user, returns the 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 (for example, SSE-KMS or SSE-SQS). -
MessageDeduplicationId– Returns the value provided by the producer that calls theaction.SendMessage -
MessageGroupId– Returns the value provided by the producer that calls theaction.SendMessage -
SequenceNumber– Returns the value provided by Amazon SQS.
Sourcepub fn get_message_system_attribute_names(
&self,
) -> &Option<Vec<MessageSystemAttributeName>>
pub fn get_message_system_attribute_names( &self, ) -> &Option<Vec<MessageSystemAttributeName>>
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 a user, returns the 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 (for example, SSE-KMS or SSE-SQS). -
MessageDeduplicationId– Returns the value provided by the producer that calls theaction.SendMessage -
MessageGroupId– Returns the value provided by the producer that calls theaction.SendMessage -
SequenceNumber– Returns the value provided by Amazon SQS.
Sourcepub fn message_attribute_names(self, input: impl Into<String>) -> Self
pub fn message_attribute_names(self, input: impl Into<String>) -> Self
Appends an item to MessageAttributeNames.
To override the contents of this collection use set_message_attribute_names.
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.orAmazon.(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.*.
Sourcepub fn set_message_attribute_names(self, input: Option<Vec<String>>) -> Self
pub fn set_message_attribute_names(self, input: Option<Vec<String>>) -> Self
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.orAmazon.(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.*.
Sourcepub fn get_message_attribute_names(&self) -> &Option<Vec<String>>
pub fn get_message_attribute_names(&self) -> &Option<Vec<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.orAmazon.(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.*.
Sourcepub fn max_number_of_messages(self, input: i32) -> Self
pub fn max_number_of_messages(self, input: i32) -> Self
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.
Sourcepub fn set_max_number_of_messages(self, input: Option<i32>) -> Self
pub fn set_max_number_of_messages(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_max_number_of_messages(&self) -> &Option<i32>
pub fn get_max_number_of_messages(&self) -> &Option<i32>
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.
Sourcepub fn visibility_timeout(self, input: i32) -> Self
pub fn visibility_timeout(self, input: i32) -> Self
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. If not specified, the default visibility timeout for the queue is used, which is 30 seconds.
Understanding VisibilityTimeout:
-
When a message is received from a queue, it becomes temporarily invisible to other consumers for the duration of the visibility timeout. This prevents multiple consumers from processing the same message simultaneously. If the message is not deleted or its visibility timeout is not extended before the timeout expires, it becomes visible again and can be retrieved by other consumers.
-
Setting an appropriate visibility timeout is crucial. If it's too short, the message might become visible again before processing is complete, leading to duplicate processing. If it's too long, it delays the reprocessing of messages if the initial processing fails.
-
You can adjust the visibility timeout using the
--visibility-timeoutparameter in thereceive-messagecommand to match the processing time required by your application. -
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
Sourcepub fn set_visibility_timeout(self, input: Option<i32>) -> Self
pub fn set_visibility_timeout(self, input: Option<i32>) -> Self
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. If not specified, the default visibility timeout for the queue is used, which is 30 seconds.
Understanding VisibilityTimeout:
-
When a message is received from a queue, it becomes temporarily invisible to other consumers for the duration of the visibility timeout. This prevents multiple consumers from processing the same message simultaneously. If the message is not deleted or its visibility timeout is not extended before the timeout expires, it becomes visible again and can be retrieved by other consumers.
-
Setting an appropriate visibility timeout is crucial. If it's too short, the message might become visible again before processing is complete, leading to duplicate processing. If it's too long, it delays the reprocessing of messages if the initial processing fails.
-
You can adjust the visibility timeout using the
--visibility-timeoutparameter in thereceive-messagecommand to match the processing time required by your application. -
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
Sourcepub fn get_visibility_timeout(&self) -> &Option<i32>
pub fn get_visibility_timeout(&self) -> &Option<i32>
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. If not specified, the default visibility timeout for the queue is used, which is 30 seconds.
Understanding VisibilityTimeout:
-
When a message is received from a queue, it becomes temporarily invisible to other consumers for the duration of the visibility timeout. This prevents multiple consumers from processing the same message simultaneously. If the message is not deleted or its visibility timeout is not extended before the timeout expires, it becomes visible again and can be retrieved by other consumers.
-
Setting an appropriate visibility timeout is crucial. If it's too short, the message might become visible again before processing is complete, leading to duplicate processing. If it's too long, it delays the reprocessing of messages if the initial processing fails.
-
You can adjust the visibility timeout using the
--visibility-timeoutparameter in thereceive-messagecommand to match the processing time required by your application. -
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
Sourcepub fn wait_time_seconds(self, input: i32) -> Self
pub fn wait_time_seconds(self, input: i32) -> Self
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 does not return a message list. If you are using the Java SDK, it returns a ReceiveMessageResponse object, which has a empty list instead of a Null object.
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.
Sourcepub fn set_wait_time_seconds(self, input: Option<i32>) -> Self
pub fn set_wait_time_seconds(self, input: Option<i32>) -> Self
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 does not return a message list. If you are using the Java SDK, it returns a ReceiveMessageResponse object, which has a empty list instead of a Null object.
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.
Sourcepub fn get_wait_time_seconds(&self) -> &Option<i32>
pub fn get_wait_time_seconds(&self) -> &Option<i32>
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 does not return a message list. If you are using the Java SDK, it returns a ReceiveMessageResponse object, which has a empty list instead of a Null object.
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.
Sourcepub fn receive_request_attempt_id(self, input: impl Into<String>) -> Self
pub fn receive_request_attempt_id(self, input: impl Into<String>) -> Self
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
ReceiveRequestAttemptIdonly for 5 minutes after aReceiveMessageaction. -
When you set
FifoQueue, a caller of theReceiveMessageaction can provide aReceiveRequestAttemptIdexplicitly. -
It is possible to retry the
ReceiveMessageaction with the sameReceiveRequestAttemptIdif none of the messages have been modified (deleted or had their visibility changes). -
During a visibility timeout, subsequent calls with the same
ReceiveRequestAttemptIdreturn 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
ReceiveMessageaction 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
MessageGroupIdare invisible, no more messages belonging to the sameMessageGroupIdare returned until the visibility timeout expires. You can still receive messages with anotherMessageGroupIdfrom your FIFO queue as long as they are visible. -
If a caller of
ReceiveMessagecan't track theReceiveRequestAttemptId, 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 (!"#$%&'()*+,-./:;<=>?@\[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.
Sourcepub fn set_receive_request_attempt_id(self, input: Option<String>) -> Self
pub fn set_receive_request_attempt_id(self, input: Option<String>) -> Self
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
ReceiveRequestAttemptIdonly for 5 minutes after aReceiveMessageaction. -
When you set
FifoQueue, a caller of theReceiveMessageaction can provide aReceiveRequestAttemptIdexplicitly. -
It is possible to retry the
ReceiveMessageaction with the sameReceiveRequestAttemptIdif none of the messages have been modified (deleted or had their visibility changes). -
During a visibility timeout, subsequent calls with the same
ReceiveRequestAttemptIdreturn 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
ReceiveMessageaction 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
MessageGroupIdare invisible, no more messages belonging to the sameMessageGroupIdare returned until the visibility timeout expires. You can still receive messages with anotherMessageGroupIdfrom your FIFO queue as long as they are visible. -
If a caller of
ReceiveMessagecan't track theReceiveRequestAttemptId, 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 (!"#$%&'()*+,-./:;<=>?@\[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.
Sourcepub fn get_receive_request_attempt_id(&self) -> &Option<String>
pub fn get_receive_request_attempt_id(&self) -> &Option<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
ReceiveRequestAttemptIdonly for 5 minutes after aReceiveMessageaction. -
When you set
FifoQueue, a caller of theReceiveMessageaction can provide aReceiveRequestAttemptIdexplicitly. -
It is possible to retry the
ReceiveMessageaction with the sameReceiveRequestAttemptIdif none of the messages have been modified (deleted or had their visibility changes). -
During a visibility timeout, subsequent calls with the same
ReceiveRequestAttemptIdreturn 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
ReceiveMessageaction 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
MessageGroupIdare invisible, no more messages belonging to the sameMessageGroupIdare returned until the visibility timeout expires. You can still receive messages with anotherMessageGroupIdfrom your FIFO queue as long as they are visible. -
If a caller of
ReceiveMessagecan't track theReceiveRequestAttemptId, 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 (!"#$%&'()*+,-./:;<=>?@\[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS Developer Guide.
Trait Implementations§
Source§impl Clone for ReceiveMessageFluentBuilder
impl Clone for ReceiveMessageFluentBuilder
Source§fn clone(&self) -> ReceiveMessageFluentBuilder
fn clone(&self) -> ReceiveMessageFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for ReceiveMessageFluentBuilder
impl !RefUnwindSafe for ReceiveMessageFluentBuilder
impl Send for ReceiveMessageFluentBuilder
impl Sync for ReceiveMessageFluentBuilder
impl Unpin for ReceiveMessageFluentBuilder
impl !UnwindSafe for ReceiveMessageFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);