MaxMessages Property

The maximum number of messages retrieved from the queue.

Syntax

 amazonsqs.getMaxMessages([callback])
 amazonsqs.setMaxMessages( maxMessages, [callback])

Default Value

1

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 the getMaxMessages([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setMaxMessages([callback]) 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

The maximum number of messages retrieved by ListMessages. This is not the number of messages that will be returned, but just the maximum number that will be returned.

Amazon's SQS service dictates that this parameter should be between 1 to 10, all other values are illegal.

Data Type

Integer