AddPermission Method

Adds a permission to a queue for a specific account, which allows for sharing access to the queue.

Syntax

amazonsqs.addPermission(queueId, userLabel, amazonAccount, permissionName, [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 adds a permission to the queue specified by QueueId for the user account specified by AmazonAccount. UserLabel is the unique identification of the permission you're granting, and is used when deleting the permission via the RemovePermission method. The current list of values you may pass in the PermissionName parameter are listed below:

• SendMessage
• ReceiveMessage
• DeleteMessage
• ChangeMessageVisibility
• GetQueueAttributes

Note that when you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue.

AddPermission writes an SQS-generated policy. If you want to write your own policy, use SetQueueAttribute to upload your policy.

This method returns the RequestId contained in the Amazon response.