AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Adds a permission to a queue for a specific principal. This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using
Custom Policies with the Amazon SQS Access Policy Language in the Amazon SQS
Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
To remove the ability to change queue permissions, you must deny permission to the
AddPermission, RemovePermission, and SetQueueAttributes actions
in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account principal.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
For .NET Core this operation is only available in asynchronous form. Please refer to AddPermissionAsync.
Namespace: Amazon.SQS
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z
public virtual AddPermissionResponse AddPermission( String queueUrl, String label, List<String> awsAccountIds, List<String> actions )
The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive.
The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
The Amazon Web Services account numbers of the principals who are to receive permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer Guide.
The action the client wants to allow for the specified principal. Valid values: the name of any action or *. For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide. Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
| Exception | Condition |
|---|---|
| InvalidAddressException | The accountId is invalid. |
| InvalidSecurityException | When the request to a queue is not HTTPS and SigV4. |
| OverLimitException | The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of in flight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached. |
| QueueDoesNotExistException | The specified queue doesn't exist. |
| RequestThrottledException | The request was denied due to request throttling. The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region. A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key." Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store. |
| UnsupportedOperationException | Error code 400. Unsupported operation. |
.NET Framework:
Supported in: 4.5 and newer, 3.5