GetQueueAttributes Method

Returns all attributes of a queue.

Syntax

amazonsqs.getQueueAttributes(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, data){ }

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

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method retrieves all of the attributes of the queue specified by QueueId, and stores them in the Attributes collection. Queues currently have five attributes that may be returned:

• ApproximateNumberOfMessages
• VisibilityTimeout (for more information, see Visibility Timeout)
• CreatedTimestamp
• LastModifiedTimestamp
• Policy

This method returns the RequestId contained in the Amazon response.