Documentation ¶
Overview ¶
Package sqs provides the client and types for making API requests to Amazon Simple Queue Service.
Welcome to the Amazon SQS API Reference.
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html) in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs (http://aws.amazon.com/tools/#sdk) to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Product Page (http://aws.amazon.com/sqs/)
Amazon SQS Developer Guide Making API Requests (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html) Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) Amazon SQS Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
Amazon SQS in the Command Line Interface (http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html)
Amazon Web Services General Reference Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region)
See https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05 for more information on this service.
See sqs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/
Using the Client ¶
To contact Amazon Simple Queue Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Simple Queue Service client SQS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/#New
Index ¶
- Constants
- func MessageSystemAttributeNameForSends_Values() []string
- func MessageSystemAttributeName_Values() []string
- func QueueAttributeName_Values() []string
- type AddPermissionInput
- func (s AddPermissionInput) GoString() string
- func (s *AddPermissionInput) SetAWSAccountIds(v []*string) *AddPermissionInput
- func (s *AddPermissionInput) SetActions(v []*string) *AddPermissionInput
- func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput
- func (s *AddPermissionInput) SetQueueUrl(v string) *AddPermissionInput
- func (s AddPermissionInput) String() string
- func (s *AddPermissionInput) Validate() error
- type AddPermissionOutput
- type BatchResultErrorEntry
- func (s BatchResultErrorEntry) GoString() string
- func (s *BatchResultErrorEntry) SetCode(v string) *BatchResultErrorEntry
- func (s *BatchResultErrorEntry) SetId(v string) *BatchResultErrorEntry
- func (s *BatchResultErrorEntry) SetMessage(v string) *BatchResultErrorEntry
- func (s *BatchResultErrorEntry) SetSenderFault(v bool) *BatchResultErrorEntry
- func (s BatchResultErrorEntry) String() string
- type CancelMessageMoveTaskInput
- type CancelMessageMoveTaskOutput
- type ChangeMessageVisibilityBatchInput
- func (s ChangeMessageVisibilityBatchInput) GoString() string
- func (s *ChangeMessageVisibilityBatchInput) SetEntries(v []*ChangeMessageVisibilityBatchRequestEntry) *ChangeMessageVisibilityBatchInput
- func (s *ChangeMessageVisibilityBatchInput) SetQueueUrl(v string) *ChangeMessageVisibilityBatchInput
- func (s ChangeMessageVisibilityBatchInput) String() string
- func (s *ChangeMessageVisibilityBatchInput) Validate() error
- type ChangeMessageVisibilityBatchOutput
- func (s ChangeMessageVisibilityBatchOutput) GoString() string
- func (s *ChangeMessageVisibilityBatchOutput) SetFailed(v []*BatchResultErrorEntry) *ChangeMessageVisibilityBatchOutput
- func (s *ChangeMessageVisibilityBatchOutput) SetSuccessful(v []*ChangeMessageVisibilityBatchResultEntry) *ChangeMessageVisibilityBatchOutput
- func (s ChangeMessageVisibilityBatchOutput) String() string
- type ChangeMessageVisibilityBatchRequestEntry
- func (s ChangeMessageVisibilityBatchRequestEntry) GoString() string
- func (s *ChangeMessageVisibilityBatchRequestEntry) SetId(v string) *ChangeMessageVisibilityBatchRequestEntry
- func (s *ChangeMessageVisibilityBatchRequestEntry) SetReceiptHandle(v string) *ChangeMessageVisibilityBatchRequestEntry
- func (s *ChangeMessageVisibilityBatchRequestEntry) SetVisibilityTimeout(v int64) *ChangeMessageVisibilityBatchRequestEntry
- func (s ChangeMessageVisibilityBatchRequestEntry) String() string
- func (s *ChangeMessageVisibilityBatchRequestEntry) Validate() error
- type ChangeMessageVisibilityBatchResultEntry
- type ChangeMessageVisibilityInput
- func (s ChangeMessageVisibilityInput) GoString() string
- func (s *ChangeMessageVisibilityInput) SetQueueUrl(v string) *ChangeMessageVisibilityInput
- func (s *ChangeMessageVisibilityInput) SetReceiptHandle(v string) *ChangeMessageVisibilityInput
- func (s *ChangeMessageVisibilityInput) SetVisibilityTimeout(v int64) *ChangeMessageVisibilityInput
- func (s ChangeMessageVisibilityInput) String() string
- func (s *ChangeMessageVisibilityInput) Validate() error
- type ChangeMessageVisibilityOutput
- type CreateQueueInput
- func (s CreateQueueInput) GoString() string
- func (s *CreateQueueInput) SetAttributes(v map[string]*string) *CreateQueueInput
- func (s *CreateQueueInput) SetQueueName(v string) *CreateQueueInput
- func (s *CreateQueueInput) SetTags(v map[string]*string) *CreateQueueInput
- func (s CreateQueueInput) String() string
- func (s *CreateQueueInput) Validate() error
- type CreateQueueOutput
- type DeleteMessageBatchInput
- func (s DeleteMessageBatchInput) GoString() string
- func (s *DeleteMessageBatchInput) SetEntries(v []*DeleteMessageBatchRequestEntry) *DeleteMessageBatchInput
- func (s *DeleteMessageBatchInput) SetQueueUrl(v string) *DeleteMessageBatchInput
- func (s DeleteMessageBatchInput) String() string
- func (s *DeleteMessageBatchInput) Validate() error
- type DeleteMessageBatchOutput
- func (s DeleteMessageBatchOutput) GoString() string
- func (s *DeleteMessageBatchOutput) SetFailed(v []*BatchResultErrorEntry) *DeleteMessageBatchOutput
- func (s *DeleteMessageBatchOutput) SetSuccessful(v []*DeleteMessageBatchResultEntry) *DeleteMessageBatchOutput
- func (s DeleteMessageBatchOutput) String() string
- type DeleteMessageBatchRequestEntry
- func (s DeleteMessageBatchRequestEntry) GoString() string
- func (s *DeleteMessageBatchRequestEntry) SetId(v string) *DeleteMessageBatchRequestEntry
- func (s *DeleteMessageBatchRequestEntry) SetReceiptHandle(v string) *DeleteMessageBatchRequestEntry
- func (s DeleteMessageBatchRequestEntry) String() string
- func (s *DeleteMessageBatchRequestEntry) Validate() error
- type DeleteMessageBatchResultEntry
- type DeleteMessageInput
- type DeleteMessageOutput
- type DeleteQueueInput
- type DeleteQueueOutput
- type GetQueueAttributesInput
- func (s GetQueueAttributesInput) GoString() string
- func (s *GetQueueAttributesInput) SetAttributeNames(v []*string) *GetQueueAttributesInput
- func (s *GetQueueAttributesInput) SetQueueUrl(v string) *GetQueueAttributesInput
- func (s GetQueueAttributesInput) String() string
- func (s *GetQueueAttributesInput) Validate() error
- type GetQueueAttributesOutput
- type GetQueueUrlInput
- type GetQueueUrlOutput
- type ListDeadLetterSourceQueuesInput
- func (s ListDeadLetterSourceQueuesInput) GoString() string
- func (s *ListDeadLetterSourceQueuesInput) SetMaxResults(v int64) *ListDeadLetterSourceQueuesInput
- func (s *ListDeadLetterSourceQueuesInput) SetNextToken(v string) *ListDeadLetterSourceQueuesInput
- func (s *ListDeadLetterSourceQueuesInput) SetQueueUrl(v string) *ListDeadLetterSourceQueuesInput
- func (s ListDeadLetterSourceQueuesInput) String() string
- func (s *ListDeadLetterSourceQueuesInput) Validate() error
- type ListDeadLetterSourceQueuesOutput
- func (s ListDeadLetterSourceQueuesOutput) GoString() string
- func (s *ListDeadLetterSourceQueuesOutput) SetNextToken(v string) *ListDeadLetterSourceQueuesOutput
- func (s *ListDeadLetterSourceQueuesOutput) SetQueueUrls(v []*string) *ListDeadLetterSourceQueuesOutput
- func (s ListDeadLetterSourceQueuesOutput) String() string
- type ListMessageMoveTasksInput
- func (s ListMessageMoveTasksInput) GoString() string
- func (s *ListMessageMoveTasksInput) SetMaxResults(v int64) *ListMessageMoveTasksInput
- func (s *ListMessageMoveTasksInput) SetSourceArn(v string) *ListMessageMoveTasksInput
- func (s ListMessageMoveTasksInput) String() string
- func (s *ListMessageMoveTasksInput) Validate() error
- type ListMessageMoveTasksOutput
- type ListMessageMoveTasksResultEntry
- func (s ListMessageMoveTasksResultEntry) GoString() string
- func (s *ListMessageMoveTasksResultEntry) SetApproximateNumberOfMessagesMoved(v int64) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetApproximateNumberOfMessagesToMove(v int64) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetDestinationArn(v string) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetFailureReason(v string) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetMaxNumberOfMessagesPerSecond(v int64) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetSourceArn(v string) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetStartedTimestamp(v int64) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetStatus(v string) *ListMessageMoveTasksResultEntry
- func (s *ListMessageMoveTasksResultEntry) SetTaskHandle(v string) *ListMessageMoveTasksResultEntry
- func (s ListMessageMoveTasksResultEntry) String() string
- type ListQueueTagsInput
- type ListQueueTagsOutput
- type ListQueuesInput
- type ListQueuesOutput
- type Message
- func (s Message) GoString() string
- func (s *Message) SetAttributes(v map[string]*string) *Message
- func (s *Message) SetBody(v string) *Message
- func (s *Message) SetMD5OfBody(v string) *Message
- func (s *Message) SetMD5OfMessageAttributes(v string) *Message
- func (s *Message) SetMessageAttributes(v map[string]*MessageAttributeValue) *Message
- func (s *Message) SetMessageId(v string) *Message
- func (s *Message) SetReceiptHandle(v string) *Message
- func (s Message) String() string
- type MessageAttributeValue
- func (s MessageAttributeValue) GoString() string
- func (s *MessageAttributeValue) SetBinaryListValues(v [][]byte) *MessageAttributeValue
- func (s *MessageAttributeValue) SetBinaryValue(v []byte) *MessageAttributeValue
- func (s *MessageAttributeValue) SetDataType(v string) *MessageAttributeValue
- func (s *MessageAttributeValue) SetStringListValues(v []*string) *MessageAttributeValue
- func (s *MessageAttributeValue) SetStringValue(v string) *MessageAttributeValue
- func (s MessageAttributeValue) String() string
- func (s *MessageAttributeValue) Validate() error
- type MessageSystemAttributeValue
- func (s MessageSystemAttributeValue) GoString() string
- func (s *MessageSystemAttributeValue) SetBinaryListValues(v [][]byte) *MessageSystemAttributeValue
- func (s *MessageSystemAttributeValue) SetBinaryValue(v []byte) *MessageSystemAttributeValue
- func (s *MessageSystemAttributeValue) SetDataType(v string) *MessageSystemAttributeValue
- func (s *MessageSystemAttributeValue) SetStringListValues(v []*string) *MessageSystemAttributeValue
- func (s *MessageSystemAttributeValue) SetStringValue(v string) *MessageSystemAttributeValue
- func (s MessageSystemAttributeValue) String() string
- func (s *MessageSystemAttributeValue) Validate() error
- type PurgeQueueInput
- type PurgeQueueOutput
- type ReceiveMessageInput
- func (s ReceiveMessageInput) GoString() string
- func (s *ReceiveMessageInput) SetAttributeNames(v []*string) *ReceiveMessageInput
- func (s *ReceiveMessageInput) SetMaxNumberOfMessages(v int64) *ReceiveMessageInput
- func (s *ReceiveMessageInput) SetMessageAttributeNames(v []*string) *ReceiveMessageInput
- func (s *ReceiveMessageInput) SetQueueUrl(v string) *ReceiveMessageInput
- func (s *ReceiveMessageInput) SetReceiveRequestAttemptId(v string) *ReceiveMessageInput
- func (s *ReceiveMessageInput) SetVisibilityTimeout(v int64) *ReceiveMessageInput
- func (s *ReceiveMessageInput) SetWaitTimeSeconds(v int64) *ReceiveMessageInput
- func (s ReceiveMessageInput) String() string
- func (s *ReceiveMessageInput) Validate() error
- type ReceiveMessageOutput
- type RemovePermissionInput
- type RemovePermissionOutput
- type SQS
- func (c *SQS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)
- func (c *SQS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)
- func (c *SQS) AddPermissionWithContext(ctx aws.Context, input *AddPermissionInput, opts ...request.Option) (*AddPermissionOutput, error)
- func (c *SQS) CancelMessageMoveTask(input *CancelMessageMoveTaskInput) (*CancelMessageMoveTaskOutput, error)
- func (c *SQS) CancelMessageMoveTaskRequest(input *CancelMessageMoveTaskInput) (req *request.Request, output *CancelMessageMoveTaskOutput)
- func (c *SQS) CancelMessageMoveTaskWithContext(ctx aws.Context, input *CancelMessageMoveTaskInput, opts ...request.Option) (*CancelMessageMoveTaskOutput, error)
- func (c *SQS) ChangeMessageVisibility(input *ChangeMessageVisibilityInput) (*ChangeMessageVisibilityOutput, error)
- func (c *SQS) ChangeMessageVisibilityBatch(input *ChangeMessageVisibilityBatchInput) (*ChangeMessageVisibilityBatchOutput, error)
- func (c *SQS) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibilityBatchInput) (req *request.Request, output *ChangeMessageVisibilityBatchOutput)
- func (c *SQS) ChangeMessageVisibilityBatchWithContext(ctx aws.Context, input *ChangeMessageVisibilityBatchInput, ...) (*ChangeMessageVisibilityBatchOutput, error)
- func (c *SQS) ChangeMessageVisibilityRequest(input *ChangeMessageVisibilityInput) (req *request.Request, output *ChangeMessageVisibilityOutput)
- func (c *SQS) ChangeMessageVisibilityWithContext(ctx aws.Context, input *ChangeMessageVisibilityInput, opts ...request.Option) (*ChangeMessageVisibilityOutput, error)
- func (c *SQS) CreateQueue(input *CreateQueueInput) (*CreateQueueOutput, error)
- func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, output *CreateQueueOutput)
- func (c *SQS) CreateQueueWithContext(ctx aws.Context, input *CreateQueueInput, opts ...request.Option) (*CreateQueueOutput, error)
- func (c *SQS) DeleteMessage(input *DeleteMessageInput) (*DeleteMessageOutput, error)
- func (c *SQS) DeleteMessageBatch(input *DeleteMessageBatchInput) (*DeleteMessageBatchOutput, error)
- func (c *SQS) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) (req *request.Request, output *DeleteMessageBatchOutput)
- func (c *SQS) DeleteMessageBatchWithContext(ctx aws.Context, input *DeleteMessageBatchInput, opts ...request.Option) (*DeleteMessageBatchOutput, error)
- func (c *SQS) DeleteMessageRequest(input *DeleteMessageInput) (req *request.Request, output *DeleteMessageOutput)
- func (c *SQS) DeleteMessageWithContext(ctx aws.Context, input *DeleteMessageInput, opts ...request.Option) (*DeleteMessageOutput, error)
- func (c *SQS) DeleteQueue(input *DeleteQueueInput) (*DeleteQueueOutput, error)
- func (c *SQS) DeleteQueueRequest(input *DeleteQueueInput) (req *request.Request, output *DeleteQueueOutput)
- func (c *SQS) DeleteQueueWithContext(ctx aws.Context, input *DeleteQueueInput, opts ...request.Option) (*DeleteQueueOutput, error)
- func (c *SQS) GetQueueAttributes(input *GetQueueAttributesInput) (*GetQueueAttributesOutput, error)
- func (c *SQS) GetQueueAttributesRequest(input *GetQueueAttributesInput) (req *request.Request, output *GetQueueAttributesOutput)
- func (c *SQS) GetQueueAttributesWithContext(ctx aws.Context, input *GetQueueAttributesInput, opts ...request.Option) (*GetQueueAttributesOutput, error)
- func (c *SQS) GetQueueUrl(input *GetQueueUrlInput) (*GetQueueUrlOutput, error)
- func (c *SQS) GetQueueUrlRequest(input *GetQueueUrlInput) (req *request.Request, output *GetQueueUrlOutput)
- func (c *SQS) GetQueueUrlWithContext(ctx aws.Context, input *GetQueueUrlInput, opts ...request.Option) (*GetQueueUrlOutput, error)
- func (c *SQS) ListDeadLetterSourceQueues(input *ListDeadLetterSourceQueuesInput) (*ListDeadLetterSourceQueuesOutput, error)
- func (c *SQS) ListDeadLetterSourceQueuesPages(input *ListDeadLetterSourceQueuesInput, ...) error
- func (c *SQS) ListDeadLetterSourceQueuesPagesWithContext(ctx aws.Context, input *ListDeadLetterSourceQueuesInput, ...) error
- func (c *SQS) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueuesInput) (req *request.Request, output *ListDeadLetterSourceQueuesOutput)
- func (c *SQS) ListDeadLetterSourceQueuesWithContext(ctx aws.Context, input *ListDeadLetterSourceQueuesInput, ...) (*ListDeadLetterSourceQueuesOutput, error)
- func (c *SQS) ListMessageMoveTasks(input *ListMessageMoveTasksInput) (*ListMessageMoveTasksOutput, error)
- func (c *SQS) ListMessageMoveTasksRequest(input *ListMessageMoveTasksInput) (req *request.Request, output *ListMessageMoveTasksOutput)
- func (c *SQS) ListMessageMoveTasksWithContext(ctx aws.Context, input *ListMessageMoveTasksInput, opts ...request.Option) (*ListMessageMoveTasksOutput, error)
- func (c *SQS) ListQueueTags(input *ListQueueTagsInput) (*ListQueueTagsOutput, error)
- func (c *SQS) ListQueueTagsRequest(input *ListQueueTagsInput) (req *request.Request, output *ListQueueTagsOutput)
- func (c *SQS) ListQueueTagsWithContext(ctx aws.Context, input *ListQueueTagsInput, opts ...request.Option) (*ListQueueTagsOutput, error)
- func (c *SQS) ListQueues(input *ListQueuesInput) (*ListQueuesOutput, error)
- func (c *SQS) ListQueuesPages(input *ListQueuesInput, fn func(*ListQueuesOutput, bool) bool) error
- func (c *SQS) ListQueuesPagesWithContext(ctx aws.Context, input *ListQueuesInput, fn func(*ListQueuesOutput, bool) bool, ...) error
- func (c *SQS) ListQueuesRequest(input *ListQueuesInput) (req *request.Request, output *ListQueuesOutput)
- func (c *SQS) ListQueuesWithContext(ctx aws.Context, input *ListQueuesInput, opts ...request.Option) (*ListQueuesOutput, error)
- func (c *SQS) PurgeQueue(input *PurgeQueueInput) (*PurgeQueueOutput, error)
- func (c *SQS) PurgeQueueRequest(input *PurgeQueueInput) (req *request.Request, output *PurgeQueueOutput)
- func (c *SQS) PurgeQueueWithContext(ctx aws.Context, input *PurgeQueueInput, opts ...request.Option) (*PurgeQueueOutput, error)
- func (c *SQS) ReceiveMessage(input *ReceiveMessageInput) (*ReceiveMessageOutput, error)
- func (c *SQS) ReceiveMessageRequest(input *ReceiveMessageInput) (req *request.Request, output *ReceiveMessageOutput)
- func (c *SQS) ReceiveMessageWithContext(ctx aws.Context, input *ReceiveMessageInput, opts ...request.Option) (*ReceiveMessageOutput, error)
- func (c *SQS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)
- func (c *SQS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)
- func (c *SQS) RemovePermissionWithContext(ctx aws.Context, input *RemovePermissionInput, opts ...request.Option) (*RemovePermissionOutput, error)
- func (c *SQS) SendMessage(input *SendMessageInput) (*SendMessageOutput, error)
- func (c *SQS) SendMessageBatch(input *SendMessageBatchInput) (*SendMessageBatchOutput, error)
- func (c *SQS) SendMessageBatchRequest(input *SendMessageBatchInput) (req *request.Request, output *SendMessageBatchOutput)
- func (c *SQS) SendMessageBatchWithContext(ctx aws.Context, input *SendMessageBatchInput, opts ...request.Option) (*SendMessageBatchOutput, error)
- func (c *SQS) SendMessageRequest(input *SendMessageInput) (req *request.Request, output *SendMessageOutput)
- func (c *SQS) SendMessageWithContext(ctx aws.Context, input *SendMessageInput, opts ...request.Option) (*SendMessageOutput, error)
- func (c *SQS) SetQueueAttributes(input *SetQueueAttributesInput) (*SetQueueAttributesOutput, error)
- func (c *SQS) SetQueueAttributesRequest(input *SetQueueAttributesInput) (req *request.Request, output *SetQueueAttributesOutput)
- func (c *SQS) SetQueueAttributesWithContext(ctx aws.Context, input *SetQueueAttributesInput, opts ...request.Option) (*SetQueueAttributesOutput, error)
- func (c *SQS) StartMessageMoveTask(input *StartMessageMoveTaskInput) (*StartMessageMoveTaskOutput, error)
- func (c *SQS) StartMessageMoveTaskRequest(input *StartMessageMoveTaskInput) (req *request.Request, output *StartMessageMoveTaskOutput)
- func (c *SQS) StartMessageMoveTaskWithContext(ctx aws.Context, input *StartMessageMoveTaskInput, opts ...request.Option) (*StartMessageMoveTaskOutput, error)
- func (c *SQS) TagQueue(input *TagQueueInput) (*TagQueueOutput, error)
- func (c *SQS) TagQueueRequest(input *TagQueueInput) (req *request.Request, output *TagQueueOutput)
- func (c *SQS) TagQueueWithContext(ctx aws.Context, input *TagQueueInput, opts ...request.Option) (*TagQueueOutput, error)
- func (c *SQS) UntagQueue(input *UntagQueueInput) (*UntagQueueOutput, error)
- func (c *SQS) UntagQueueRequest(input *UntagQueueInput) (req *request.Request, output *UntagQueueOutput)
- func (c *SQS) UntagQueueWithContext(ctx aws.Context, input *UntagQueueInput, opts ...request.Option) (*UntagQueueOutput, error)
- type SendMessageBatchInput
- func (s SendMessageBatchInput) GoString() string
- func (s *SendMessageBatchInput) SetEntries(v []*SendMessageBatchRequestEntry) *SendMessageBatchInput
- func (s *SendMessageBatchInput) SetQueueUrl(v string) *SendMessageBatchInput
- func (s SendMessageBatchInput) String() string
- func (s *SendMessageBatchInput) Validate() error
- type SendMessageBatchOutput
- type SendMessageBatchRequestEntry
- func (s SendMessageBatchRequestEntry) GoString() string
- func (s *SendMessageBatchRequestEntry) SetDelaySeconds(v int64) *SendMessageBatchRequestEntry
- func (s *SendMessageBatchRequestEntry) SetId(v string) *SendMessageBatchRequestEntry
- func (s *SendMessageBatchRequestEntry) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendMessageBatchRequestEntry
- func (s *SendMessageBatchRequestEntry) SetMessageBody(v string) *SendMessageBatchRequestEntry
- func (s *SendMessageBatchRequestEntry) SetMessageDeduplicationId(v string) *SendMessageBatchRequestEntry
- func (s *SendMessageBatchRequestEntry) SetMessageGroupId(v string) *SendMessageBatchRequestEntry
- func (s *SendMessageBatchRequestEntry) SetMessageSystemAttributes(v map[string]*MessageSystemAttributeValue) *SendMessageBatchRequestEntry
- func (s SendMessageBatchRequestEntry) String() string
- func (s *SendMessageBatchRequestEntry) Validate() error
- type SendMessageBatchResultEntry
- func (s SendMessageBatchResultEntry) GoString() string
- func (s *SendMessageBatchResultEntry) SetId(v string) *SendMessageBatchResultEntry
- func (s *SendMessageBatchResultEntry) SetMD5OfMessageAttributes(v string) *SendMessageBatchResultEntry
- func (s *SendMessageBatchResultEntry) SetMD5OfMessageBody(v string) *SendMessageBatchResultEntry
- func (s *SendMessageBatchResultEntry) SetMD5OfMessageSystemAttributes(v string) *SendMessageBatchResultEntry
- func (s *SendMessageBatchResultEntry) SetMessageId(v string) *SendMessageBatchResultEntry
- func (s *SendMessageBatchResultEntry) SetSequenceNumber(v string) *SendMessageBatchResultEntry
- func (s SendMessageBatchResultEntry) String() string
- type SendMessageInput
- func (s SendMessageInput) GoString() string
- func (s *SendMessageInput) SetDelaySeconds(v int64) *SendMessageInput
- func (s *SendMessageInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendMessageInput
- func (s *SendMessageInput) SetMessageBody(v string) *SendMessageInput
- func (s *SendMessageInput) SetMessageDeduplicationId(v string) *SendMessageInput
- func (s *SendMessageInput) SetMessageGroupId(v string) *SendMessageInput
- func (s *SendMessageInput) SetMessageSystemAttributes(v map[string]*MessageSystemAttributeValue) *SendMessageInput
- func (s *SendMessageInput) SetQueueUrl(v string) *SendMessageInput
- func (s SendMessageInput) String() string
- func (s *SendMessageInput) Validate() error
- type SendMessageOutput
- func (s SendMessageOutput) GoString() string
- func (s *SendMessageOutput) SetMD5OfMessageAttributes(v string) *SendMessageOutput
- func (s *SendMessageOutput) SetMD5OfMessageBody(v string) *SendMessageOutput
- func (s *SendMessageOutput) SetMD5OfMessageSystemAttributes(v string) *SendMessageOutput
- func (s *SendMessageOutput) SetMessageId(v string) *SendMessageOutput
- func (s *SendMessageOutput) SetSequenceNumber(v string) *SendMessageOutput
- func (s SendMessageOutput) String() string
- type SetQueueAttributesInput
- func (s SetQueueAttributesInput) GoString() string
- func (s *SetQueueAttributesInput) SetAttributes(v map[string]*string) *SetQueueAttributesInput
- func (s *SetQueueAttributesInput) SetQueueUrl(v string) *SetQueueAttributesInput
- func (s SetQueueAttributesInput) String() string
- func (s *SetQueueAttributesInput) Validate() error
- type SetQueueAttributesOutput
- type StartMessageMoveTaskInput
- func (s StartMessageMoveTaskInput) GoString() string
- func (s *StartMessageMoveTaskInput) SetDestinationArn(v string) *StartMessageMoveTaskInput
- func (s *StartMessageMoveTaskInput) SetMaxNumberOfMessagesPerSecond(v int64) *StartMessageMoveTaskInput
- func (s *StartMessageMoveTaskInput) SetSourceArn(v string) *StartMessageMoveTaskInput
- func (s StartMessageMoveTaskInput) String() string
- func (s *StartMessageMoveTaskInput) Validate() error
- type StartMessageMoveTaskOutput
- type TagQueueInput
- type TagQueueOutput
- type UntagQueueInput
- type UntagQueueOutput
Constants ¶
const ( // MessageSystemAttributeNameSenderId is a MessageSystemAttributeName enum value MessageSystemAttributeNameSenderId = "SenderId" // MessageSystemAttributeNameSentTimestamp is a MessageSystemAttributeName enum value MessageSystemAttributeNameSentTimestamp = "SentTimestamp" // MessageSystemAttributeNameApproximateReceiveCount is a MessageSystemAttributeName enum value MessageSystemAttributeNameApproximateReceiveCount = "ApproximateReceiveCount" // MessageSystemAttributeNameApproximateFirstReceiveTimestamp is a MessageSystemAttributeName enum value MessageSystemAttributeNameApproximateFirstReceiveTimestamp = "ApproximateFirstReceiveTimestamp" // MessageSystemAttributeNameSequenceNumber is a MessageSystemAttributeName enum value MessageSystemAttributeNameSequenceNumber = "SequenceNumber" // MessageSystemAttributeNameMessageDeduplicationId is a MessageSystemAttributeName enum value MessageSystemAttributeNameMessageDeduplicationId = "MessageDeduplicationId" // MessageSystemAttributeNameMessageGroupId is a MessageSystemAttributeName enum value MessageSystemAttributeNameMessageGroupId = "MessageGroupId" // MessageSystemAttributeNameAwstraceHeader is a MessageSystemAttributeName enum value MessageSystemAttributeNameAwstraceHeader = "AWSTraceHeader" // MessageSystemAttributeNameDeadLetterQueueSourceArn is a MessageSystemAttributeName enum value MessageSystemAttributeNameDeadLetterQueueSourceArn = "DeadLetterQueueSourceArn" )
const ( // QueueAttributeNameAll is a QueueAttributeName enum value QueueAttributeNameAll = "All" // QueueAttributeNamePolicy is a QueueAttributeName enum value QueueAttributeNamePolicy = "Policy" // QueueAttributeNameVisibilityTimeout is a QueueAttributeName enum value QueueAttributeNameVisibilityTimeout = "VisibilityTimeout" // QueueAttributeNameMaximumMessageSize is a QueueAttributeName enum value QueueAttributeNameMaximumMessageSize = "MaximumMessageSize" // QueueAttributeNameMessageRetentionPeriod is a QueueAttributeName enum value QueueAttributeNameMessageRetentionPeriod = "MessageRetentionPeriod" // QueueAttributeNameApproximateNumberOfMessages is a QueueAttributeName enum value QueueAttributeNameApproximateNumberOfMessages = "ApproximateNumberOfMessages" // QueueAttributeNameApproximateNumberOfMessagesNotVisible is a QueueAttributeName enum value QueueAttributeNameApproximateNumberOfMessagesNotVisible = "ApproximateNumberOfMessagesNotVisible" // QueueAttributeNameCreatedTimestamp is a QueueAttributeName enum value QueueAttributeNameCreatedTimestamp = "CreatedTimestamp" // QueueAttributeNameLastModifiedTimestamp is a QueueAttributeName enum value QueueAttributeNameLastModifiedTimestamp = "LastModifiedTimestamp" // QueueAttributeNameQueueArn is a QueueAttributeName enum value QueueAttributeNameQueueArn = "QueueArn" // QueueAttributeNameApproximateNumberOfMessagesDelayed is a QueueAttributeName enum value QueueAttributeNameApproximateNumberOfMessagesDelayed = "ApproximateNumberOfMessagesDelayed" // QueueAttributeNameDelaySeconds is a QueueAttributeName enum value QueueAttributeNameDelaySeconds = "DelaySeconds" // QueueAttributeNameReceiveMessageWaitTimeSeconds is a QueueAttributeName enum value QueueAttributeNameReceiveMessageWaitTimeSeconds = "ReceiveMessageWaitTimeSeconds" // QueueAttributeNameRedrivePolicy is a QueueAttributeName enum value QueueAttributeNameRedrivePolicy = "RedrivePolicy" // QueueAttributeNameFifoQueue is a QueueAttributeName enum value QueueAttributeNameFifoQueue = "FifoQueue" // QueueAttributeNameContentBasedDeduplication is a QueueAttributeName enum value QueueAttributeNameContentBasedDeduplication = "ContentBasedDeduplication" // QueueAttributeNameKmsMasterKeyId is a QueueAttributeName enum value QueueAttributeNameKmsMasterKeyId = "KmsMasterKeyId" // QueueAttributeNameKmsDataKeyReusePeriodSeconds is a QueueAttributeName enum value QueueAttributeNameKmsDataKeyReusePeriodSeconds = "KmsDataKeyReusePeriodSeconds" // QueueAttributeNameDeduplicationScope is a QueueAttributeName enum value QueueAttributeNameDeduplicationScope = "DeduplicationScope" // QueueAttributeNameFifoThroughputLimit is a QueueAttributeName enum value QueueAttributeNameFifoThroughputLimit = "FifoThroughputLimit" // QueueAttributeNameRedriveAllowPolicy is a QueueAttributeName enum value QueueAttributeNameRedriveAllowPolicy = "RedriveAllowPolicy" // QueueAttributeNameSqsManagedSseEnabled is a QueueAttributeName enum value QueueAttributeNameSqsManagedSseEnabled = "SqsManagedSseEnabled" )
const ( // ErrCodeBatchEntryIdsNotDistinct for service response error code // "AWS.SimpleQueueService.BatchEntryIdsNotDistinct". // // Two or more batch entries in the request have the same Id. ErrCodeBatchEntryIdsNotDistinct = "AWS.SimpleQueueService.BatchEntryIdsNotDistinct" // ErrCodeBatchRequestTooLong for service response error code // "AWS.SimpleQueueService.BatchRequestTooLong". // // The length of all the messages put together is more than the limit. ErrCodeBatchRequestTooLong = "AWS.SimpleQueueService.BatchRequestTooLong" // ErrCodeEmptyBatchRequest for service response error code // "AWS.SimpleQueueService.EmptyBatchRequest". // // The batch request doesn't contain any entries. ErrCodeEmptyBatchRequest = "AWS.SimpleQueueService.EmptyBatchRequest" // ErrCodeInvalidAttributeName for service response error code // "InvalidAttributeName". // // The specified attribute doesn't exist. ErrCodeInvalidAttributeName = "InvalidAttributeName" // ErrCodeInvalidBatchEntryId for service response error code // "AWS.SimpleQueueService.InvalidBatchEntryId". // // The Id of a batch entry in a batch request doesn't abide by the specification. ErrCodeInvalidBatchEntryId = "AWS.SimpleQueueService.InvalidBatchEntryId" // ErrCodeInvalidIdFormat for service response error code // "InvalidIdFormat". // // The specified receipt handle isn't valid for the current version. ErrCodeInvalidIdFormat = "InvalidIdFormat" // ErrCodeInvalidMessageContents for service response error code // "InvalidMessageContents". // // The message contains characters outside the allowed set. ErrCodeInvalidMessageContents = "InvalidMessageContents" // ErrCodeMessageNotInflight for service response error code // "AWS.SimpleQueueService.MessageNotInflight". // // The specified message isn't in flight. ErrCodeMessageNotInflight = "AWS.SimpleQueueService.MessageNotInflight" // ErrCodeOverLimit for service response error code // "OverLimit". // // The specified action violates a limit. For example, ReceiveMessage returns // this error if the maximum number of in flight messages is reached and AddPermission // returns this error if the maximum number of permissions for the queue is // reached. ErrCodeOverLimit = "OverLimit" // ErrCodePurgeQueueInProgress for service response error code // "AWS.SimpleQueueService.PurgeQueueInProgress". // // Indicates that the specified queue previously received a PurgeQueue request // within the last 60 seconds (the time it can take to delete the messages in // the queue). ErrCodePurgeQueueInProgress = "AWS.SimpleQueueService.PurgeQueueInProgress" // ErrCodeQueueDeletedRecently for service response error code // "AWS.SimpleQueueService.QueueDeletedRecently". // // You must wait 60 seconds after deleting a queue before you can create another // queue with the same name. ErrCodeQueueDeletedRecently = "AWS.SimpleQueueService.QueueDeletedRecently" // ErrCodeQueueDoesNotExist for service response error code // "AWS.SimpleQueueService.NonExistentQueue". // // The specified queue doesn't exist. ErrCodeQueueDoesNotExist = "AWS.SimpleQueueService.NonExistentQueue" // ErrCodeQueueNameExists for service response error code // "QueueAlreadyExists". // // A queue with this name already exists. Amazon SQS returns this error only // if the request includes attributes whose values differ from those of the // existing queue. ErrCodeQueueNameExists = "QueueAlreadyExists" // ErrCodeReceiptHandleIsInvalid for service response error code // "ReceiptHandleIsInvalid". // // The specified receipt handle isn't valid. ErrCodeReceiptHandleIsInvalid = "ReceiptHandleIsInvalid" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // One or more specified resources don't exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeTooManyEntriesInBatchRequest for service response error code // "AWS.SimpleQueueService.TooManyEntriesInBatchRequest". // // The batch request contains more entries than permissible. ErrCodeTooManyEntriesInBatchRequest = "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" // ErrCodeUnsupportedOperation for service response error code // "AWS.SimpleQueueService.UnsupportedOperation". // // Error code 400. Unsupported operation. ErrCodeUnsupportedOperation = "AWS.SimpleQueueService.UnsupportedOperation" )
const ( ServiceName = "sqs" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "SQS" // ServiceID is a unique identifier of a specific service. )
Service information constants
const (
// MessageSystemAttributeNameForSendsAwstraceHeader is a MessageSystemAttributeNameForSends enum value
MessageSystemAttributeNameForSendsAwstraceHeader = "AWSTraceHeader"
)
Variables ¶
This section is empty.
Functions ¶
func MessageSystemAttributeNameForSends_Values ¶
func MessageSystemAttributeNameForSends_Values() []string
MessageSystemAttributeNameForSends_Values returns all elements of the MessageSystemAttributeNameForSends enum
func MessageSystemAttributeName_Values ¶
func MessageSystemAttributeName_Values() []string
MessageSystemAttributeName_Values returns all elements of the MessageSystemAttributeName enum
func QueueAttributeName_Values ¶
func QueueAttributeName_Values() []string
QueueAttributeName_Values returns all elements of the QueueAttributeName enum
Types ¶
type AddPermissionInput ¶
type AddPermissionInput struct { // The Amazon Web Services account numbers of the principals (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) // who are to receive permission. For information about locating the Amazon // Web Services account identification, see Your Amazon Web Services Identifiers // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication) // in the Amazon SQS Developer Guide. // // AWSAccountIds is a required field AWSAccountIds []*string `locationNameList:"AWSAccountId" type:"list" flattened:"true" required:"true"` // 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 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. // // Actions is a required field Actions []*string `locationNameList:"ActionName" type:"list" flattened:"true" required:"true"` // 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 Label *string `type:"string" required:"true"` // The URL of the Amazon SQS queue to which permissions are added. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (AddPermissionInput) GoString ¶
func (s AddPermissionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AddPermissionInput) SetAWSAccountIds ¶
func (s *AddPermissionInput) SetAWSAccountIds(v []*string) *AddPermissionInput
SetAWSAccountIds sets the AWSAccountIds field's value.
func (*AddPermissionInput) SetActions ¶
func (s *AddPermissionInput) SetActions(v []*string) *AddPermissionInput
SetActions sets the Actions field's value.
func (*AddPermissionInput) SetLabel ¶
func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput
SetLabel sets the Label field's value.
func (*AddPermissionInput) SetQueueUrl ¶
func (s *AddPermissionInput) SetQueueUrl(v string) *AddPermissionInput
SetQueueUrl sets the QueueUrl field's value.
func (AddPermissionInput) String ¶
func (s AddPermissionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AddPermissionInput) Validate ¶
func (s *AddPermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddPermissionOutput ¶
type AddPermissionOutput struct {
// contains filtered or unexported fields
}
func (AddPermissionOutput) GoString ¶
func (s AddPermissionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (AddPermissionOutput) String ¶
func (s AddPermissionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchResultErrorEntry ¶
type BatchResultErrorEntry struct { // An error code representing why the action failed on this entry. // // Code is a required field Code *string `type:"string" required:"true"` // The Id of an entry in a batch request. // // Id is a required field Id *string `type:"string" required:"true"` // A message explaining why the action failed on this entry. Message *string `type:"string"` // Specifies whether the error happened due to the caller of the batch API action. // // SenderFault is a required field SenderFault *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
Gives a detailed description of the result of an action on each entry in the request.
func (BatchResultErrorEntry) GoString ¶
func (s BatchResultErrorEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*BatchResultErrorEntry) SetCode ¶
func (s *BatchResultErrorEntry) SetCode(v string) *BatchResultErrorEntry
SetCode sets the Code field's value.
func (*BatchResultErrorEntry) SetId ¶
func (s *BatchResultErrorEntry) SetId(v string) *BatchResultErrorEntry
SetId sets the Id field's value.
func (*BatchResultErrorEntry) SetMessage ¶
func (s *BatchResultErrorEntry) SetMessage(v string) *BatchResultErrorEntry
SetMessage sets the Message field's value.
func (*BatchResultErrorEntry) SetSenderFault ¶
func (s *BatchResultErrorEntry) SetSenderFault(v bool) *BatchResultErrorEntry
SetSenderFault sets the SenderFault field's value.
func (BatchResultErrorEntry) String ¶
func (s BatchResultErrorEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CancelMessageMoveTaskInput ¶ added in v1.42.9
type CancelMessageMoveTaskInput struct { // An identifier associated with a message movement task. // // TaskHandle is a required field TaskHandle *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (CancelMessageMoveTaskInput) GoString ¶ added in v1.42.9
func (s CancelMessageMoveTaskInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CancelMessageMoveTaskInput) SetTaskHandle ¶ added in v1.42.9
func (s *CancelMessageMoveTaskInput) SetTaskHandle(v string) *CancelMessageMoveTaskInput
SetTaskHandle sets the TaskHandle field's value.
func (CancelMessageMoveTaskInput) String ¶ added in v1.42.9
func (s CancelMessageMoveTaskInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CancelMessageMoveTaskInput) Validate ¶ added in v1.42.9
func (s *CancelMessageMoveTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelMessageMoveTaskOutput ¶ added in v1.42.9
type CancelMessageMoveTaskOutput struct { // The approximate number of messages already moved to the destination queue. ApproximateNumberOfMessagesMoved *int64 `type:"long"` // contains filtered or unexported fields }
func (CancelMessageMoveTaskOutput) GoString ¶ added in v1.42.9
func (s CancelMessageMoveTaskOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CancelMessageMoveTaskOutput) SetApproximateNumberOfMessagesMoved ¶ added in v1.42.9
func (s *CancelMessageMoveTaskOutput) SetApproximateNumberOfMessagesMoved(v int64) *CancelMessageMoveTaskOutput
SetApproximateNumberOfMessagesMoved sets the ApproximateNumberOfMessagesMoved field's value.
func (CancelMessageMoveTaskOutput) String ¶ added in v1.42.9
func (s CancelMessageMoveTaskOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChangeMessageVisibilityBatchInput ¶
type ChangeMessageVisibilityBatchInput struct { // Lists the receipt handles of the messages for which the visibility timeout // must be changed. // // Entries is a required field Entries []*ChangeMessageVisibilityBatchRequestEntry `locationNameList:"ChangeMessageVisibilityBatchRequestEntry" type:"list" flattened:"true" required:"true"` // The URL of the Amazon SQS queue whose messages' visibility is changed. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ChangeMessageVisibilityBatchInput) GoString ¶
func (s ChangeMessageVisibilityBatchInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityBatchInput) SetEntries ¶
func (s *ChangeMessageVisibilityBatchInput) SetEntries(v []*ChangeMessageVisibilityBatchRequestEntry) *ChangeMessageVisibilityBatchInput
SetEntries sets the Entries field's value.
func (*ChangeMessageVisibilityBatchInput) SetQueueUrl ¶
func (s *ChangeMessageVisibilityBatchInput) SetQueueUrl(v string) *ChangeMessageVisibilityBatchInput
SetQueueUrl sets the QueueUrl field's value.
func (ChangeMessageVisibilityBatchInput) String ¶
func (s ChangeMessageVisibilityBatchInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityBatchInput) Validate ¶
func (s *ChangeMessageVisibilityBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeMessageVisibilityBatchOutput ¶
type ChangeMessageVisibilityBatchOutput struct { // A list of BatchResultErrorEntry items. // // Failed is a required field Failed []*BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"` // A list of ChangeMessageVisibilityBatchResultEntry items. // // Successful is a required field Successful []*ChangeMessageVisibilityBatchResultEntry `locationNameList:"ChangeMessageVisibilityBatchResultEntry" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
func (ChangeMessageVisibilityBatchOutput) GoString ¶
func (s ChangeMessageVisibilityBatchOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityBatchOutput) SetFailed ¶
func (s *ChangeMessageVisibilityBatchOutput) SetFailed(v []*BatchResultErrorEntry) *ChangeMessageVisibilityBatchOutput
SetFailed sets the Failed field's value.
func (*ChangeMessageVisibilityBatchOutput) SetSuccessful ¶
func (s *ChangeMessageVisibilityBatchOutput) SetSuccessful(v []*ChangeMessageVisibilityBatchResultEntry) *ChangeMessageVisibilityBatchOutput
SetSuccessful sets the Successful field's value.
func (ChangeMessageVisibilityBatchOutput) String ¶
func (s ChangeMessageVisibilityBatchOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChangeMessageVisibilityBatchRequestEntry ¶
type ChangeMessageVisibilityBatchRequestEntry struct { // An identifier for this particular receipt handle used to communicate the // result. // // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // A receipt handle. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // The new value (in seconds) for the message's visibility timeout. VisibilityTimeout *int64 `type:"integer"` // contains filtered or unexported fields }
Encloses a receipt handle and an entry ID for each message in ChangeMessageVisibilityBatch.
func (ChangeMessageVisibilityBatchRequestEntry) GoString ¶
func (s ChangeMessageVisibilityBatchRequestEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityBatchRequestEntry) SetId ¶
func (s *ChangeMessageVisibilityBatchRequestEntry) SetId(v string) *ChangeMessageVisibilityBatchRequestEntry
SetId sets the Id field's value.
func (*ChangeMessageVisibilityBatchRequestEntry) SetReceiptHandle ¶
func (s *ChangeMessageVisibilityBatchRequestEntry) SetReceiptHandle(v string) *ChangeMessageVisibilityBatchRequestEntry
SetReceiptHandle sets the ReceiptHandle field's value.
func (*ChangeMessageVisibilityBatchRequestEntry) SetVisibilityTimeout ¶
func (s *ChangeMessageVisibilityBatchRequestEntry) SetVisibilityTimeout(v int64) *ChangeMessageVisibilityBatchRequestEntry
SetVisibilityTimeout sets the VisibilityTimeout field's value.
func (ChangeMessageVisibilityBatchRequestEntry) String ¶
func (s ChangeMessageVisibilityBatchRequestEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityBatchRequestEntry) Validate ¶
func (s *ChangeMessageVisibilityBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeMessageVisibilityBatchResultEntry ¶
type ChangeMessageVisibilityBatchResultEntry struct { // Represents a message whose visibility timeout has been changed successfully. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Encloses the Id of an entry in ChangeMessageVisibilityBatch.
func (ChangeMessageVisibilityBatchResultEntry) GoString ¶
func (s ChangeMessageVisibilityBatchResultEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityBatchResultEntry) SetId ¶
func (s *ChangeMessageVisibilityBatchResultEntry) SetId(v string) *ChangeMessageVisibilityBatchResultEntry
SetId sets the Id field's value.
func (ChangeMessageVisibilityBatchResultEntry) String ¶
func (s ChangeMessageVisibilityBatchResultEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChangeMessageVisibilityInput ¶
type ChangeMessageVisibilityInput struct { // The URL of the Amazon SQS queue whose message's visibility is changed. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The receipt handle associated with the message, whose visibility timeout // is changed. This parameter is returned by the ReceiveMessage action. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // The new value for the message's visibility timeout (in seconds). Values range: // 0 to 43200. Maximum: 12 hours. // // VisibilityTimeout is a required field VisibilityTimeout *int64 `type:"integer" required:"true"` // contains filtered or unexported fields }
func (ChangeMessageVisibilityInput) GoString ¶
func (s ChangeMessageVisibilityInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityInput) SetQueueUrl ¶
func (s *ChangeMessageVisibilityInput) SetQueueUrl(v string) *ChangeMessageVisibilityInput
SetQueueUrl sets the QueueUrl field's value.
func (*ChangeMessageVisibilityInput) SetReceiptHandle ¶
func (s *ChangeMessageVisibilityInput) SetReceiptHandle(v string) *ChangeMessageVisibilityInput
SetReceiptHandle sets the ReceiptHandle field's value.
func (*ChangeMessageVisibilityInput) SetVisibilityTimeout ¶
func (s *ChangeMessageVisibilityInput) SetVisibilityTimeout(v int64) *ChangeMessageVisibilityInput
SetVisibilityTimeout sets the VisibilityTimeout field's value.
func (ChangeMessageVisibilityInput) String ¶
func (s ChangeMessageVisibilityInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ChangeMessageVisibilityInput) Validate ¶
func (s *ChangeMessageVisibilityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeMessageVisibilityOutput ¶
type ChangeMessageVisibilityOutput struct {
// contains filtered or unexported fields
}
func (ChangeMessageVisibilityOutput) GoString ¶
func (s ChangeMessageVisibilityOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (ChangeMessageVisibilityOutput) String ¶
func (s ChangeMessageVisibilityOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateQueueInput ¶
type CreateQueueInput struct { // A map of attributes with their corresponding values. // // The following lists the names, descriptions, and values of the special request // parameters that the CreateQueue action uses: // // * DelaySeconds – The length of time, in seconds, for which the delivery // of all messages in the queue is delayed. Valid values: An integer from // 0 to 900 seconds (15 minutes). Default: 0. // // * MaximumMessageSize – The limit of how many bytes a message can contain // before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes // (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). // // * MessageRetentionPeriod – The length of time, in seconds, for which // Amazon SQS retains a message. Valid values: An integer from 60 seconds // (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). // When you change a queue's attributes, the change can take up to 60 seconds // for most of the attributes to propagate throughout the Amazon SQS system. // Changes made to the MessageRetentionPeriod attribute can take up to 15 // minutes and will impact existing messages in the queue potentially causing // them to be expired and deleted if the MessageRetentionPeriod is reduced // below the age of existing messages. // // * Policy – The queue's policy. A valid Amazon Web Services policy. For // more information about policy structure, see Overview of Amazon Web Services // IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) // in the IAM User Guide. // // * ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for // which a ReceiveMessage action waits for a message to arrive. Valid values: // An integer from 0 to 20 (seconds). Default: 0. // // * VisibilityTimeout – The visibility timeout for the queue, in seconds. // Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For // more information about the visibility timeout, see Visibility Timeout // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon SQS Developer Guide. // // The following attributes apply only to dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // // * RedrivePolicy – The string that includes the parameters for the dead-letter // queue functionality of the source queue as a JSON object. The parameters // are as follows: deadLetterTargetArn – The Amazon Resource Name (ARN) // of the dead-letter queue to which Amazon SQS moves messages after the // value of maxReceiveCount is exceeded. maxReceiveCount – The number of // times a message is delivered to the source queue before being moved to // the dead-letter queue. Default: 10. When the ReceiveCount for a message // exceeds the maxReceiveCount for a queue, Amazon SQS moves the message // to the dead-letter-queue. // // * RedriveAllowPolicy – The string that includes the parameters for the // permissions for the dead-letter queue redrive permission and which source // queues can specify dead-letter queues as a JSON object. The parameters // are as follows: redrivePermission – The permission type that defines // which source queues can specify the current queue as the dead-letter queue. // Valid values are: allowAll – (Default) Any source queues in this Amazon // Web Services account in the same Region can specify this queue as the // dead-letter queue. denyAll – No source queues can specify this queue // as the dead-letter queue. byQueue – Only queues specified by the sourceQueueArns // parameter can specify this queue as the dead-letter queue. sourceQueueArns // – The Amazon Resource Names (ARN)s of the source queues that can specify // this queue as the dead-letter queue and redrive messages. You can specify // this parameter only when the redrivePermission parameter is set to byQueue. // You can specify up to 10 source queue ARNs. To allow more than 10 source // queues to specify dead-letter queues, set the redrivePermission parameter // to allowAll. // // The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, // the dead-letter queue of a standard queue must also be a standard queue. // // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): // // * KmsMasterKeyId – The ID of an Amazon Web Services managed customer // master key (CMK) for Amazon SQS or a custom CMK. For more information, // see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). // While the alias of the Amazon Web Services managed CMK for Amazon SQS // is always alias/aws/sqs, the alias of a custom CMK can, for example, be // alias/MyAlias . For more examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) // in the Key Management Service API Reference. // // * KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for // which Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) // to encrypt or decrypt messages before calling KMS again. An integer representing // seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). // Default: 300 (5 minutes). A shorter time period provides better security // but results in more calls to KMS which might incur charges after Free // Tier. For more information, see How Does the Data Key Reuse Period Work? // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) // // * SqsManagedSseEnabled – Enables server-side queue encryption using // SQS owned encryption keys. Only one server-side encryption option is supported // per queue (for example, SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). // // The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // // * FifoQueue – Designates a queue as FIFO. Valid values are true and // false. If you don't specify the FifoQueue attribute, Amazon SQS creates // a standard queue. You can provide this attribute only during queue creation. // You can't change it for an existing queue. When you set this attribute, // you must also provide the MessageGroupId for your messages explicitly. // For more information, see FIFO queue logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html) // in the Amazon SQS Developer Guide. // // * ContentBasedDeduplication – Enables content-based deduplication. Valid // values are true and false. For more information, see Exactly-once processing // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. Note the following: Every message must // have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId // explicitly. If you aren't able to provide a MessageDeduplicationId and // you enable ContentBasedDeduplication for your queue, Amazon SQS uses a // SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). If you don't provide // a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication // set, the action fails with an error. If the queue has ContentBasedDeduplication // set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication // is in effect, messages with identical content sent within the deduplication // interval are treated as duplicates and only one copy of the message is // delivered. If you send one message with ContentBasedDeduplication enabled // and then another message with a MessageDeduplicationId that is the same // as the one generated for the first MessageDeduplicationId, the two messages // are treated as duplicates and only one copy of the message is delivered. // // The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html): // // * DeduplicationScope – Specifies whether message deduplication occurs // at the message group or queue level. Valid values are messageGroup and // queue. // // * FifoThroughputLimit – Specifies whether the FIFO queue throughput // quota applies to the entire queue or per message group. Valid values are // perQueue and perMessageGroupId. The perMessageGroupId value is allowed // only when the value for DeduplicationScope is messageGroup. // // To enable high throughput for FIFO queues, do the following: // // * Set DeduplicationScope to messageGroup. // // * Set FifoThroughputLimit to perMessageGroupId. // // If you set these attributes to anything other than the values shown for enabling // high throughput, normal throughput is in effect and deduplication occurs // as specified. // // For information on throughput quotas, see Quotas related to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) // in the Amazon SQS Developer Guide. Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The name of the new queue. The following limits apply to this name: // // * A queue name can have up to 80 characters. // // * Valid values: alphanumeric characters, hyphens (-), and underscores // (_). // // * A FIFO queue name must end with the .fifo suffix. // // Queue URLs and names are case-sensitive. // // QueueName is a required field QueueName *string `type:"string" required:"true"` // Add cost allocation tags to the specified Amazon SQS queue. For an overview, // see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) // in the Amazon SQS Developer Guide. // // When you use queue tags, keep the following guidelines in mind: // // * Adding more than 50 tags to a queue isn't recommended. // // * Tags don't have any semantic meaning. Amazon SQS interprets tags as // character strings. // // * Tags are case-sensitive. // // * A new tag with a key identical to that of an existing tag overwrites // the existing tag. // // For a full list of tag restrictions, see Quotas related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) // in the Amazon SQS Developer Guide. // // To be able to tag a queue on creation, you must have the sqs:CreateQueue // and sqs:TagQueue permissions. // // Cross-account permissions don't apply to this action. For more information, // see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) // in the Amazon SQS Developer Guide. Tags map[string]*string `locationName:"Tag" locationNameKey:"Key" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
func (CreateQueueInput) GoString ¶
func (s CreateQueueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateQueueInput) SetAttributes ¶
func (s *CreateQueueInput) SetAttributes(v map[string]*string) *CreateQueueInput
SetAttributes sets the Attributes field's value.
func (*CreateQueueInput) SetQueueName ¶
func (s *CreateQueueInput) SetQueueName(v string) *CreateQueueInput
SetQueueName sets the QueueName field's value.
func (*CreateQueueInput) SetTags ¶
func (s *CreateQueueInput) SetTags(v map[string]*string) *CreateQueueInput
SetTags sets the Tags field's value.
func (CreateQueueInput) String ¶
func (s CreateQueueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateQueueInput) Validate ¶
func (s *CreateQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateQueueOutput ¶
type CreateQueueOutput struct { // The URL of the created Amazon SQS queue. QueueUrl *string `type:"string"` // contains filtered or unexported fields }
Returns the QueueUrl attribute of the created queue.
func (CreateQueueOutput) GoString ¶
func (s CreateQueueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*CreateQueueOutput) SetQueueUrl ¶
func (s *CreateQueueOutput) SetQueueUrl(v string) *CreateQueueOutput
SetQueueUrl sets the QueueUrl field's value.
func (CreateQueueOutput) String ¶
func (s CreateQueueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteMessageBatchInput ¶
type DeleteMessageBatchInput struct { // Lists the receipt handles for the messages to be deleted. // // Entries is a required field Entries []*DeleteMessageBatchRequestEntry `locationNameList:"DeleteMessageBatchRequestEntry" type:"list" flattened:"true" required:"true"` // The URL of the Amazon SQS queue from which messages are deleted. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteMessageBatchInput) GoString ¶
func (s DeleteMessageBatchInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageBatchInput) SetEntries ¶
func (s *DeleteMessageBatchInput) SetEntries(v []*DeleteMessageBatchRequestEntry) *DeleteMessageBatchInput
SetEntries sets the Entries field's value.
func (*DeleteMessageBatchInput) SetQueueUrl ¶
func (s *DeleteMessageBatchInput) SetQueueUrl(v string) *DeleteMessageBatchInput
SetQueueUrl sets the QueueUrl field's value.
func (DeleteMessageBatchInput) String ¶
func (s DeleteMessageBatchInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageBatchInput) Validate ¶
func (s *DeleteMessageBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMessageBatchOutput ¶
type DeleteMessageBatchOutput struct { // A list of BatchResultErrorEntry items. // // Failed is a required field Failed []*BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"` // A list of DeleteMessageBatchResultEntry items. // // Successful is a required field Successful []*DeleteMessageBatchResultEntry `locationNameList:"DeleteMessageBatchResultEntry" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.
func (DeleteMessageBatchOutput) GoString ¶
func (s DeleteMessageBatchOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageBatchOutput) SetFailed ¶
func (s *DeleteMessageBatchOutput) SetFailed(v []*BatchResultErrorEntry) *DeleteMessageBatchOutput
SetFailed sets the Failed field's value.
func (*DeleteMessageBatchOutput) SetSuccessful ¶
func (s *DeleteMessageBatchOutput) SetSuccessful(v []*DeleteMessageBatchResultEntry) *DeleteMessageBatchOutput
SetSuccessful sets the Successful field's value.
func (DeleteMessageBatchOutput) String ¶
func (s DeleteMessageBatchOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteMessageBatchRequestEntry ¶
type DeleteMessageBatchRequestEntry struct { // The identifier for this particular receipt handle. This is used to communicate // the result. // // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // A receipt handle. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // contains filtered or unexported fields }
Encloses a receipt handle and an identifier for it.
func (DeleteMessageBatchRequestEntry) GoString ¶
func (s DeleteMessageBatchRequestEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageBatchRequestEntry) SetId ¶
func (s *DeleteMessageBatchRequestEntry) SetId(v string) *DeleteMessageBatchRequestEntry
SetId sets the Id field's value.
func (*DeleteMessageBatchRequestEntry) SetReceiptHandle ¶
func (s *DeleteMessageBatchRequestEntry) SetReceiptHandle(v string) *DeleteMessageBatchRequestEntry
SetReceiptHandle sets the ReceiptHandle field's value.
func (DeleteMessageBatchRequestEntry) String ¶
func (s DeleteMessageBatchRequestEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageBatchRequestEntry) Validate ¶
func (s *DeleteMessageBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMessageBatchResultEntry ¶
type DeleteMessageBatchResultEntry struct { // Represents a successfully deleted message. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Encloses the Id of an entry in DeleteMessageBatch.
func (DeleteMessageBatchResultEntry) GoString ¶
func (s DeleteMessageBatchResultEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageBatchResultEntry) SetId ¶
func (s *DeleteMessageBatchResultEntry) SetId(v string) *DeleteMessageBatchResultEntry
SetId sets the Id field's value.
func (DeleteMessageBatchResultEntry) String ¶
func (s DeleteMessageBatchResultEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteMessageInput ¶
type DeleteMessageInput struct { // The URL of the Amazon SQS queue from which messages are deleted. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The receipt handle associated with the message to delete. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteMessageInput) GoString ¶
func (s DeleteMessageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageInput) SetQueueUrl ¶
func (s *DeleteMessageInput) SetQueueUrl(v string) *DeleteMessageInput
SetQueueUrl sets the QueueUrl field's value.
func (*DeleteMessageInput) SetReceiptHandle ¶
func (s *DeleteMessageInput) SetReceiptHandle(v string) *DeleteMessageInput
SetReceiptHandle sets the ReceiptHandle field's value.
func (DeleteMessageInput) String ¶
func (s DeleteMessageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteMessageInput) Validate ¶
func (s *DeleteMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMessageOutput ¶
type DeleteMessageOutput struct {
// contains filtered or unexported fields
}
func (DeleteMessageOutput) GoString ¶
func (s DeleteMessageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteMessageOutput) String ¶
func (s DeleteMessageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteQueueInput ¶
type DeleteQueueInput struct { // The URL of the Amazon SQS queue to delete. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteQueueInput) GoString ¶
func (s DeleteQueueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteQueueInput) SetQueueUrl ¶
func (s *DeleteQueueInput) SetQueueUrl(v string) *DeleteQueueInput
SetQueueUrl sets the QueueUrl field's value.
func (DeleteQueueInput) String ¶
func (s DeleteQueueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteQueueInput) Validate ¶
func (s *DeleteQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteQueueOutput ¶
type DeleteQueueOutput struct {
// contains filtered or unexported fields
}
func (DeleteQueueOutput) GoString ¶
func (s DeleteQueueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteQueueOutput) String ¶
func (s DeleteQueueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetQueueAttributesInput ¶
type GetQueueAttributesInput struct { // A list of attributes for which to retrieve information. // // The AttributeNames parameter is optional, but if you don't specify values // for this parameter, the request returns empty results. // // In the future, new attributes might be added. If you write code that calls // this action, we recommend that you structure your code so that it can handle // new attributes gracefully. // // The following attributes are supported: // // The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, // and ApproximateNumberOfMessages metrics may not achieve consistency until // at least 1 minute after the producers stop sending messages. This period // is required for the queue metadata to reach eventual consistency. // // * All – Returns all values. // // * ApproximateNumberOfMessages – Returns the approximate number of messages // available for retrieval from the queue. // // * ApproximateNumberOfMessagesDelayed – Returns the approximate number // of messages in the queue that are delayed and not available for reading // immediately. This can happen when the queue is configured as a delay queue // or when a message has been sent with a delay parameter. // // * ApproximateNumberOfMessagesNotVisible – Returns the approximate number // of messages that are in flight. Messages are considered to be in flight // if they have been sent to a client but have not yet been deleted or have // not yet reached the end of their visibility window. // // * CreatedTimestamp – Returns the time when the queue was created in // seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)). // // * DelaySeconds – Returns the default delay on the queue in seconds. // // * LastModifiedTimestamp – Returns the time when the queue was last changed // in seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)). // // * MaximumMessageSize – Returns the limit of how many bytes a message // can contain before Amazon SQS rejects it. // // * MessageRetentionPeriod – Returns the length of time, in seconds, for // which Amazon SQS retains a message. When you change a queue's attributes, // the change can take up to 60 seconds for most of the attributes to propagate // throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod // attribute can take up to 15 minutes and will impact existing messages // in the queue potentially causing them to be expired and deleted if the // MessageRetentionPeriod is reduced below the age of existing messages. // // * Policy – Returns the policy of the queue. // // * QueueArn – Returns the Amazon resource name (ARN) of the queue. // // * ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, // for which the ReceiveMessage action waits for a message to arrive. // // * VisibilityTimeout – Returns the visibility timeout for the queue. // For more information about the visibility timeout, see Visibility Timeout // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon SQS Developer Guide. // // The following attributes apply only to dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // // * RedrivePolicy – The string that includes the parameters for the dead-letter // queue functionality of the source queue as a JSON object. The parameters // are as follows: deadLetterTargetArn – The Amazon Resource Name (ARN) // of the dead-letter queue to which Amazon SQS moves messages after the // value of maxReceiveCount is exceeded. maxReceiveCount – The number of // times a message is delivered to the source queue before being moved to // the dead-letter queue. Default: 10. When the ReceiveCount for a message // exceeds the maxReceiveCount for a queue, Amazon SQS moves the message // to the dead-letter-queue. // // * RedriveAllowPolicy – The string that includes the parameters for the // permissions for the dead-letter queue redrive permission and which source // queues can specify dead-letter queues as a JSON object. The parameters // are as follows: redrivePermission – The permission type that defines // which source queues can specify the current queue as the dead-letter queue. // Valid values are: allowAll – (Default) Any source queues in this Amazon // Web Services account in the same Region can specify this queue as the // dead-letter queue. denyAll – No source queues can specify this queue // as the dead-letter queue. byQueue – Only queues specified by the sourceQueueArns // parameter can specify this queue as the dead-letter queue. sourceQueueArns // – The Amazon Resource Names (ARN)s of the source queues that can specify // this queue as the dead-letter queue and redrive messages. You can specify // this parameter only when the redrivePermission parameter is set to byQueue. // You can specify up to 10 source queue ARNs. To allow more than 10 source // queues to specify dead-letter queues, set the redrivePermission parameter // to allowAll. // // The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, // the dead-letter queue of a standard queue must also be a standard queue. // // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): // // * KmsMasterKeyId – Returns the ID of an Amazon Web Services managed // customer master key (CMK) for Amazon SQS or a custom CMK. For more information, // see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). // // * KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, // for which Amazon SQS can reuse a data key to encrypt or decrypt messages // before calling KMS again. For more information, see How Does the Data // Key Reuse Period Work? (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work). // // * SqsManagedSseEnabled – Returns information about whether the queue // is using SSE-SQS encryption using SQS owned encryption keys. Only one // server-side encryption option is supported per queue (for example, SSE-KMS // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). // // The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // // * FifoQueue – Returns information about whether the queue is FIFO. For // more information, see FIFO queue logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html) // in the Amazon SQS Developer Guide. To determine whether a queue is FIFO // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), // you can check whether QueueName ends with the .fifo suffix. // // * ContentBasedDeduplication – Returns whether content-based deduplication // is enabled for the queue. For more information, see Exactly-once processing // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. // // The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html): // // * DeduplicationScope – Specifies whether message deduplication occurs // at the message group or queue level. Valid values are messageGroup and // queue. // // * FifoThroughputLimit – Specifies whether the FIFO queue throughput // quota applies to the entire queue or per message group. Valid values are // perQueue and perMessageGroupId. The perMessageGroupId value is allowed // only when the value for DeduplicationScope is messageGroup. // // To enable high throughput for FIFO queues, do the following: // // * Set DeduplicationScope to messageGroup. // // * Set FifoThroughputLimit to perMessageGroupId. // // If you set these attributes to anything other than the values shown for enabling // high throughput, normal throughput is in effect and deduplication occurs // as specified. // // For information on throughput quotas, see Quotas related to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) // in the Amazon SQS Developer Guide. AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true" enum:"QueueAttributeName"` // The URL of the Amazon SQS queue whose attribute information is retrieved. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (GetQueueAttributesInput) GoString ¶
func (s GetQueueAttributesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetQueueAttributesInput) SetAttributeNames ¶
func (s *GetQueueAttributesInput) SetAttributeNames(v []*string) *GetQueueAttributesInput
SetAttributeNames sets the AttributeNames field's value.
func (*GetQueueAttributesInput) SetQueueUrl ¶
func (s *GetQueueAttributesInput) SetQueueUrl(v string) *GetQueueAttributesInput
SetQueueUrl sets the QueueUrl field's value.
func (GetQueueAttributesInput) String ¶
func (s GetQueueAttributesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetQueueAttributesInput) Validate ¶
func (s *GetQueueAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetQueueAttributesOutput ¶
type GetQueueAttributesOutput struct { // A map of attributes to their respective values. Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
A list of returned queue attributes.
func (GetQueueAttributesOutput) GoString ¶
func (s GetQueueAttributesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetQueueAttributesOutput) SetAttributes ¶
func (s *GetQueueAttributesOutput) SetAttributes(v map[string]*string) *GetQueueAttributesOutput
SetAttributes sets the Attributes field's value.
func (GetQueueAttributesOutput) String ¶
func (s GetQueueAttributesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetQueueUrlInput ¶
type GetQueueUrlInput struct { // The name of the queue whose URL must be fetched. Maximum 80 characters. Valid // values: alphanumeric characters, hyphens (-), and underscores (_). // // Queue URLs and names are case-sensitive. // // QueueName is a required field QueueName *string `type:"string" required:"true"` // The Amazon Web Services account ID of the account that created the queue. QueueOwnerAWSAccountId *string `type:"string"` // contains filtered or unexported fields }
func (GetQueueUrlInput) GoString ¶
func (s GetQueueUrlInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetQueueUrlInput) SetQueueName ¶
func (s *GetQueueUrlInput) SetQueueName(v string) *GetQueueUrlInput
SetQueueName sets the QueueName field's value.
func (*GetQueueUrlInput) SetQueueOwnerAWSAccountId ¶
func (s *GetQueueUrlInput) SetQueueOwnerAWSAccountId(v string) *GetQueueUrlInput
SetQueueOwnerAWSAccountId sets the QueueOwnerAWSAccountId field's value.
func (GetQueueUrlInput) String ¶
func (s GetQueueUrlInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetQueueUrlInput) Validate ¶
func (s *GetQueueUrlInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetQueueUrlOutput ¶
type GetQueueUrlOutput struct { // The URL of the queue. QueueUrl *string `type:"string"` // contains filtered or unexported fields }
For more information, see Interpreting Responses (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html) in the Amazon SQS Developer Guide.
func (GetQueueUrlOutput) GoString ¶
func (s GetQueueUrlOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetQueueUrlOutput) SetQueueUrl ¶
func (s *GetQueueUrlOutput) SetQueueUrl(v string) *GetQueueUrlOutput
SetQueueUrl sets the QueueUrl field's value.
func (GetQueueUrlOutput) String ¶
func (s GetQueueUrlOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListDeadLetterSourceQueuesInput ¶
type ListDeadLetterSourceQueuesInput struct { // Maximum number of results to include in the response. Value range is 1 to // 1000. You must set MaxResults to receive a value for NextToken in the response. MaxResults *int64 `type:"integer"` // Pagination token to request the next set of results. NextToken *string `type:"string"` // The URL of a dead-letter queue. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListDeadLetterSourceQueuesInput) GoString ¶
func (s ListDeadLetterSourceQueuesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListDeadLetterSourceQueuesInput) SetMaxResults ¶
func (s *ListDeadLetterSourceQueuesInput) SetMaxResults(v int64) *ListDeadLetterSourceQueuesInput
SetMaxResults sets the MaxResults field's value.
func (*ListDeadLetterSourceQueuesInput) SetNextToken ¶
func (s *ListDeadLetterSourceQueuesInput) SetNextToken(v string) *ListDeadLetterSourceQueuesInput
SetNextToken sets the NextToken field's value.
func (*ListDeadLetterSourceQueuesInput) SetQueueUrl ¶
func (s *ListDeadLetterSourceQueuesInput) SetQueueUrl(v string) *ListDeadLetterSourceQueuesInput
SetQueueUrl sets the QueueUrl field's value.
func (ListDeadLetterSourceQueuesInput) String ¶
func (s ListDeadLetterSourceQueuesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListDeadLetterSourceQueuesInput) Validate ¶
func (s *ListDeadLetterSourceQueuesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDeadLetterSourceQueuesOutput ¶
type ListDeadLetterSourceQueuesOutput struct { // Pagination token to include in the next request. Token value is null if there // are no additional results to request, or if you did not set MaxResults in // the request. NextToken *string `type:"string"` // A list of source queue URLs that have the RedrivePolicy queue attribute configured // with a dead-letter queue. // // QueueUrls is a required field QueueUrls []*string `locationName:"queueUrls" locationNameList:"QueueUrl" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
A list of your dead letter source queues.
func (ListDeadLetterSourceQueuesOutput) GoString ¶
func (s ListDeadLetterSourceQueuesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListDeadLetterSourceQueuesOutput) SetNextToken ¶
func (s *ListDeadLetterSourceQueuesOutput) SetNextToken(v string) *ListDeadLetterSourceQueuesOutput
SetNextToken sets the NextToken field's value.
func (*ListDeadLetterSourceQueuesOutput) SetQueueUrls ¶
func (s *ListDeadLetterSourceQueuesOutput) SetQueueUrls(v []*string) *ListDeadLetterSourceQueuesOutput
SetQueueUrls sets the QueueUrls field's value.
func (ListDeadLetterSourceQueuesOutput) String ¶
func (s ListDeadLetterSourceQueuesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListMessageMoveTasksInput ¶ added in v1.42.9
type ListMessageMoveTasksInput struct { // The maximum number of results to include in the response. The default is // 1, which provides the most recent message movement task. The upper limit // is 10. MaxResults *int64 `type:"integer"` // The ARN of the queue whose message movement tasks are to be listed. // // SourceArn is a required field SourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListMessageMoveTasksInput) GoString ¶ added in v1.42.9
func (s ListMessageMoveTasksInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListMessageMoveTasksInput) SetMaxResults ¶ added in v1.42.9
func (s *ListMessageMoveTasksInput) SetMaxResults(v int64) *ListMessageMoveTasksInput
SetMaxResults sets the MaxResults field's value.
func (*ListMessageMoveTasksInput) SetSourceArn ¶ added in v1.42.9
func (s *ListMessageMoveTasksInput) SetSourceArn(v string) *ListMessageMoveTasksInput
SetSourceArn sets the SourceArn field's value.
func (ListMessageMoveTasksInput) String ¶ added in v1.42.9
func (s ListMessageMoveTasksInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListMessageMoveTasksInput) Validate ¶ added in v1.42.9
func (s *ListMessageMoveTasksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListMessageMoveTasksOutput ¶ added in v1.42.9
type ListMessageMoveTasksOutput struct { // A list of message movement tasks and their attributes. Results []*ListMessageMoveTasksResultEntry `locationNameList:"ListMessageMoveTasksResultEntry" type:"list" flattened:"true"` // contains filtered or unexported fields }
func (ListMessageMoveTasksOutput) GoString ¶ added in v1.42.9
func (s ListMessageMoveTasksOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListMessageMoveTasksOutput) SetResults ¶ added in v1.42.9
func (s *ListMessageMoveTasksOutput) SetResults(v []*ListMessageMoveTasksResultEntry) *ListMessageMoveTasksOutput
SetResults sets the Results field's value.
func (ListMessageMoveTasksOutput) String ¶ added in v1.42.9
func (s ListMessageMoveTasksOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListMessageMoveTasksResultEntry ¶ added in v1.42.9
type ListMessageMoveTasksResultEntry struct { // The approximate number of messages already moved to the destination queue. ApproximateNumberOfMessagesMoved *int64 `type:"long"` // The number of messages to be moved from the source queue. This number is // obtained at the time of starting the message movement task. ApproximateNumberOfMessagesToMove *int64 `type:"long"` // The ARN of the destination queue if it has been specified in the StartMessageMoveTask // request. If a DestinationArn has not been specified in the StartMessageMoveTask // request, this field value will be NULL. DestinationArn *string `type:"string"` // The task failure reason (only included if the task status is FAILED). FailureReason *string `type:"string"` // The number of messages to be moved per second (the message movement rate), // if it has been specified in the StartMessageMoveTask request. If a MaxNumberOfMessagesPerSecond // has not been specified in the StartMessageMoveTask request, this field value // will be NULL. MaxNumberOfMessagesPerSecond *int64 `type:"integer"` // The ARN of the queue that contains the messages to be moved to another queue. SourceArn *string `type:"string"` // The timestamp of starting the message movement task. StartedTimestamp *int64 `type:"long"` // The status of the message movement task. Possible values are: RUNNING, COMPLETED, // CANCELLING, CANCELLED, and FAILED. Status *string `type:"string"` // An identifier associated with a message movement task. When this field is // returned in the response of the ListMessageMoveTasks action, it is only populated // for tasks that are in RUNNING status. TaskHandle *string `type:"string"` // contains filtered or unexported fields }
Contains the details of a message movement task.
func (ListMessageMoveTasksResultEntry) GoString ¶ added in v1.42.9
func (s ListMessageMoveTasksResultEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListMessageMoveTasksResultEntry) SetApproximateNumberOfMessagesMoved ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetApproximateNumberOfMessagesMoved(v int64) *ListMessageMoveTasksResultEntry
SetApproximateNumberOfMessagesMoved sets the ApproximateNumberOfMessagesMoved field's value.
func (*ListMessageMoveTasksResultEntry) SetApproximateNumberOfMessagesToMove ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetApproximateNumberOfMessagesToMove(v int64) *ListMessageMoveTasksResultEntry
SetApproximateNumberOfMessagesToMove sets the ApproximateNumberOfMessagesToMove field's value.
func (*ListMessageMoveTasksResultEntry) SetDestinationArn ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetDestinationArn(v string) *ListMessageMoveTasksResultEntry
SetDestinationArn sets the DestinationArn field's value.
func (*ListMessageMoveTasksResultEntry) SetFailureReason ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetFailureReason(v string) *ListMessageMoveTasksResultEntry
SetFailureReason sets the FailureReason field's value.
func (*ListMessageMoveTasksResultEntry) SetMaxNumberOfMessagesPerSecond ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetMaxNumberOfMessagesPerSecond(v int64) *ListMessageMoveTasksResultEntry
SetMaxNumberOfMessagesPerSecond sets the MaxNumberOfMessagesPerSecond field's value.
func (*ListMessageMoveTasksResultEntry) SetSourceArn ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetSourceArn(v string) *ListMessageMoveTasksResultEntry
SetSourceArn sets the SourceArn field's value.
func (*ListMessageMoveTasksResultEntry) SetStartedTimestamp ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetStartedTimestamp(v int64) *ListMessageMoveTasksResultEntry
SetStartedTimestamp sets the StartedTimestamp field's value.
func (*ListMessageMoveTasksResultEntry) SetStatus ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetStatus(v string) *ListMessageMoveTasksResultEntry
SetStatus sets the Status field's value.
func (*ListMessageMoveTasksResultEntry) SetTaskHandle ¶ added in v1.42.9
func (s *ListMessageMoveTasksResultEntry) SetTaskHandle(v string) *ListMessageMoveTasksResultEntry
SetTaskHandle sets the TaskHandle field's value.
func (ListMessageMoveTasksResultEntry) String ¶ added in v1.42.9
func (s ListMessageMoveTasksResultEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListQueueTagsInput ¶
type ListQueueTagsInput struct { // The URL of the queue. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListQueueTagsInput) GoString ¶
func (s ListQueueTagsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListQueueTagsInput) SetQueueUrl ¶
func (s *ListQueueTagsInput) SetQueueUrl(v string) *ListQueueTagsInput
SetQueueUrl sets the QueueUrl field's value.
func (ListQueueTagsInput) String ¶
func (s ListQueueTagsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListQueueTagsInput) Validate ¶
func (s *ListQueueTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListQueueTagsOutput ¶
type ListQueueTagsOutput struct { // The list of all tags added to the specified queue. Tags map[string]*string `locationName:"Tag" locationNameKey:"Key" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
func (ListQueueTagsOutput) GoString ¶
func (s ListQueueTagsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListQueueTagsOutput) SetTags ¶
func (s *ListQueueTagsOutput) SetTags(v map[string]*string) *ListQueueTagsOutput
SetTags sets the Tags field's value.
func (ListQueueTagsOutput) String ¶
func (s ListQueueTagsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListQueuesInput ¶
type ListQueuesInput struct { // Maximum number of results to include in the response. Value range is 1 to // 1000. You must set MaxResults to receive a value for NextToken in the response. MaxResults *int64 `type:"integer"` // Pagination token to request the next set of results. NextToken *string `type:"string"` // A string to use for filtering the list results. Only those queues whose name // begins with the specified string are returned. // // Queue URLs and names are case-sensitive. QueueNamePrefix *string `type:"string"` // contains filtered or unexported fields }
func (ListQueuesInput) GoString ¶
func (s ListQueuesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListQueuesInput) SetMaxResults ¶
func (s *ListQueuesInput) SetMaxResults(v int64) *ListQueuesInput
SetMaxResults sets the MaxResults field's value.
func (*ListQueuesInput) SetNextToken ¶
func (s *ListQueuesInput) SetNextToken(v string) *ListQueuesInput
SetNextToken sets the NextToken field's value.
func (*ListQueuesInput) SetQueueNamePrefix ¶
func (s *ListQueuesInput) SetQueueNamePrefix(v string) *ListQueuesInput
SetQueueNamePrefix sets the QueueNamePrefix field's value.
func (ListQueuesInput) String ¶
func (s ListQueuesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListQueuesOutput ¶
type ListQueuesOutput struct { // Pagination token to include in the next request. Token value is null if there // are no additional results to request, or if you did not set MaxResults in // the request. NextToken *string `type:"string"` // A list of queue URLs, up to 1,000 entries, or the value of MaxResults that // you sent in the request. QueueUrls []*string `locationNameList:"QueueUrl" type:"list" flattened:"true"` // contains filtered or unexported fields }
A list of your queues.
func (ListQueuesOutput) GoString ¶
func (s ListQueuesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListQueuesOutput) SetNextToken ¶
func (s *ListQueuesOutput) SetNextToken(v string) *ListQueuesOutput
SetNextToken sets the NextToken field's value.
func (*ListQueuesOutput) SetQueueUrls ¶
func (s *ListQueuesOutput) SetQueueUrls(v []*string) *ListQueuesOutput
SetQueueUrls sets the QueueUrls field's value.
func (ListQueuesOutput) String ¶
func (s ListQueuesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Message ¶
type Message struct { // A map of the attributes requested in ReceiveMessage to their respective values. // Supported attributes: // // * ApproximateReceiveCount // // * ApproximateFirstReceiveTimestamp // // * MessageDeduplicationId // // * MessageGroupId // // * SenderId // // * SentTimestamp // // * SequenceNumber // // ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an // integer representing the epoch time (http://en.wikipedia.org/wiki/Unix_time) // in milliseconds. Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The message's contents (not URL-encoded). Body *string `type:"string"` // An MD5 digest of the non-URL-encoded message body string. MD5OfBody *string `type:"string"` // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageAttributes *string `type:"string"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // A unique identifier for the message. A MessageIdis considered unique across // all Amazon Web Services accounts for an extended period of time. MessageId *string `type:"string"` // An identifier associated with the act of receiving the message. A new receipt // handle is returned every time you receive a message. When deleting a message, // you provide the last received receipt handle to delete the message. ReceiptHandle *string `type:"string"` // contains filtered or unexported fields }
An Amazon SQS message.
func (Message) GoString ¶
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Message) SetAttributes ¶
SetAttributes sets the Attributes field's value.
func (*Message) SetMD5OfBody ¶
SetMD5OfBody sets the MD5OfBody field's value.
func (*Message) SetMD5OfMessageAttributes ¶
SetMD5OfMessageAttributes sets the MD5OfMessageAttributes field's value.
func (*Message) SetMessageAttributes ¶
func (s *Message) SetMessageAttributes(v map[string]*MessageAttributeValue) *Message
SetMessageAttributes sets the MessageAttributes field's value.
func (*Message) SetMessageId ¶
SetMessageId sets the MessageId field's value.
func (*Message) SetReceiptHandle ¶
SetReceiptHandle sets the ReceiptHandle field's value.
type MessageAttributeValue ¶
type MessageAttributeValue struct { // Not implemented. Reserved for future use. BinaryListValues [][]byte `locationName:"BinaryListValue" locationNameList:"BinaryListValue" type:"list" flattened:"true"` // Binary type attributes can store any binary data, such as compressed data, // encrypted data, or images. // BinaryValue is automatically base64 encoded/decoded by the SDK. BinaryValue []byte `type:"blob"` // Amazon SQS supports the following logical data types: String, Number, and // Binary. For the Number data type, you must use StringValue. // // You can also append custom labels. For more information, see Amazon SQS Message // Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. // // DataType is a required field DataType *string `type:"string" required:"true"` // Not implemented. Reserved for future use. StringListValues []*string `locationName:"StringListValue" locationNameList:"StringListValue" type:"list" flattened:"true"` // Strings are Unicode with UTF-8 binary encoding. For a list of code values, // see ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). StringValue *string `type:"string"` // contains filtered or unexported fields }
The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KiB or 262,144 bytes).
func (MessageAttributeValue) GoString ¶
func (s MessageAttributeValue) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MessageAttributeValue) SetBinaryListValues ¶
func (s *MessageAttributeValue) SetBinaryListValues(v [][]byte) *MessageAttributeValue
SetBinaryListValues sets the BinaryListValues field's value.
func (*MessageAttributeValue) SetBinaryValue ¶
func (s *MessageAttributeValue) SetBinaryValue(v []byte) *MessageAttributeValue
SetBinaryValue sets the BinaryValue field's value.
func (*MessageAttributeValue) SetDataType ¶
func (s *MessageAttributeValue) SetDataType(v string) *MessageAttributeValue
SetDataType sets the DataType field's value.
func (*MessageAttributeValue) SetStringListValues ¶
func (s *MessageAttributeValue) SetStringListValues(v []*string) *MessageAttributeValue
SetStringListValues sets the StringListValues field's value.
func (*MessageAttributeValue) SetStringValue ¶
func (s *MessageAttributeValue) SetStringValue(v string) *MessageAttributeValue
SetStringValue sets the StringValue field's value.
func (MessageAttributeValue) String ¶
func (s MessageAttributeValue) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MessageAttributeValue) Validate ¶
func (s *MessageAttributeValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MessageSystemAttributeValue ¶
type MessageSystemAttributeValue struct { // Not implemented. Reserved for future use. BinaryListValues [][]byte `locationName:"BinaryListValue" locationNameList:"BinaryListValue" type:"list" flattened:"true"` // Binary type attributes can store any binary data, such as compressed data, // encrypted data, or images. // BinaryValue is automatically base64 encoded/decoded by the SDK. BinaryValue []byte `type:"blob"` // Amazon SQS supports the following logical data types: String, Number, and // Binary. For the Number data type, you must use StringValue. // // You can also append custom labels. For more information, see Amazon SQS Message // Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. // // DataType is a required field DataType *string `type:"string" required:"true"` // Not implemented. Reserved for future use. StringListValues []*string `locationName:"StringListValue" locationNameList:"StringListValue" type:"list" flattened:"true"` // Strings are Unicode with UTF-8 binary encoding. For a list of code values, // see ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). StringValue *string `type:"string"` // contains filtered or unexported fields }
The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
Name, type, value and the message body must not be empty or null.
func (MessageSystemAttributeValue) GoString ¶
func (s MessageSystemAttributeValue) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MessageSystemAttributeValue) SetBinaryListValues ¶
func (s *MessageSystemAttributeValue) SetBinaryListValues(v [][]byte) *MessageSystemAttributeValue
SetBinaryListValues sets the BinaryListValues field's value.
func (*MessageSystemAttributeValue) SetBinaryValue ¶
func (s *MessageSystemAttributeValue) SetBinaryValue(v []byte) *MessageSystemAttributeValue
SetBinaryValue sets the BinaryValue field's value.
func (*MessageSystemAttributeValue) SetDataType ¶
func (s *MessageSystemAttributeValue) SetDataType(v string) *MessageSystemAttributeValue
SetDataType sets the DataType field's value.
func (*MessageSystemAttributeValue) SetStringListValues ¶
func (s *MessageSystemAttributeValue) SetStringListValues(v []*string) *MessageSystemAttributeValue
SetStringListValues sets the StringListValues field's value.
func (*MessageSystemAttributeValue) SetStringValue ¶
func (s *MessageSystemAttributeValue) SetStringValue(v string) *MessageSystemAttributeValue
SetStringValue sets the StringValue field's value.
func (MessageSystemAttributeValue) String ¶
func (s MessageSystemAttributeValue) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*MessageSystemAttributeValue) Validate ¶
func (s *MessageSystemAttributeValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PurgeQueueInput ¶
type PurgeQueueInput struct { // The URL of the queue from which the PurgeQueue action deletes messages. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (PurgeQueueInput) GoString ¶
func (s PurgeQueueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PurgeQueueInput) SetQueueUrl ¶
func (s *PurgeQueueInput) SetQueueUrl(v string) *PurgeQueueInput
SetQueueUrl sets the QueueUrl field's value.
func (PurgeQueueInput) String ¶
func (s PurgeQueueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PurgeQueueInput) Validate ¶
func (s *PurgeQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PurgeQueueOutput ¶
type PurgeQueueOutput struct {
// contains filtered or unexported fields
}
func (PurgeQueueOutput) GoString ¶
func (s PurgeQueueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (PurgeQueueOutput) String ¶
func (s PurgeQueueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ReceiveMessageInput ¶
type ReceiveMessageInput struct { // A list of attributes that need to be returned along with each message. These // attributes include: // // * All – Returns all values. // // * ApproximateFirstReceiveTimestamp – Returns the time the message was // first received from the queue (epoch time (http://en.wikipedia.org/wiki/Unix_time) // in milliseconds). // // * ApproximateReceiveCount – Returns the number of times a message has // been received across all queues but not deleted. // // * AWSTraceHeader – Returns the X-Ray trace header string. // // * SenderId For a user, returns the user ID, for example ABCDEFGHI1JKLMNOPQ23R. // For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. // // * SentTimestamp – Returns the time the message was sent to the queue // (epoch time (http://en.wikipedia.org/wiki/Unix_time) in milliseconds). // // * SqsManagedSseEnabled – Enables server-side queue encryption using // SQS owned encryption keys. Only one server-side encryption option is supported // per queue (for example, SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). // // * MessageDeduplicationId – Returns the value provided by the producer // that calls the SendMessage action. // // * MessageGroupId – Returns the value provided by the producer that calls // the SendMessage action. Messages with the same MessageGroupId are returned // in sequence. // // * SequenceNumber – Returns the value provided by Amazon SQS. AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true" enum:"QueueAttributeName"` // The maximum number of messages to return. Amazon SQS never returns more messages // than this value (however, fewer messages might be returned). Valid values: // 1 to 10. Default: 1. MaxNumberOfMessages *int64 `type:"integer"` // The name of the message attribute, where N is the index. // // * The name can contain alphanumeric characters and the underscore (_), // hyphen (-), and period (.). // // * The name is case-sensitive and must be unique among all attribute names // for the message. // // * The name must not start with AWS-reserved prefixes such as AWS. or Amazon. // (or any casing variants). // // * The name must not start or end with a period (.), and it should not // have periods in succession (..). // // * The name can be up to 256 characters long. // // When using ReceiveMessage, you can send a list of attribute names to receive, // or you can return all of the attributes by specifying All or .* in your request. // You can also use all message attributes starting with a prefix, for example // bar.*. MessageAttributeNames []*string `locationNameList:"MessageAttributeName" type:"list" flattened:"true"` // The URL of the Amazon SQS queue from which messages are received. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The token used for deduplication of ReceiveMessage calls. If a networking // issue occurs after a ReceiveMessage action, and instead of a response you // receive a generic error, it is possible to retry the same action with an // identical ReceiveRequestAttemptId to retrieve the same set of messages, even // if their visibility timeout has not yet expired. // // * You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage // action. // // * When you set FifoQueue, a caller of the ReceiveMessage action can provide // a ReceiveRequestAttemptId explicitly. // // * If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, // Amazon SQS generates a ReceiveRequestAttemptId. // // * It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId // if none of the messages have been modified (deleted or had their visibility // changes). // // * During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId // return the same messages and receipt handles. If a retry occurs within // the deduplication interval, it resets the visibility timeout. For more // information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon SQS Developer Guide. If a caller of the ReceiveMessage action // still processes messages when the visibility timeout expires and messages // become visible, another worker consuming from the same queue can receive // the same messages and therefore process duplicates. Also, if a consumer // whose message processing time is longer than the visibility timeout tries // to delete the processed messages, the action fails with an error. To mitigate // this effect, ensure that your application observes a safe threshold before // the visibility timeout expires and extend the visibility timeout as necessary. // // * While messages with a particular MessageGroupId are invisible, no more // messages belonging to the same MessageGroupId are returned until the visibility // timeout expires. You can still receive messages with another MessageGroupId // as long as it is also visible. // // * If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, // no retries work until the original visibility timeout expires. As a result, // delays might occur but the messages in the queue remain in a strict order. // // The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId // Request Parameter (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html) // in the Amazon SQS Developer Guide. ReceiveRequestAttemptId *string `type:"string"` // The duration (in seconds) that the received messages are hidden from subsequent // retrieve requests after being retrieved by a ReceiveMessage request. VisibilityTimeout *int64 `type:"integer"` // The duration (in seconds) for which the call waits for a message to arrive // in the queue before returning. If a message is available, the call returns // sooner than WaitTimeSeconds. If no messages are available and the wait time // expires, the call returns successfully with an empty list of messages. // // To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage // requests is longer than the WaitTimeSeconds parameter. For example, with // the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) // for asynchronous clients, or the ApacheHttpClient (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) // for synchronous clients. WaitTimeSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
func (ReceiveMessageInput) GoString ¶
func (s ReceiveMessageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ReceiveMessageInput) SetAttributeNames ¶
func (s *ReceiveMessageInput) SetAttributeNames(v []*string) *ReceiveMessageInput
SetAttributeNames sets the AttributeNames field's value.
func (*ReceiveMessageInput) SetMaxNumberOfMessages ¶
func (s *ReceiveMessageInput) SetMaxNumberOfMessages(v int64) *ReceiveMessageInput
SetMaxNumberOfMessages sets the MaxNumberOfMessages field's value.
func (*ReceiveMessageInput) SetMessageAttributeNames ¶
func (s *ReceiveMessageInput) SetMessageAttributeNames(v []*string) *ReceiveMessageInput
SetMessageAttributeNames sets the MessageAttributeNames field's value.
func (*ReceiveMessageInput) SetQueueUrl ¶
func (s *ReceiveMessageInput) SetQueueUrl(v string) *ReceiveMessageInput
SetQueueUrl sets the QueueUrl field's value.
func (*ReceiveMessageInput) SetReceiveRequestAttemptId ¶
func (s *ReceiveMessageInput) SetReceiveRequestAttemptId(v string) *ReceiveMessageInput
SetReceiveRequestAttemptId sets the ReceiveRequestAttemptId field's value.
func (*ReceiveMessageInput) SetVisibilityTimeout ¶
func (s *ReceiveMessageInput) SetVisibilityTimeout(v int64) *ReceiveMessageInput
SetVisibilityTimeout sets the VisibilityTimeout field's value.
func (*ReceiveMessageInput) SetWaitTimeSeconds ¶
func (s *ReceiveMessageInput) SetWaitTimeSeconds(v int64) *ReceiveMessageInput
SetWaitTimeSeconds sets the WaitTimeSeconds field's value.
func (ReceiveMessageInput) String ¶
func (s ReceiveMessageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ReceiveMessageInput) Validate ¶
func (s *ReceiveMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ReceiveMessageOutput ¶
type ReceiveMessageOutput struct { // A list of messages. Messages []*Message `locationNameList:"Message" type:"list" flattened:"true"` // contains filtered or unexported fields }
A list of received messages.
func (ReceiveMessageOutput) GoString ¶
func (s ReceiveMessageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ReceiveMessageOutput) SetMessages ¶
func (s *ReceiveMessageOutput) SetMessages(v []*Message) *ReceiveMessageOutput
SetMessages sets the Messages field's value.
func (ReceiveMessageOutput) String ¶
func (s ReceiveMessageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RemovePermissionInput ¶
type RemovePermissionInput struct { // The identification of the permission to remove. This is the label added using // the AddPermission action. // // Label is a required field Label *string `type:"string" required:"true"` // The URL of the Amazon SQS queue from which permissions are removed. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (RemovePermissionInput) GoString ¶
func (s RemovePermissionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RemovePermissionInput) SetLabel ¶
func (s *RemovePermissionInput) SetLabel(v string) *RemovePermissionInput
SetLabel sets the Label field's value.
func (*RemovePermissionInput) SetQueueUrl ¶
func (s *RemovePermissionInput) SetQueueUrl(v string) *RemovePermissionInput
SetQueueUrl sets the QueueUrl field's value.
func (RemovePermissionInput) String ¶
func (s RemovePermissionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*RemovePermissionInput) Validate ¶
func (s *RemovePermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemovePermissionOutput ¶
type RemovePermissionOutput struct {
// contains filtered or unexported fields
}
func (RemovePermissionOutput) GoString ¶
func (s RemovePermissionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (RemovePermissionOutput) String ¶
func (s RemovePermissionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SQS ¶
SQS provides the API operation methods for making requests to Amazon Simple Queue Service. See this package's package overview docs for details on the service.
SQS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *SQS
New creates a new instance of the SQS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a SQS client from just a session. svc := sqs.New(mySession) // Create a SQS client with additional configuration svc := sqs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*SQS) AddPermission ¶
func (c *SQS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)
AddPermission API operation for Amazon Simple Queue Service.
Adds a permission to a queue for a specific principal (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P). This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) in the Amazon SQS Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account principal.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation AddPermission for usage and error information.
Returned Error Codes:
- ErrCodeOverLimit "OverLimit" The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of in flight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermission
func (*SQS) AddPermissionRequest ¶
func (c *SQS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)
AddPermissionRequest generates a "aws/request.Request" representing the client's request for the AddPermission operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AddPermission for more information on using the AddPermission API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AddPermissionRequest method. req, resp := client.AddPermissionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermission
func (*SQS) AddPermissionWithContext ¶
func (c *SQS) AddPermissionWithContext(ctx aws.Context, input *AddPermissionInput, opts ...request.Option) (*AddPermissionOutput, error)
AddPermissionWithContext is the same as AddPermission with the addition of the ability to pass a context and additional request options.
See AddPermission for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) CancelMessageMoveTask ¶ added in v1.42.9
func (c *SQS) CancelMessageMoveTask(input *CancelMessageMoveTaskInput) (*CancelMessageMoveTaskOutput, error)
CancelMessageMoveTask API operation for Amazon Simple Queue Service.
Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues are supported.
Only one active message movement task is supported per queue at any given time.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation CancelMessageMoveTask for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more specified resources don't exist.
ErrCodeUnsupportedOperation "AWS.SimpleQueueService.UnsupportedOperation" Error code 400. Unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTask
func (*SQS) CancelMessageMoveTaskRequest ¶ added in v1.42.9
func (c *SQS) CancelMessageMoveTaskRequest(input *CancelMessageMoveTaskInput) (req *request.Request, output *CancelMessageMoveTaskOutput)
CancelMessageMoveTaskRequest generates a "aws/request.Request" representing the client's request for the CancelMessageMoveTask operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CancelMessageMoveTask for more information on using the CancelMessageMoveTask API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CancelMessageMoveTaskRequest method. req, resp := client.CancelMessageMoveTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTask
func (*SQS) CancelMessageMoveTaskWithContext ¶ added in v1.42.9
func (c *SQS) CancelMessageMoveTaskWithContext(ctx aws.Context, input *CancelMessageMoveTaskInput, opts ...request.Option) (*CancelMessageMoveTaskOutput, error)
CancelMessageMoveTaskWithContext is the same as CancelMessageMoveTask with the addition of the ability to pass a context and additional request options.
See CancelMessageMoveTask for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ChangeMessageVisibility ¶
func (c *SQS) ChangeMessageVisibility(input *ChangeMessageVisibilityInput) (*ChangeMessageVisibilityOutput, error)
ChangeMessageVisibility API operation for Amazon Simple Queue Service.
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon SQS Developer Guide.
For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from the time that you make the ChangeMessageVisibility call. Thus, any attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the visibility timeout (a total of 25 seconds) might result in an error.
An Amazon SQS message has three basic states:
Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs).
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ChangeMessageVisibility for usage and error information.
Returned Error Codes:
ErrCodeMessageNotInflight "AWS.SimpleQueueService.MessageNotInflight" The specified message isn't in flight.
ErrCodeReceiptHandleIsInvalid "ReceiptHandleIsInvalid" The specified receipt handle isn't valid.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibility
func (*SQS) ChangeMessageVisibilityBatch ¶
func (c *SQS) ChangeMessageVisibilityBatch(input *ChangeMessageVisibilityBatchInput) (*ChangeMessageVisibilityBatchOutput, error)
ChangeMessageVisibilityBatch API operation for Amazon Simple Queue Service.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ChangeMessageVisibilityBatch for usage and error information.
Returned Error Codes:
ErrCodeTooManyEntriesInBatchRequest "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.
ErrCodeEmptyBatchRequest "AWS.SimpleQueueService.EmptyBatchRequest" The batch request doesn't contain any entries.
ErrCodeBatchEntryIdsNotDistinct "AWS.SimpleQueueService.BatchEntryIdsNotDistinct" Two or more batch entries in the request have the same Id.
ErrCodeInvalidBatchEntryId "AWS.SimpleQueueService.InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatch
func (*SQS) ChangeMessageVisibilityBatchRequest ¶
func (c *SQS) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibilityBatchInput) (req *request.Request, output *ChangeMessageVisibilityBatchOutput)
ChangeMessageVisibilityBatchRequest generates a "aws/request.Request" representing the client's request for the ChangeMessageVisibilityBatch operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ChangeMessageVisibilityBatch for more information on using the ChangeMessageVisibilityBatch API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ChangeMessageVisibilityBatchRequest method. req, resp := client.ChangeMessageVisibilityBatchRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatch
func (*SQS) ChangeMessageVisibilityBatchWithContext ¶
func (c *SQS) ChangeMessageVisibilityBatchWithContext(ctx aws.Context, input *ChangeMessageVisibilityBatchInput, opts ...request.Option) (*ChangeMessageVisibilityBatchOutput, error)
ChangeMessageVisibilityBatchWithContext is the same as ChangeMessageVisibilityBatch with the addition of the ability to pass a context and additional request options.
See ChangeMessageVisibilityBatch for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ChangeMessageVisibilityRequest ¶
func (c *SQS) ChangeMessageVisibilityRequest(input *ChangeMessageVisibilityInput) (req *request.Request, output *ChangeMessageVisibilityOutput)
ChangeMessageVisibilityRequest generates a "aws/request.Request" representing the client's request for the ChangeMessageVisibility operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ChangeMessageVisibility for more information on using the ChangeMessageVisibility API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ChangeMessageVisibilityRequest method. req, resp := client.ChangeMessageVisibilityRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibility
func (*SQS) ChangeMessageVisibilityWithContext ¶
func (c *SQS) ChangeMessageVisibilityWithContext(ctx aws.Context, input *ChangeMessageVisibilityInput, opts ...request.Option) (*ChangeMessageVisibilityOutput, error)
ChangeMessageVisibilityWithContext is the same as ChangeMessageVisibility with the addition of the ability to pass a context and additional request options.
See ChangeMessageVisibility for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) CreateQueue ¶
func (c *SQS) CreateQueue(input *CreateQueueInput) (*CreateQueueOutput, error)
CreateQueue API operation for Amazon Simple Queue Service.
Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) in the Amazon SQS Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation CreateQueue for usage and error information.
Returned Error Codes:
ErrCodeQueueDeletedRecently "AWS.SimpleQueueService.QueueDeletedRecently" You must wait 60 seconds after deleting a queue before you can create another queue with the same name.
ErrCodeQueueNameExists "QueueAlreadyExists" A queue with this name already exists. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueue
func (*SQS) CreateQueueRequest ¶
func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, output *CreateQueueOutput)
CreateQueueRequest generates a "aws/request.Request" representing the client's request for the CreateQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateQueue for more information on using the CreateQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateQueueRequest method. req, resp := client.CreateQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueue
func (*SQS) CreateQueueWithContext ¶
func (c *SQS) CreateQueueWithContext(ctx aws.Context, input *CreateQueueInput, opts ...request.Option) (*CreateQueueOutput, error)
CreateQueueWithContext is the same as CreateQueue with the addition of the ability to pass a context and additional request options.
See CreateQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) DeleteMessage ¶
func (c *SQS) DeleteMessage(input *DeleteMessageInput) (*DeleteMessageOutput, error)
DeleteMessage API operation for Amazon Simple Queue Service.
Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation DeleteMessage for usage and error information.
Returned Error Codes:
ErrCodeInvalidIdFormat "InvalidIdFormat" The specified receipt handle isn't valid for the current version.
ErrCodeReceiptHandleIsInvalid "ReceiptHandleIsInvalid" The specified receipt handle isn't valid.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessage
func (*SQS) DeleteMessageBatch ¶
func (c *SQS) DeleteMessageBatch(input *DeleteMessageBatchInput) (*DeleteMessageBatchOutput, error)
DeleteMessageBatch API operation for Amazon Simple Queue Service.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation DeleteMessageBatch for usage and error information.
Returned Error Codes:
ErrCodeTooManyEntriesInBatchRequest "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.
ErrCodeEmptyBatchRequest "AWS.SimpleQueueService.EmptyBatchRequest" The batch request doesn't contain any entries.
ErrCodeBatchEntryIdsNotDistinct "AWS.SimpleQueueService.BatchEntryIdsNotDistinct" Two or more batch entries in the request have the same Id.
ErrCodeInvalidBatchEntryId "AWS.SimpleQueueService.InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatch
func (*SQS) DeleteMessageBatchRequest ¶
func (c *SQS) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) (req *request.Request, output *DeleteMessageBatchOutput)
DeleteMessageBatchRequest generates a "aws/request.Request" representing the client's request for the DeleteMessageBatch operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteMessageBatch for more information on using the DeleteMessageBatch API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteMessageBatchRequest method. req, resp := client.DeleteMessageBatchRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatch
func (*SQS) DeleteMessageBatchWithContext ¶
func (c *SQS) DeleteMessageBatchWithContext(ctx aws.Context, input *DeleteMessageBatchInput, opts ...request.Option) (*DeleteMessageBatchOutput, error)
DeleteMessageBatchWithContext is the same as DeleteMessageBatch with the addition of the ability to pass a context and additional request options.
See DeleteMessageBatch for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) DeleteMessageRequest ¶
func (c *SQS) DeleteMessageRequest(input *DeleteMessageInput) (req *request.Request, output *DeleteMessageOutput)
DeleteMessageRequest generates a "aws/request.Request" representing the client's request for the DeleteMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteMessage for more information on using the DeleteMessage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteMessageRequest method. req, resp := client.DeleteMessageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessage
func (*SQS) DeleteMessageWithContext ¶
func (c *SQS) DeleteMessageWithContext(ctx aws.Context, input *DeleteMessageInput, opts ...request.Option) (*DeleteMessageOutput, error)
DeleteMessageWithContext is the same as DeleteMessage with the addition of the ability to pass a context and additional request options.
See DeleteMessage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) DeleteQueue ¶
func (c *SQS) DeleteQueue(input *DeleteQueueInput) (*DeleteQueueOutput, error)
DeleteQueue API operation for Amazon Simple Queue Service.
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
The delete operation uses the HTTP GET verb.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation DeleteQueue for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueue
func (*SQS) DeleteQueueRequest ¶
func (c *SQS) DeleteQueueRequest(input *DeleteQueueInput) (req *request.Request, output *DeleteQueueOutput)
DeleteQueueRequest generates a "aws/request.Request" representing the client's request for the DeleteQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteQueue for more information on using the DeleteQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteQueueRequest method. req, resp := client.DeleteQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueue
func (*SQS) DeleteQueueWithContext ¶
func (c *SQS) DeleteQueueWithContext(ctx aws.Context, input *DeleteQueueInput, opts ...request.Option) (*DeleteQueueOutput, error)
DeleteQueueWithContext is the same as DeleteQueue with the addition of the ability to pass a context and additional request options.
See DeleteQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) GetQueueAttributes ¶
func (c *SQS) GetQueueAttributes(input *GetQueueAttributesInput) (*GetQueueAttributesOutput, error)
GetQueueAttributes API operation for Amazon Simple Queue Service.
Gets attributes for the specified queue.
To determine whether a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), you can check whether QueueName ends with the .fifo suffix.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation GetQueueAttributes for usage and error information.
Returned Error Codes:
- ErrCodeInvalidAttributeName "InvalidAttributeName" The specified attribute doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributes
func (*SQS) GetQueueAttributesRequest ¶
func (c *SQS) GetQueueAttributesRequest(input *GetQueueAttributesInput) (req *request.Request, output *GetQueueAttributesOutput)
GetQueueAttributesRequest generates a "aws/request.Request" representing the client's request for the GetQueueAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetQueueAttributes for more information on using the GetQueueAttributes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetQueueAttributesRequest method. req, resp := client.GetQueueAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributes
func (*SQS) GetQueueAttributesWithContext ¶
func (c *SQS) GetQueueAttributesWithContext(ctx aws.Context, input *GetQueueAttributesInput, opts ...request.Option) (*GetQueueAttributesOutput, error)
GetQueueAttributesWithContext is the same as GetQueueAttributes with the addition of the ability to pass a context and additional request options.
See GetQueueAttributes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) GetQueueUrl ¶
func (c *SQS) GetQueueUrl(input *GetQueueUrlInput) (*GetQueueUrlOutput, error)
GetQueueUrl API operation for Amazon Simple Queue Service.
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation GetQueueUrl for usage and error information.
Returned Error Codes:
- ErrCodeQueueDoesNotExist "AWS.SimpleQueueService.NonExistentQueue" The specified queue doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrl
func (*SQS) GetQueueUrlRequest ¶
func (c *SQS) GetQueueUrlRequest(input *GetQueueUrlInput) (req *request.Request, output *GetQueueUrlOutput)
GetQueueUrlRequest generates a "aws/request.Request" representing the client's request for the GetQueueUrl operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetQueueUrl for more information on using the GetQueueUrl API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetQueueUrlRequest method. req, resp := client.GetQueueUrlRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrl
func (*SQS) GetQueueUrlWithContext ¶
func (c *SQS) GetQueueUrlWithContext(ctx aws.Context, input *GetQueueUrlInput, opts ...request.Option) (*GetQueueUrlOutput, error)
GetQueueUrlWithContext is the same as GetQueueUrl with the addition of the ability to pass a context and additional request options.
See GetQueueUrl for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ListDeadLetterSourceQueues ¶
func (c *SQS) ListDeadLetterSourceQueues(input *ListDeadLetterSourceQueuesInput) (*ListDeadLetterSourceQueuesOutput, error)
ListDeadLetterSourceQueues API operation for Amazon Simple Queue Service.
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ListDeadLetterSourceQueues for usage and error information.
Returned Error Codes:
- ErrCodeQueueDoesNotExist "AWS.SimpleQueueService.NonExistentQueue" The specified queue doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues
func (*SQS) ListDeadLetterSourceQueuesPages ¶
func (c *SQS) ListDeadLetterSourceQueuesPages(input *ListDeadLetterSourceQueuesInput, fn func(*ListDeadLetterSourceQueuesOutput, bool) bool) error
ListDeadLetterSourceQueuesPages iterates over the pages of a ListDeadLetterSourceQueues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDeadLetterSourceQueues method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDeadLetterSourceQueues operation. pageNum := 0 err := client.ListDeadLetterSourceQueuesPages(params, func(page *sqs.ListDeadLetterSourceQueuesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SQS) ListDeadLetterSourceQueuesPagesWithContext ¶
func (c *SQS) ListDeadLetterSourceQueuesPagesWithContext(ctx aws.Context, input *ListDeadLetterSourceQueuesInput, fn func(*ListDeadLetterSourceQueuesOutput, bool) bool, opts ...request.Option) error
ListDeadLetterSourceQueuesPagesWithContext same as ListDeadLetterSourceQueuesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ListDeadLetterSourceQueuesRequest ¶
func (c *SQS) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueuesInput) (req *request.Request, output *ListDeadLetterSourceQueuesOutput)
ListDeadLetterSourceQueuesRequest generates a "aws/request.Request" representing the client's request for the ListDeadLetterSourceQueues operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDeadLetterSourceQueues for more information on using the ListDeadLetterSourceQueues API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDeadLetterSourceQueuesRequest method. req, resp := client.ListDeadLetterSourceQueuesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues
func (*SQS) ListDeadLetterSourceQueuesWithContext ¶
func (c *SQS) ListDeadLetterSourceQueuesWithContext(ctx aws.Context, input *ListDeadLetterSourceQueuesInput, opts ...request.Option) (*ListDeadLetterSourceQueuesOutput, error)
ListDeadLetterSourceQueuesWithContext is the same as ListDeadLetterSourceQueues with the addition of the ability to pass a context and additional request options.
See ListDeadLetterSourceQueues for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ListMessageMoveTasks ¶ added in v1.42.9
func (c *SQS) ListMessageMoveTasks(input *ListMessageMoveTasksInput) (*ListMessageMoveTasksOutput, error)
ListMessageMoveTasks API operation for Amazon Simple Queue Service.
Gets the most recent message movement tasks (up to 10) under a specific source queue.
This action is currently limited to supporting message redrive from dead-letter queues (DLQs) (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues are supported.
Only one active message movement task is supported per queue at any given time.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ListMessageMoveTasks for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more specified resources don't exist.
ErrCodeUnsupportedOperation "AWS.SimpleQueueService.UnsupportedOperation" Error code 400. Unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasks
func (*SQS) ListMessageMoveTasksRequest ¶ added in v1.42.9
func (c *SQS) ListMessageMoveTasksRequest(input *ListMessageMoveTasksInput) (req *request.Request, output *ListMessageMoveTasksOutput)
ListMessageMoveTasksRequest generates a "aws/request.Request" representing the client's request for the ListMessageMoveTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListMessageMoveTasks for more information on using the ListMessageMoveTasks API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListMessageMoveTasksRequest method. req, resp := client.ListMessageMoveTasksRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasks
func (*SQS) ListMessageMoveTasksWithContext ¶ added in v1.42.9
func (c *SQS) ListMessageMoveTasksWithContext(ctx aws.Context, input *ListMessageMoveTasksInput, opts ...request.Option) (*ListMessageMoveTasksOutput, error)
ListMessageMoveTasksWithContext is the same as ListMessageMoveTasks with the addition of the ability to pass a context and additional request options.
See ListMessageMoveTasks for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ListQueueTags ¶
func (c *SQS) ListQueueTags(input *ListQueueTagsInput) (*ListQueueTagsOutput, error)
ListQueueTags API operation for Amazon Simple Queue Service.
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ListQueueTags for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueueTags
func (*SQS) ListQueueTagsRequest ¶
func (c *SQS) ListQueueTagsRequest(input *ListQueueTagsInput) (req *request.Request, output *ListQueueTagsOutput)
ListQueueTagsRequest generates a "aws/request.Request" representing the client's request for the ListQueueTags operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListQueueTags for more information on using the ListQueueTags API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListQueueTagsRequest method. req, resp := client.ListQueueTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueueTags
func (*SQS) ListQueueTagsWithContext ¶
func (c *SQS) ListQueueTagsWithContext(ctx aws.Context, input *ListQueueTagsInput, opts ...request.Option) (*ListQueueTagsOutput, error)
ListQueueTagsWithContext is the same as ListQueueTags with the addition of the ability to pass a context and additional request options.
See ListQueueTags for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ListQueues ¶
func (c *SQS) ListQueues(input *ListQueuesInput) (*ListQueuesOutput, error)
ListQueues API operation for Amazon Simple Queue Service.
Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
The listQueues methods supports pagination. Set parameter MaxResults in the request to specify the maximum number of results to be returned in the response. If you do not set MaxResults, the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to display, the response includes a value for NextToken. Use NextToken as a parameter in your next request to listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ListQueues for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues
func (*SQS) ListQueuesPages ¶
func (c *SQS) ListQueuesPages(input *ListQueuesInput, fn func(*ListQueuesOutput, bool) bool) error
ListQueuesPages iterates over the pages of a ListQueues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListQueues method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListQueues operation. pageNum := 0 err := client.ListQueuesPages(params, func(page *sqs.ListQueuesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*SQS) ListQueuesPagesWithContext ¶
func (c *SQS) ListQueuesPagesWithContext(ctx aws.Context, input *ListQueuesInput, fn func(*ListQueuesOutput, bool) bool, opts ...request.Option) error
ListQueuesPagesWithContext same as ListQueuesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ListQueuesRequest ¶
func (c *SQS) ListQueuesRequest(input *ListQueuesInput) (req *request.Request, output *ListQueuesOutput)
ListQueuesRequest generates a "aws/request.Request" representing the client's request for the ListQueues operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListQueues for more information on using the ListQueues API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListQueuesRequest method. req, resp := client.ListQueuesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues
func (*SQS) ListQueuesWithContext ¶
func (c *SQS) ListQueuesWithContext(ctx aws.Context, input *ListQueuesInput, opts ...request.Option) (*ListQueuesOutput, error)
ListQueuesWithContext is the same as ListQueues with the addition of the ability to pass a context and additional request options.
See ListQueues for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) PurgeQueue ¶
func (c *SQS) PurgeQueue(input *PurgeQueueInput) (*PurgeQueueOutput, error)
PurgeQueue API operation for Amazon Simple Queue Service.
Deletes available messages in a queue (including in-flight messages) specified by the QueueURL parameter.
When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.
Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation PurgeQueue for usage and error information.
Returned Error Codes:
ErrCodeQueueDoesNotExist "AWS.SimpleQueueService.NonExistentQueue" The specified queue doesn't exist.
ErrCodePurgeQueueInProgress "AWS.SimpleQueueService.PurgeQueueInProgress" Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueue
func (*SQS) PurgeQueueRequest ¶
func (c *SQS) PurgeQueueRequest(input *PurgeQueueInput) (req *request.Request, output *PurgeQueueOutput)
PurgeQueueRequest generates a "aws/request.Request" representing the client's request for the PurgeQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PurgeQueue for more information on using the PurgeQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PurgeQueueRequest method. req, resp := client.PurgeQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueue
func (*SQS) PurgeQueueWithContext ¶
func (c *SQS) PurgeQueueWithContext(ctx aws.Context, input *PurgeQueueInput, opts ...request.Option) (*PurgeQueueOutput, error)
PurgeQueueWithContext is the same as PurgeQueue with the addition of the ability to pass a context and additional request options.
See PurgeQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) ReceiveMessage ¶
func (c *SQS) ReceiveMessage(input *ReceiveMessageInput) (*ReceiveMessageOutput, error)
ReceiveMessage API operation for Amazon Simple Queue Service.
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation ReceiveMessage for usage and error information.
Returned Error Codes:
- ErrCodeOverLimit "OverLimit" The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of in flight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessage
func (*SQS) ReceiveMessageRequest ¶
func (c *SQS) ReceiveMessageRequest(input *ReceiveMessageInput) (req *request.Request, output *ReceiveMessageOutput)
ReceiveMessageRequest generates a "aws/request.Request" representing the client's request for the ReceiveMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ReceiveMessage for more information on using the ReceiveMessage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ReceiveMessageRequest method. req, resp := client.ReceiveMessageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessage
func (*SQS) ReceiveMessageWithContext ¶
func (c *SQS) ReceiveMessageWithContext(ctx aws.Context, input *ReceiveMessageInput, opts ...request.Option) (*ReceiveMessageOutput, error)
ReceiveMessageWithContext is the same as ReceiveMessage with the addition of the ability to pass a context and additional request options.
See ReceiveMessage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) RemovePermission ¶
func (c *SQS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)
RemovePermission API operation for Amazon Simple Queue Service.
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation RemovePermission for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RemovePermission
func (*SQS) RemovePermissionRequest ¶
func (c *SQS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)
RemovePermissionRequest generates a "aws/request.Request" representing the client's request for the RemovePermission operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See RemovePermission for more information on using the RemovePermission API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the RemovePermissionRequest method. req, resp := client.RemovePermissionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RemovePermission
func (*SQS) RemovePermissionWithContext ¶
func (c *SQS) RemovePermissionWithContext(ctx aws.Context, input *RemovePermissionInput, opts ...request.Option) (*RemovePermissionOutput, error)
RemovePermissionWithContext is the same as RemovePermission with the addition of the ability to pass a context and additional request options.
See RemovePermission for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) SendMessage ¶
func (c *SQS) SendMessage(input *SendMessageInput) (*SendMessageOutput, error)
SendMessage API operation for Amazon Simple Queue Service.
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation SendMessage for usage and error information.
Returned Error Codes:
ErrCodeInvalidMessageContents "InvalidMessageContents" The message contains characters outside the allowed set.
ErrCodeUnsupportedOperation "AWS.SimpleQueueService.UnsupportedOperation" Error code 400. Unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessage
func (*SQS) SendMessageBatch ¶
func (c *SQS) SendMessageBatch(input *SendMessageBatchInput) (*SendMessageBatchOutput, error)
SendMessageBatch API operation for Amazon Simple Queue Service.
You can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message (or by not assigning values at all). This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation SendMessageBatch for usage and error information.
Returned Error Codes:
ErrCodeTooManyEntriesInBatchRequest "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.
ErrCodeEmptyBatchRequest "AWS.SimpleQueueService.EmptyBatchRequest" The batch request doesn't contain any entries.
ErrCodeBatchEntryIdsNotDistinct "AWS.SimpleQueueService.BatchEntryIdsNotDistinct" Two or more batch entries in the request have the same Id.
ErrCodeBatchRequestTooLong "AWS.SimpleQueueService.BatchRequestTooLong" The length of all the messages put together is more than the limit.
ErrCodeInvalidBatchEntryId "AWS.SimpleQueueService.InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.
ErrCodeUnsupportedOperation "AWS.SimpleQueueService.UnsupportedOperation" Error code 400. Unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatch
func (*SQS) SendMessageBatchRequest ¶
func (c *SQS) SendMessageBatchRequest(input *SendMessageBatchInput) (req *request.Request, output *SendMessageBatchOutput)
SendMessageBatchRequest generates a "aws/request.Request" representing the client's request for the SendMessageBatch operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SendMessageBatch for more information on using the SendMessageBatch API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SendMessageBatchRequest method. req, resp := client.SendMessageBatchRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatch
func (*SQS) SendMessageBatchWithContext ¶
func (c *SQS) SendMessageBatchWithContext(ctx aws.Context, input *SendMessageBatchInput, opts ...request.Option) (*SendMessageBatchOutput, error)
SendMessageBatchWithContext is the same as SendMessageBatch with the addition of the ability to pass a context and additional request options.
See SendMessageBatch for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) SendMessageRequest ¶
func (c *SQS) SendMessageRequest(input *SendMessageInput) (req *request.Request, output *SendMessageOutput)
SendMessageRequest generates a "aws/request.Request" representing the client's request for the SendMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SendMessage for more information on using the SendMessage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SendMessageRequest method. req, resp := client.SendMessageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessage
func (*SQS) SendMessageWithContext ¶
func (c *SQS) SendMessageWithContext(ctx aws.Context, input *SendMessageInput, opts ...request.Option) (*SendMessageOutput, error)
SendMessageWithContext is the same as SendMessage with the addition of the ability to pass a context and additional request options.
See SendMessage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) SetQueueAttributes ¶
func (c *SQS) SetQueueAttributes(input *SetQueueAttributesInput) (*SetQueueAttributesOutput, error)
SetQueueAttributes API operation for Amazon Simple Queue Service.
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation SetQueueAttributes for usage and error information.
Returned Error Codes:
- ErrCodeInvalidAttributeName "InvalidAttributeName" The specified attribute doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributes
func (*SQS) SetQueueAttributesRequest ¶
func (c *SQS) SetQueueAttributesRequest(input *SetQueueAttributesInput) (req *request.Request, output *SetQueueAttributesOutput)
SetQueueAttributesRequest generates a "aws/request.Request" representing the client's request for the SetQueueAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SetQueueAttributes for more information on using the SetQueueAttributes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SetQueueAttributesRequest method. req, resp := client.SetQueueAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributes
func (*SQS) SetQueueAttributesWithContext ¶
func (c *SQS) SetQueueAttributesWithContext(ctx aws.Context, input *SetQueueAttributesInput, opts ...request.Option) (*SetQueueAttributesOutput, error)
SetQueueAttributesWithContext is the same as SetQueueAttributes with the addition of the ability to pass a context and additional request options.
See SetQueueAttributes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) StartMessageMoveTask ¶ added in v1.42.9
func (c *SQS) StartMessageMoveTask(input *StartMessageMoveTaskInput) (*StartMessageMoveTaskOutput, error)
StartMessageMoveTask API operation for Amazon Simple Queue Service.
Starts an asynchronous task to move messages from a specified source queue to a specified destination queue.
This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues (DLQs) (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported.
In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues support redrive. FIFO queues don't support redrive.
Only one active message movement task is supported per queue at any given time.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation StartMessageMoveTask for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more specified resources don't exist.
ErrCodeUnsupportedOperation "AWS.SimpleQueueService.UnsupportedOperation" Error code 400. Unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTask
func (*SQS) StartMessageMoveTaskRequest ¶ added in v1.42.9
func (c *SQS) StartMessageMoveTaskRequest(input *StartMessageMoveTaskInput) (req *request.Request, output *StartMessageMoveTaskOutput)
StartMessageMoveTaskRequest generates a "aws/request.Request" representing the client's request for the StartMessageMoveTask operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartMessageMoveTask for more information on using the StartMessageMoveTask API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartMessageMoveTaskRequest method. req, resp := client.StartMessageMoveTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTask
func (*SQS) StartMessageMoveTaskWithContext ¶ added in v1.42.9
func (c *SQS) StartMessageMoveTaskWithContext(ctx aws.Context, input *StartMessageMoveTaskInput, opts ...request.Option) (*StartMessageMoveTaskOutput, error)
StartMessageMoveTaskWithContext is the same as StartMessageMoveTask with the addition of the ability to pass a context and additional request options.
See StartMessageMoveTask for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) TagQueue ¶
func (c *SQS) TagQueue(input *TagQueueInput) (*TagQueueOutput, error)
TagQueue API operation for Amazon Simple Queue Service.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) in the Amazon SQS Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Quotas related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation TagQueue for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TagQueue
func (*SQS) TagQueueRequest ¶
func (c *SQS) TagQueueRequest(input *TagQueueInput) (req *request.Request, output *TagQueueOutput)
TagQueueRequest generates a "aws/request.Request" representing the client's request for the TagQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagQueue for more information on using the TagQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagQueueRequest method. req, resp := client.TagQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TagQueue
func (*SQS) TagQueueWithContext ¶
func (c *SQS) TagQueueWithContext(ctx aws.Context, input *TagQueueInput, opts ...request.Option) (*TagQueueOutput, error)
TagQueueWithContext is the same as TagQueue with the addition of the ability to pass a context and additional request options.
See TagQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*SQS) UntagQueue ¶
func (c *SQS) UntagQueue(input *UntagQueueInput) (*UntagQueueOutput, error)
UntagQueue API operation for Amazon Simple Queue Service.
Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) in the Amazon SQS Developer Guide.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) in the Amazon SQS Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Simple Queue Service's API operation UntagQueue for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UntagQueue
func (*SQS) UntagQueueRequest ¶
func (c *SQS) UntagQueueRequest(input *UntagQueueInput) (req *request.Request, output *UntagQueueOutput)
UntagQueueRequest generates a "aws/request.Request" representing the client's request for the UntagQueue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagQueue for more information on using the UntagQueue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagQueueRequest method. req, resp := client.UntagQueueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UntagQueue
func (*SQS) UntagQueueWithContext ¶
func (c *SQS) UntagQueueWithContext(ctx aws.Context, input *UntagQueueInput, opts ...request.Option) (*UntagQueueOutput, error)
UntagQueueWithContext is the same as UntagQueue with the addition of the ability to pass a context and additional request options.
See UntagQueue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type SendMessageBatchInput ¶
type SendMessageBatchInput struct { // A list of SendMessageBatchRequestEntry items. // // Entries is a required field Entries []*SendMessageBatchRequestEntry `locationNameList:"SendMessageBatchRequestEntry" type:"list" flattened:"true" required:"true"` // The URL of the Amazon SQS queue to which batched messages are sent. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (SendMessageBatchInput) GoString ¶
func (s SendMessageBatchInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageBatchInput) SetEntries ¶
func (s *SendMessageBatchInput) SetEntries(v []*SendMessageBatchRequestEntry) *SendMessageBatchInput
SetEntries sets the Entries field's value.
func (*SendMessageBatchInput) SetQueueUrl ¶
func (s *SendMessageBatchInput) SetQueueUrl(v string) *SendMessageBatchInput
SetQueueUrl sets the QueueUrl field's value.
func (SendMessageBatchInput) String ¶
func (s SendMessageBatchInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageBatchInput) Validate ¶
func (s *SendMessageBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageBatchOutput ¶
type SendMessageBatchOutput struct { // A list of BatchResultErrorEntry items with error details about each message // that can't be enqueued. // // Failed is a required field Failed []*BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"` // A list of SendMessageBatchResultEntry items. // // Successful is a required field Successful []*SendMessageBatchResultEntry `locationNameList:"SendMessageBatchResultEntry" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
func (SendMessageBatchOutput) GoString ¶
func (s SendMessageBatchOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageBatchOutput) SetFailed ¶
func (s *SendMessageBatchOutput) SetFailed(v []*BatchResultErrorEntry) *SendMessageBatchOutput
SetFailed sets the Failed field's value.
func (*SendMessageBatchOutput) SetSuccessful ¶
func (s *SendMessageBatchOutput) SetSuccessful(v []*SendMessageBatchResultEntry) *SendMessageBatchOutput
SetSuccessful sets the Successful field's value.
func (SendMessageBatchOutput) String ¶
func (s SendMessageBatchOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SendMessageBatchRequestEntry ¶
type SendMessageBatchRequestEntry struct { // The length of time, in seconds, for which a specific message is delayed. // Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds // value become available for processing after the delay period is finished. // If you don't specify a value, the default value for the queue is applied. // // When you set FifoQueue, you can't set DelaySeconds per message. You can set // this parameter only on a queue level. DelaySeconds *int64 `type:"integer"` // An identifier for a message in this batch used to communicate the result. // // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The body of the message. // // MessageBody is a required field MessageBody *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The token used for deduplication of messages within a 5-minute minimum deduplication // interval. If a message with a particular MessageDeduplicationId is sent successfully, // subsequent messages with the same MessageDeduplicationId are accepted successfully // but aren't delivered. For more information, see Exactly-once processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. // // * Every message must have a unique MessageDeduplicationId, You may provide // a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId // and you enable ContentBasedDeduplication for your queue, Amazon SQS uses // a SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). If you don't provide // a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication // set, the action fails with an error. If the queue has ContentBasedDeduplication // set, your MessageDeduplicationId overrides the generated one. // // * When ContentBasedDeduplication is in effect, messages with identical // content sent within the deduplication interval are treated as duplicates // and only one copy of the message is delivered. // // * If you send one message with ContentBasedDeduplication enabled and then // another message with a MessageDeduplicationId that is the same as the // one generated for the first MessageDeduplicationId, the two messages are // treated as duplicates and only one copy of the message is delivered. // // The MessageDeduplicationId is available to the consumer of the message (this // can be useful for troubleshooting delivery issues). // // If a message is sent successfully but the acknowledgement is lost and the // message is resent with the same MessageDeduplicationId after the deduplication // interval, Amazon SQS can't detect duplicate messages. // // Amazon SQS continues to keep track of the message deduplication ID even after // the message is received and deleted. // // The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon SQS Developer Guide. MessageDeduplicationId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The tag that specifies that a message belongs to a specific message group. // Messages that belong to the same message group are processed in a FIFO manner // (however, messages in different message groups might be processed out of // order). To interleave multiple ordered streams within a single queue, use // MessageGroupId values (for example, session data for multiple users). In // this scenario, multiple consumers can process the queue, but the session // data of each user is processed in a FIFO fashion. // // * You must associate a non-empty MessageGroupId with a message. If you // don't provide a MessageGroupId, the action fails. // // * ReceiveMessage might return messages with multiple MessageGroupId values. // For each MessageGroupId, the messages are sorted by time sent. The caller // can't specify a MessageGroupId. // // The length of MessageGroupId is 128 characters. Valid values: alphanumeric // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageGroupId, see Using the MessageGroupId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) // in the Amazon SQS Developer Guide. // // MessageGroupId is required for FIFO queues. You can't use it for Standard // queues. MessageGroupId *string `type:"string"` // The message system attribute to send Each message system attribute consists // of a Name, Type, and Value. // // * Currently, the only supported message system attribute is AWSTraceHeader. // Its type must be String and its value must be a correctly formatted X-Ray // trace header string. // // * The size of a message system attribute doesn't count towards the total // size of a message. MessageSystemAttributes map[string]*MessageSystemAttributeValue `locationName:"MessageSystemAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
Contains the details of a single Amazon SQS message along with an Id.
func (SendMessageBatchRequestEntry) GoString ¶
func (s SendMessageBatchRequestEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageBatchRequestEntry) SetDelaySeconds ¶
func (s *SendMessageBatchRequestEntry) SetDelaySeconds(v int64) *SendMessageBatchRequestEntry
SetDelaySeconds sets the DelaySeconds field's value.
func (*SendMessageBatchRequestEntry) SetId ¶
func (s *SendMessageBatchRequestEntry) SetId(v string) *SendMessageBatchRequestEntry
SetId sets the Id field's value.
func (*SendMessageBatchRequestEntry) SetMessageAttributes ¶
func (s *SendMessageBatchRequestEntry) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendMessageBatchRequestEntry
SetMessageAttributes sets the MessageAttributes field's value.
func (*SendMessageBatchRequestEntry) SetMessageBody ¶
func (s *SendMessageBatchRequestEntry) SetMessageBody(v string) *SendMessageBatchRequestEntry
SetMessageBody sets the MessageBody field's value.
func (*SendMessageBatchRequestEntry) SetMessageDeduplicationId ¶
func (s *SendMessageBatchRequestEntry) SetMessageDeduplicationId(v string) *SendMessageBatchRequestEntry
SetMessageDeduplicationId sets the MessageDeduplicationId field's value.
func (*SendMessageBatchRequestEntry) SetMessageGroupId ¶
func (s *SendMessageBatchRequestEntry) SetMessageGroupId(v string) *SendMessageBatchRequestEntry
SetMessageGroupId sets the MessageGroupId field's value.
func (*SendMessageBatchRequestEntry) SetMessageSystemAttributes ¶
func (s *SendMessageBatchRequestEntry) SetMessageSystemAttributes(v map[string]*MessageSystemAttributeValue) *SendMessageBatchRequestEntry
SetMessageSystemAttributes sets the MessageSystemAttributes field's value.
func (SendMessageBatchRequestEntry) String ¶
func (s SendMessageBatchRequestEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageBatchRequestEntry) Validate ¶
func (s *SendMessageBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageBatchResultEntry ¶
type SendMessageBatchResultEntry struct { // An identifier for the message in this batch. // // Id is a required field Id *string `type:"string" required:"true"` // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageAttributes *string `type:"string"` // An MD5 digest of the non-URL-encoded message body string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon // SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). // // MD5OfMessageBody is a required field MD5OfMessageBody *string `type:"string" required:"true"` // An MD5 digest of the non-URL-encoded message system attribute string. You // can use this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageSystemAttributes *string `type:"string"` // An identifier for the message. // // MessageId is a required field MessageId *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The large, non-consecutive number that Amazon SQS assigns to each message. // // The length of SequenceNumber is 128 bits. As SequenceNumber continues to // increase for a particular MessageGroupId. SequenceNumber *string `type:"string"` // contains filtered or unexported fields }
Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.
func (SendMessageBatchResultEntry) GoString ¶
func (s SendMessageBatchResultEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageBatchResultEntry) SetId ¶
func (s *SendMessageBatchResultEntry) SetId(v string) *SendMessageBatchResultEntry
SetId sets the Id field's value.
func (*SendMessageBatchResultEntry) SetMD5OfMessageAttributes ¶
func (s *SendMessageBatchResultEntry) SetMD5OfMessageAttributes(v string) *SendMessageBatchResultEntry
SetMD5OfMessageAttributes sets the MD5OfMessageAttributes field's value.
func (*SendMessageBatchResultEntry) SetMD5OfMessageBody ¶
func (s *SendMessageBatchResultEntry) SetMD5OfMessageBody(v string) *SendMessageBatchResultEntry
SetMD5OfMessageBody sets the MD5OfMessageBody field's value.
func (*SendMessageBatchResultEntry) SetMD5OfMessageSystemAttributes ¶
func (s *SendMessageBatchResultEntry) SetMD5OfMessageSystemAttributes(v string) *SendMessageBatchResultEntry
SetMD5OfMessageSystemAttributes sets the MD5OfMessageSystemAttributes field's value.
func (*SendMessageBatchResultEntry) SetMessageId ¶
func (s *SendMessageBatchResultEntry) SetMessageId(v string) *SendMessageBatchResultEntry
SetMessageId sets the MessageId field's value.
func (*SendMessageBatchResultEntry) SetSequenceNumber ¶
func (s *SendMessageBatchResultEntry) SetSequenceNumber(v string) *SendMessageBatchResultEntry
SetSequenceNumber sets the SequenceNumber field's value.
func (SendMessageBatchResultEntry) String ¶
func (s SendMessageBatchResultEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SendMessageInput ¶
type SendMessageInput struct { // The length of time, in seconds, for which to delay a specific message. Valid // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds // value become available for processing after the delay period is finished. // If you don't specify a value, the default value for the queue applies. // // When you set FifoQueue, you can't set DelaySeconds per message. You can set // this parameter only on a queue level. DelaySeconds *int64 `type:"integer"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SQS message attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) // in the Amazon SQS Developer Guide. MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The message to send. The minimum size is one character. The maximum size // is 256 KiB. // // A message can include only XML, JSON, and unformatted text. The following // Unicode characters are allowed: // // #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF // // Any characters not included in this list will be rejected. For more information, // see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets). // // MessageBody is a required field MessageBody *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The token used for deduplication of sent messages. If a message with a particular // MessageDeduplicationId is sent successfully, any messages sent with the same // MessageDeduplicationId are accepted successfully but aren't delivered during // the 5-minute deduplication interval. For more information, see Exactly-once // processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. // // * Every message must have a unique MessageDeduplicationId, You may provide // a MessageDeduplicationId explicitly. If you aren't able to provide a MessageDeduplicationId // and you enable ContentBasedDeduplication for your queue, Amazon SQS uses // a SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). If you don't provide // a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication // set, the action fails with an error. If the queue has ContentBasedDeduplication // set, your MessageDeduplicationId overrides the generated one. // // * When ContentBasedDeduplication is in effect, messages with identical // content sent within the deduplication interval are treated as duplicates // and only one copy of the message is delivered. // // * If you send one message with ContentBasedDeduplication enabled and then // another message with a MessageDeduplicationId that is the same as the // one generated for the first MessageDeduplicationId, the two messages are // treated as duplicates and only one copy of the message is delivered. // // The MessageDeduplicationId is available to the consumer of the message (this // can be useful for troubleshooting delivery issues). // // If a message is sent successfully but the acknowledgement is lost and the // message is resent with the same MessageDeduplicationId after the deduplication // interval, Amazon SQS can't detect duplicate messages. // // Amazon SQS continues to keep track of the message deduplication ID even after // the message is received and deleted. // // The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon SQS Developer Guide. MessageDeduplicationId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The tag that specifies that a message belongs to a specific message group. // Messages that belong to the same message group are processed in a FIFO manner // (however, messages in different message groups might be processed out of // order). To interleave multiple ordered streams within a single queue, use // MessageGroupId values (for example, session data for multiple users). In // this scenario, multiple consumers can process the queue, but the session // data of each user is processed in a FIFO fashion. // // * You must associate a non-empty MessageGroupId with a message. If you // don't provide a MessageGroupId, the action fails. // // * ReceiveMessage might return messages with multiple MessageGroupId values. // For each MessageGroupId, the messages are sorted by time sent. The caller // can't specify a MessageGroupId. // // The length of MessageGroupId is 128 characters. Valid values: alphanumeric // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageGroupId, see Using the MessageGroupId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) // in the Amazon SQS Developer Guide. // // MessageGroupId is required for FIFO queues. You can't use it for Standard // queues. MessageGroupId *string `type:"string"` // The message system attribute to send. Each message system attribute consists // of a Name, Type, and Value. // // * Currently, the only supported message system attribute is AWSTraceHeader. // Its type must be String and its value must be a correctly formatted X-Ray // trace header string. // // * The size of a message system attribute doesn't count towards the total // size of a message. MessageSystemAttributes map[string]*MessageSystemAttributeValue `locationName:"MessageSystemAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The URL of the Amazon SQS queue to which a message is sent. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (SendMessageInput) GoString ¶
func (s SendMessageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageInput) SetDelaySeconds ¶
func (s *SendMessageInput) SetDelaySeconds(v int64) *SendMessageInput
SetDelaySeconds sets the DelaySeconds field's value.
func (*SendMessageInput) SetMessageAttributes ¶
func (s *SendMessageInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendMessageInput
SetMessageAttributes sets the MessageAttributes field's value.
func (*SendMessageInput) SetMessageBody ¶
func (s *SendMessageInput) SetMessageBody(v string) *SendMessageInput
SetMessageBody sets the MessageBody field's value.
func (*SendMessageInput) SetMessageDeduplicationId ¶
func (s *SendMessageInput) SetMessageDeduplicationId(v string) *SendMessageInput
SetMessageDeduplicationId sets the MessageDeduplicationId field's value.
func (*SendMessageInput) SetMessageGroupId ¶
func (s *SendMessageInput) SetMessageGroupId(v string) *SendMessageInput
SetMessageGroupId sets the MessageGroupId field's value.
func (*SendMessageInput) SetMessageSystemAttributes ¶
func (s *SendMessageInput) SetMessageSystemAttributes(v map[string]*MessageSystemAttributeValue) *SendMessageInput
SetMessageSystemAttributes sets the MessageSystemAttributes field's value.
func (*SendMessageInput) SetQueueUrl ¶
func (s *SendMessageInput) SetQueueUrl(v string) *SendMessageInput
SetQueueUrl sets the QueueUrl field's value.
func (SendMessageInput) String ¶
func (s SendMessageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageInput) Validate ¶
func (s *SendMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageOutput ¶
type SendMessageOutput struct { // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageAttributes *string `type:"string"` // An MD5 digest of the non-URL-encoded message body string. You can use this // attribute to verify that Amazon SQS received the message correctly. Amazon // SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageBody *string `type:"string"` // An MD5 digest of the non-URL-encoded message system attribute string. You // can use this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. MD5OfMessageSystemAttributes *string `type:"string"` // An attribute containing the MessageId of the message sent to the queue. For // more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) // in the Amazon SQS Developer Guide. MessageId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The large, non-consecutive number that Amazon SQS assigns to each message. // // The length of SequenceNumber is 128 bits. SequenceNumber continues to increase // for a particular MessageGroupId. SequenceNumber *string `type:"string"` // contains filtered or unexported fields }
The MD5OfMessageBody and MessageId elements.
func (SendMessageOutput) GoString ¶
func (s SendMessageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SendMessageOutput) SetMD5OfMessageAttributes ¶
func (s *SendMessageOutput) SetMD5OfMessageAttributes(v string) *SendMessageOutput
SetMD5OfMessageAttributes sets the MD5OfMessageAttributes field's value.
func (*SendMessageOutput) SetMD5OfMessageBody ¶
func (s *SendMessageOutput) SetMD5OfMessageBody(v string) *SendMessageOutput
SetMD5OfMessageBody sets the MD5OfMessageBody field's value.
func (*SendMessageOutput) SetMD5OfMessageSystemAttributes ¶
func (s *SendMessageOutput) SetMD5OfMessageSystemAttributes(v string) *SendMessageOutput
SetMD5OfMessageSystemAttributes sets the MD5OfMessageSystemAttributes field's value.
func (*SendMessageOutput) SetMessageId ¶
func (s *SendMessageOutput) SetMessageId(v string) *SendMessageOutput
SetMessageId sets the MessageId field's value.
func (*SendMessageOutput) SetSequenceNumber ¶
func (s *SendMessageOutput) SetSequenceNumber(v string) *SendMessageOutput
SetSequenceNumber sets the SequenceNumber field's value.
func (SendMessageOutput) String ¶
func (s SendMessageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type SetQueueAttributesInput ¶
type SetQueueAttributesInput struct { // A map of attributes to set. // // The following lists the names, descriptions, and values of the special request // parameters that the SetQueueAttributes action uses: // // * DelaySeconds – The length of time, in seconds, for which the delivery // of all messages in the queue is delayed. Valid values: An integer from // 0 to 900 (15 minutes). Default: 0. // // * MaximumMessageSize – The limit of how many bytes a message can contain // before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes // (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). // // * MessageRetentionPeriod – The length of time, in seconds, for which // Amazon SQS retains a message. Valid values: An integer representing seconds, // from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). // When you change a queue's attributes, the change can take up to 60 seconds // for most of the attributes to propagate throughout the Amazon SQS system. // Changes made to the MessageRetentionPeriod attribute can take up to 15 // minutes and will impact existing messages in the queue potentially causing // them to be expired and deleted if the MessageRetentionPeriod is reduced // below the age of existing messages. // // * Policy – The queue's policy. A valid Amazon Web Services policy. For // more information about policy structure, see Overview of Amazon Web Services // IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) // in the Identity and Access Management User Guide. // // * ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for // which a ReceiveMessage action waits for a message to arrive. Valid values: // An integer from 0 to 20 (seconds). Default: 0. // // * VisibilityTimeout – The visibility timeout for the queue, in seconds. // Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For // more information about the visibility timeout, see Visibility Timeout // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon SQS Developer Guide. // // The following attributes apply only to dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) // // * RedrivePolicy – The string that includes the parameters for the dead-letter // queue functionality of the source queue as a JSON object. The parameters // are as follows: deadLetterTargetArn – The Amazon Resource Name (ARN) // of the dead-letter queue to which Amazon SQS moves messages after the // value of maxReceiveCount is exceeded. maxReceiveCount – The number of // times a message is delivered to the source queue before being moved to // the dead-letter queue. Default: 10. When the ReceiveCount for a message // exceeds the maxReceiveCount for a queue, Amazon SQS moves the message // to the dead-letter-queue. // // * RedriveAllowPolicy – The string that includes the parameters for the // permissions for the dead-letter queue redrive permission and which source // queues can specify dead-letter queues as a JSON object. The parameters // are as follows: redrivePermission – The permission type that defines // which source queues can specify the current queue as the dead-letter queue. // Valid values are: allowAll – (Default) Any source queues in this Amazon // Web Services account in the same Region can specify this queue as the // dead-letter queue. denyAll – No source queues can specify this queue // as the dead-letter queue. byQueue – Only queues specified by the sourceQueueArns // parameter can specify this queue as the dead-letter queue. sourceQueueArns // – The Amazon Resource Names (ARN)s of the source queues that can specify // this queue as the dead-letter queue and redrive messages. You can specify // this parameter only when the redrivePermission parameter is set to byQueue. // You can specify up to 10 source queue ARNs. To allow more than 10 source // queues to specify dead-letter queues, set the redrivePermission parameter // to allowAll. // // The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, // the dead-letter queue of a standard queue must also be a standard queue. // // The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html): // // * KmsMasterKeyId – The ID of an Amazon Web Services managed customer // master key (CMK) for Amazon SQS or a custom CMK. For more information, // see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). // While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, // the alias of a custom CMK can, for example, be alias/MyAlias . For more // examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) // in the Key Management Service API Reference. // // * KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for // which Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) // to encrypt or decrypt messages before calling KMS again. An integer representing // seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). // Default: 300 (5 minutes). A shorter time period provides better security // but results in more calls to KMS which might incur charges after Free // Tier. For more information, see How Does the Data Key Reuse Period Work? // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work). // // * SqsManagedSseEnabled – Enables server-side queue encryption using // SQS owned encryption keys. Only one server-side encryption option is supported // per queue (for example, SSE-KMS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) // or SSE-SQS (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). // // The following attribute applies only to FIFO (first-in-first-out) queues // (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // // * ContentBasedDeduplication – Enables content-based deduplication. For // more information, see Exactly-once processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html) // in the Amazon SQS Developer Guide. Note the following: Every message must // have a unique MessageDeduplicationId. You may provide a MessageDeduplicationId // explicitly. If you aren't able to provide a MessageDeduplicationId and // you enable ContentBasedDeduplication for your queue, Amazon SQS uses a // SHA-256 hash to generate the MessageDeduplicationId using the body of // the message (but not the attributes of the message). If you don't provide // a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication // set, the action fails with an error. If the queue has ContentBasedDeduplication // set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication // is in effect, messages with identical content sent within the deduplication // interval are treated as duplicates and only one copy of the message is // delivered. If you send one message with ContentBasedDeduplication enabled // and then another message with a MessageDeduplicationId that is the same // as the one generated for the first MessageDeduplicationId, the two messages // are treated as duplicates and only one copy of the message is delivered. // // The following attributes apply only to high throughput for FIFO queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html): // // * DeduplicationScope – Specifies whether message deduplication occurs // at the message group or queue level. Valid values are messageGroup and // queue. // // * FifoThroughputLimit – Specifies whether the FIFO queue throughput // quota applies to the entire queue or per message group. Valid values are // perQueue and perMessageGroupId. The perMessageGroupId value is allowed // only when the value for DeduplicationScope is messageGroup. // // To enable high throughput for FIFO queues, do the following: // // * Set DeduplicationScope to messageGroup. // // * Set FifoThroughputLimit to perMessageGroupId. // // If you set these attributes to anything other than the values shown for enabling // high throughput, normal throughput is in effect and deduplication occurs // as specified. // // For information on throughput quotas, see Quotas related to messages (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) // in the Amazon SQS Developer Guide. // // Attributes is a required field Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true" required:"true"` // The URL of the Amazon SQS queue whose attributes are set. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (SetQueueAttributesInput) GoString ¶
func (s SetQueueAttributesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SetQueueAttributesInput) SetAttributes ¶
func (s *SetQueueAttributesInput) SetAttributes(v map[string]*string) *SetQueueAttributesInput
SetAttributes sets the Attributes field's value.
func (*SetQueueAttributesInput) SetQueueUrl ¶
func (s *SetQueueAttributesInput) SetQueueUrl(v string) *SetQueueAttributesInput
SetQueueUrl sets the QueueUrl field's value.
func (SetQueueAttributesInput) String ¶
func (s SetQueueAttributesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*SetQueueAttributesInput) Validate ¶
func (s *SetQueueAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetQueueAttributesOutput ¶
type SetQueueAttributesOutput struct {
// contains filtered or unexported fields
}
func (SetQueueAttributesOutput) GoString ¶
func (s SetQueueAttributesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (SetQueueAttributesOutput) String ¶
func (s SetQueueAttributesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type StartMessageMoveTaskInput ¶ added in v1.42.9
type StartMessageMoveTaskInput struct { // The ARN of the queue that receives the moved messages. You can use this field // to specify the destination queue where you would like to redrive messages. // If this field is left blank, the messages will be redriven back to their // respective original source queues. DestinationArn *string `type:"string"` // The number of messages to be moved per second (the message movement rate). // You can use this field to define a fixed message movement rate. The maximum // value for messages per second is 500. If this field is left blank, the system // will optimize the rate based on the queue message backlog size, which may // vary throughout the duration of the message movement task. MaxNumberOfMessagesPerSecond *int64 `type:"integer"` // The ARN of the queue that contains the messages to be moved to another queue. // Currently, only ARNs of dead-letter queues (DLQs) whose sources are other // Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such // as Lambda or Amazon SNS topics, are not currently supported. // // SourceArn is a required field SourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (StartMessageMoveTaskInput) GoString ¶ added in v1.42.9
func (s StartMessageMoveTaskInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*StartMessageMoveTaskInput) SetDestinationArn ¶ added in v1.42.9
func (s *StartMessageMoveTaskInput) SetDestinationArn(v string) *StartMessageMoveTaskInput
SetDestinationArn sets the DestinationArn field's value.
func (*StartMessageMoveTaskInput) SetMaxNumberOfMessagesPerSecond ¶ added in v1.42.9
func (s *StartMessageMoveTaskInput) SetMaxNumberOfMessagesPerSecond(v int64) *StartMessageMoveTaskInput
SetMaxNumberOfMessagesPerSecond sets the MaxNumberOfMessagesPerSecond field's value.
func (*StartMessageMoveTaskInput) SetSourceArn ¶ added in v1.42.9
func (s *StartMessageMoveTaskInput) SetSourceArn(v string) *StartMessageMoveTaskInput
SetSourceArn sets the SourceArn field's value.
func (StartMessageMoveTaskInput) String ¶ added in v1.42.9
func (s StartMessageMoveTaskInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*StartMessageMoveTaskInput) Validate ¶ added in v1.42.9
func (s *StartMessageMoveTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartMessageMoveTaskOutput ¶ added in v1.42.9
type StartMessageMoveTaskOutput struct { // An identifier associated with a message movement task. You can use this identifier // to cancel a specified message movement task using the CancelMessageMoveTask // action. TaskHandle *string `type:"string"` // contains filtered or unexported fields }
func (StartMessageMoveTaskOutput) GoString ¶ added in v1.42.9
func (s StartMessageMoveTaskOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*StartMessageMoveTaskOutput) SetTaskHandle ¶ added in v1.42.9
func (s *StartMessageMoveTaskOutput) SetTaskHandle(v string) *StartMessageMoveTaskOutput
SetTaskHandle sets the TaskHandle field's value.
func (StartMessageMoveTaskOutput) String ¶ added in v1.42.9
func (s StartMessageMoveTaskOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TagQueueInput ¶
type TagQueueInput struct { // The URL of the queue. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The list of tags to be added to the specified queue. // // Tags is a required field Tags map[string]*string `locationName:"Tag" locationNameKey:"Key" locationNameValue:"Value" type:"map" flattened:"true" required:"true"` // contains filtered or unexported fields }
func (TagQueueInput) GoString ¶
func (s TagQueueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagQueueInput) SetQueueUrl ¶
func (s *TagQueueInput) SetQueueUrl(v string) *TagQueueInput
SetQueueUrl sets the QueueUrl field's value.
func (*TagQueueInput) SetTags ¶
func (s *TagQueueInput) SetTags(v map[string]*string) *TagQueueInput
SetTags sets the Tags field's value.
func (TagQueueInput) String ¶
func (s TagQueueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagQueueInput) Validate ¶
func (s *TagQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagQueueOutput ¶
type TagQueueOutput struct {
// contains filtered or unexported fields
}
func (TagQueueOutput) GoString ¶
func (s TagQueueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (TagQueueOutput) String ¶
func (s TagQueueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UntagQueueInput ¶
type UntagQueueInput struct { // The URL of the queue. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The list of tags to be removed from the specified queue. // // TagKeys is a required field TagKeys []*string `locationNameList:"TagKey" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
func (UntagQueueInput) GoString ¶
func (s UntagQueueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagQueueInput) SetQueueUrl ¶
func (s *UntagQueueInput) SetQueueUrl(v string) *UntagQueueInput
SetQueueUrl sets the QueueUrl field's value.
func (*UntagQueueInput) SetTagKeys ¶
func (s *UntagQueueInput) SetTagKeys(v []*string) *UntagQueueInput
SetTagKeys sets the TagKeys field's value.
func (UntagQueueInput) String ¶
func (s UntagQueueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagQueueInput) Validate ¶
func (s *UntagQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagQueueOutput ¶
type UntagQueueOutput struct {
// contains filtered or unexported fields
}
func (UntagQueueOutput) GoString ¶
func (s UntagQueueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (UntagQueueOutput) String ¶
func (s UntagQueueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".