AWS SDK Version 3 for .NET
API Reference

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 7 actions.

  • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

Note:

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

Syntax

C#
public virtual AddPermissionResponse AddPermission(
         AddPermissionRequest request
)
Parameters
request
Type: Amazon.SQS.Model.AddPermissionRequest

Container for the necessary parameters to execute the AddPermission service method.

Return Value
The response from the AddPermission service method, as returned by SQS.

Exceptions

ExceptionCondition
OverLimitException The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

Examples

This example shows how to add a permission.

Add permission example

var client = new AmazonSQSClient();

var request = new AddPermissionRequest
{
  Actions = new List<string>() { "GetQueueAttributes", "GetQueueUrl" },
  AWSAccountIds = new List<string>() { "80398EXAMPLE" },
  Label = "JohnDoeCanAccessQueues",
  QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue"
};

client.AddPermission(request);
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also