ListMessages Method

Gets messages from the queue.

Syntax

sqs.listMessages(queueId, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method retrieves messages from the queue specified by QueueId, and fires a Message event for each message it receives. The messages may also be accessed using the property Messages.

If VisibilityTimeout is specified it is updated for the messages, otherwise the default timeout of the queue used. Also only one message is retrieved by default, this behavior may be modified by MaxMessages.