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.

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 Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.

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:

&Attribute.1=this

&Attribute.2=that

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

C#
public class AddPermissionRequest : AmazonSQSRequest
         IAmazonWebServiceRequest

The AddPermissionRequest type exposes the following members

Constructors

NameDescription
Public Method AddPermissionRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method AddPermissionRequest(string, string, List<String>, List<String>)

Instantiates AddPermissionRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Actions System.Collections.Generic.List<System.String>

Gets and sets the property Actions.

The action the client wants to allow for the specified principal. The following values are valid:

  • *

  • ChangeMessageVisibility

  • DeleteMessage

  • GetQueueAttributes

  • GetQueueUrl

  • ReceiveMessage

  • SendMessage

For more information about these actions, see Understanding Permissions 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.

Public Property AWSAccountIds System.Collections.Generic.List<System.String>

Gets and sets the property AWSAccountIds.

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

Public Property 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 (_).

Public Property QueueUrl System.String

Gets and sets the property QueueUrl.

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs 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() { "GetQueueAttributes", "GetQueueUrl" },
  AWSAccountIds = new List() { "80398EXAMPLE" },
  Label = "JohnDoeCanAccessQueues",
  QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue"
};

client.AddPermission(request);
      

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone