AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

AddPermissionInput

import "github.com/aws/aws-sdk-go/service/sqs"

type AddPermissionInput struct { AWSAccountIds []*string `locationNameList:"AWSAccountId" type:"list" flattened:"true" required:"true"` Actions []*string `locationNameList:"ActionName" type:"list" flattened:"true" required:"true"` Label *string `type:"string" required:"true"` QueueUrl *string `type:"string" required:"true"` }

AWSAccountIds

Type: []*string

The AWS account number of the principal (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) 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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication) in the Amazon Simple Queue Service Developer Guide.

AWSAccountIds is a required field

Actions

Type: []*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 (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html) 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.

Actions is a required field

Label

Type: *string

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

Label is a required field

QueueUrl

Type: *string

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

Queue URLs and names are case-sensitive.

QueueUrl is a required field

Method

GoString

func (s AddPermissionInput) GoString() string

GoString returns the string representation

SetAWSAccountIds

func (s *AddPermissionInput) SetAWSAccountIds(v []*string) *AddPermissionInput

SetAWSAccountIds sets the AWSAccountIds field's value.

SetActions

func (s *AddPermissionInput) SetActions(v []*string) *AddPermissionInput

SetActions sets the Actions field's value.

SetLabel

func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput

SetLabel sets the Label field's value.

SetQueueUrl

func (s *AddPermissionInput) SetQueueUrl(v string) *AddPermissionInput

SetQueueUrl sets the QueueUrl field's value.

String

func (s AddPermissionInput) String() string

String returns the string representation

Validate

func (s *AddPermissionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: