AddPermission Method

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

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* AddPermission(const char* lpszQueueId, const char* lpszUserLabel, const char* lpszAmazonAccount, const char* lpszPermissionName);

Unicode (Windows)
LPWSTR AddPermission(LPCWSTR lpszQueueId, LPCWSTR lpszUserLabel, LPCWSTR lpszAmazonAccount, LPCWSTR lpszPermissionName);

- (NSString*)addPermission:(NSString*)queueId :(NSString*)userLabel :(NSString*)amazonAccount :(NSString*)permissionName;

#define MID_AMAZONSQS_ADDPERMISSION 2

IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_AmazonSQS_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.