Adds a permission to a queue for a specific principal¶

Description¶

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.

• add_permission generates a policy for you. You can use set_queue_attributes 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 add_permission, remove_permission, and set_queue_attributes actions in your IAM policy.
• Amazon SQS add_permission 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.

Usage¶

sqs_add_permission(QueueUrl, Label, AWSAccountIds, Actions)

Arguments¶

• QueueUrl

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

  Queue URLs and names are case-sensitive.

• Label

  [required] The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

• AWSAccountIds

  [required] 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.

• Actions

  [required] 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 send_message, delete_message, or change_message_visibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: send_message_batch, delete_message_batch, and change_message_visibility_batch.

Value¶

An empty list.

Request syntax¶

svc$add_permission(
  QueueUrl = "string",
  Label = "string",
  AWSAccountIds = list(
    "string"
  ),
  Actions = list(
    "string"
  )
)