QueueMarker Property

A string value that identifies the current position in the list of results.

Syntax

 queue.getQueueMarker([callback])
 queue.setQueueMarker( queueMarker, [callback])

Default Value

""

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 getQueueMarker([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 setQueueMarker([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

This property holds a marker that identifies the current position in the results. When ListQueues is called, if there are more than MaxResults results, this property will be populated with the marker identifying the position in the results. Subsequent calls to ListQueues will return the next portion of results.

If this property contains a value, there are additional results and ListQueues should be called again.

This property is not available at design time.

Data Type

String