AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Retrieves one or more messages (up to 10), from the specified queue. Using the
parameter enables long-poll support. For more information, see Amazon
SQS Long Polling in the Amazon Simple Queue Service Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled
ReceiveMessage call. Thus, 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
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.
MessageId you 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 Simple Queue Service 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. For more information, see Visibility
Timeout in the Amazon Simple Queue Service Developer Guide.
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.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginReceiveMessage and EndReceiveMessage. For Unity the operation does not take CancellationToken as a parameter, and instead takes AmazonServiceCallback<ReceiveMessageRequest, ReceiveMessageResponse> and AsyncOptions as additional parameters.
public abstract Task<ReceiveMessageResponse> ReceiveMessageAsync( String queueUrl, CancellationToken cancellationToken )
The URL of the Amazon SQS queue from which messages are received. Queue URLs are case-sensitive.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
|OverLimitException||The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.|
Supported in: 1.3
Supported in: 4.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone