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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sqs/types.rb

Overview

Note:

When making an API call, you may pass AddPermissionRequest data as a hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<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`.

[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes

Returns:

  • (Array<String>) 


82
83
84
85
86
87
88
 
# File 'lib/aws-sdk-sqs/types.rb', line 82

class AddPermissionRequest < Struct.new(
  :queue_url,
  :label,
  :aws_account_ids,
  :actions)
  include Aws::Structure
end

#aws_account_ids ⇒ Array<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*.

[1]: docs.aws.amazon.com/general/latest/gr/glos-chap.html#P [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html

Returns:

  • (Array<String>) 


82
83
84
85
86
87
88
 
# File 'lib/aws-sdk-sqs/types.rb', line 82

class AddPermissionRequest < Struct.new(
  :queue_url,
  :label,
  :aws_account_ids,
  :actions)
  include Aws::Structure
end

#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 (`_`).

Returns:

  • (String) 


82
83
84
85
86
87
88
 
# File 'lib/aws-sdk-sqs/types.rb', line 82

class AddPermissionRequest < Struct.new(
  :queue_url,
  :label,
  :aws_account_ids,
  :actions)
  include Aws::Structure
end

#queue_url ⇒ String

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

Queue URLs are case-sensitive.

Returns:

  • (String) 


82
83
84
85
86
87
88
 
# File 'lib/aws-sdk-sqs/types.rb', line 82

class AddPermissionRequest < Struct.new(
  :queue_url,
  :label,
  :aws_account_ids,
  :actions)
  include Aws::Structure
end