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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sqs/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<String>

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 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>)


68
69
70
71
72
73
74
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 68

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

#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>)


68
69
70
71
72
73
74
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 68

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

#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)


68
69
70
71
72
73
74
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 68

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

#queue_urlString

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

Queue URLs and names are case-sensitive.

Returns:

  • (String)


68
69
70
71
72
73
74
# File 'gems/aws-sdk-sqs/lib/aws-sdk-sqs/types.rb', line 68

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