ReceiveMessageRequest
Retrieves one or more messages from a specified queue.
Types
Properties
This parameter has been discontinued but will be supported for backward compatibility. To provide attribute names, you are encouraged to use MessageSystemAttributeNames
.
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.
The name of the message attribute, where N is the index.
A list of attributes that need to be returned along with each message. These attributes include:
This parameter applies only to FIFO (first-in-first-out) queues.
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.
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.