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
}

Constant Summary collapse

SENSITIVE =
[]

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 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`.

[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html

Returns:

  • (Array<String>)

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

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

#aws_account_idsArray<String>

The account numbers of the [principals] who are to receive permission. For information about locating the account identification, see [Your Amazon Web Services Identifiers] in the *Amazon SQS Developer Guide*.

[1]: docs.aws.amazon.com/general/latest/gr/glos-chap.html#P [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication

Returns:

  • (Array<String>)

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

class AddPermissionRequest < Struct.new(
  :queue_url,
  :label,
  :aws_account_ids,
  :actions)
  SENSITIVE = []
  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)

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

class AddPermissionRequest < Struct.new(
  :queue_url,
  :label,
  :aws_account_ids,
  :actions)
  SENSITIVE = []
  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)

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

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