You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SQS::Types::AddPermissionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AddPermissionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  queue_url: "String", # required
  label: "String", # required
  aws_account_ids: ["String"], # required
  actions: ["String"], # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<String>

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 Simple Queue Service 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.

Returns:

  • (Array<String>)

    The action the client wants to allow for the specified principal.

#aws_account_idsArray<String>

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 Simple Queue Service Developer Guide.

Returns:

  • (Array<String>)

    The AWS account number of the [principal][1] who is given permission.

#labelString

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

Returns:

  • (String)

    The unique identification of the permission you\'re setting (for example, AliceSendMessage).

#queue_urlString

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

Queue URLs are case-sensitive.

Returns:

  • (String)

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