AddPermissionRequest Class | AWS SDK for .NET V3

Container for the parameters to the AddPermission operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SQS.AmazonSQSRequest
      Amazon.SQS.Model.AddPermissionRequest

Namespace: Amazon.SQS.Model
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z

Syntax

public class AddPermissionRequest : AmazonSQSRequest
         IAmazonWebServiceRequest

The AddPermissionRequest type exposes the following members

Constructors

	Name	Description
	AddPermissionRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	AddPermissionRequest(string, string, List<String>, List<String>)	Instantiates AddPermissionRequest with the parameterized properties

Properties

Name	Type	Description
Actions	System.Collections.Generic.List<System.String>	Gets and sets the property Actions. 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`.
AWSAccountIds	System.Collections.Generic.List<System.String>	Gets and sets the property AWSAccountIds. 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.
Label	System.String	Gets and sets the property Label. The unique identification of the permission you're setting (for example, `AliceSendMessage`). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (`-`), and underscores (`_`).
QueueUrl	System.String	Gets and sets the property QueueUrl. The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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