Retrieves one or more messages from the queue specified, including the message body and message ID of each message. Messages returned by this action stay in the queue until deleted. However, once a message is returned to a ReceiveMessage request, it will not be returned on subsequent ReceiveMessage requests until the duration of the VisibilityTimeout has passed. See SetVisibilityTimeout for more information.
Note: | To view a message without locking it, in other words, without affecting the visibility state, use PeekMessage. |
Note: | Due to the distributed nature of the queue, a weighted random set of machines is sampled on a |
ReceiveMessage action requests are validated on the following:
The queue specified must exist. The URL to the queue must have been returned by a CreateQueue or ListQueues request.
VisibilityTimeout, if used, must be an integer between 0 and 86400.
NumberOfMessages, if used, must be an integer between 1 and 256.
If successful, returns Success and the message ID and message body of each available message (those not restricted by the visibility timeout setting). It returns an error response if unsuccessful.
| Name | Description | Type | Value |
|---|---|---|---|
NumberOfMessages | Optional. Specifies the maximum number of messages to return. If the number of messages in the queue is less than value specified by NumberOfMessages, the number of messages returned is up to the number of messages in the queue. Not necessarily all the messages in the queue will be returned. If no value is provided, the default value of 1 is used. | Integer | An integer from 1 to 256. |
VisibilityTimeout | Optional. The duration, in seconds, that the returned messages are hidden from subsequent receive requests after being received. If no value is specified, the visibility timeout for the queue is used for the returned messages. The queue's visibility timeout value is set using CreateQueue or SetVisibilityTimeout. See SetVisibilityTimeout for more information.
| Integer | 0 to 86400 seconds (maximum 24 hours) |
<soap:Body wsu:Id="body" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <m:ReceiveMessage xmlns:m="http://queue.amazonaws.com/doc/2006-01-01/"> </m:ReceiveMessage> </soap:Body>
<ReceiveMessageResponse>
<Messages>
<MessageId>
17VXQHSGX0SG4ZEPPK7R|0QE42ST4KW7RK9HSY074|0Z4AN912X0H2EP8BV6XJ
</MessageId>
<MessageBody>foo</MessageBody>
</Messages>
<ResponseStatus>
<StatusCode>Success</StatusCode>
<RequestId>cb919c0a-9bce-4afe-9b48-9bdf2412bb67</RequestId>
</ResponseStatus>
</ReceiveMessageResponse>