Amazon.SQS.AmazonSQSClient.AddPermissionAsync C# (CSharp) Method

AmazonSQSClient Class Documentation Show file Open project: aws/aws-sdk-net

AddPermissionAsync() public method

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

/// The action that you requested would violate a limit. For example, ReceiveMessage /// returns this error if the maximum number of inflight messages is reached.

 AddPermission
///

returns this error if the maximum number of permissions for the queue is reached. ///

public AddPermissionAsync ( string queueUrl, string label, List awsAccountIds, List actions, System cancellationToken = default(CancellationToken) ) : Task
queueUrl	string	The URL of the Amazon SQS queue to which permissions are added. Queue URLs are case-sensitive.
label	string	The unique identification of the permission you're setting (for example, `AliceSendMessage`). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (`-`), and underscores (`_`).
awsAccountIds	List	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.
actions	List	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`.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

        public Task<AddPermissionResponse> AddPermissionAsync(string queueUrl, string label, List<string> awsAccountIds, List<string> actions, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var request = new AddPermissionRequest();
            request.QueueUrl = queueUrl;
            request.Label = label;
            request.AWSAccountIds = awsAccountIds;
            request.Actions = actions;
            return AddPermissionAsync(request, cancellationToken);
        }

Same methods

AmazonSQSClient::AddPermissionAsync ( AddPermissionRequest request, System cancellationToken = default(CancellationToken) ) : Task
AmazonSQSClient::AddPermissionAsync ( AddPermissionRequest request, AddPermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void
AmazonSQSClient::AddPermissionAsync ( string queueUrl, string label, List awsAccountIds, List actions, AddPermissionResponse>.AmazonServiceCallback callback, AsyncOptions options = null ) : void