sqs

package module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 18, 2021 License: Apache-2.0 Imports: 31 Imported by: 941

Documentation

Overview

Package sqs provides the API client, operations, and parameter types for Amazon Simple Queue Service.

Welcome to the Amazon Simple Queue Service API Reference. Amazon Simple Queue Service (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 Simple Queue Service Developer Guide. You can use AWS 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 Simple Queue Service 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 AWS CLI Command Reference (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)

Index

Constants

View Source 
const ServiceAPIVersion = "2012-11-05"
View Source 
const ServiceID = "SQS"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AddPermissionInput 

type AddPermissionInput struct {

	// The AWS account number of the principal
	// (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) who is given
	// permission. The principal must have an AWS account, but does not need to be
	// signed up for Amazon SQS. For information about locating the AWS account
	// identification, see Your AWS Identifiers
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication)
	// in the Amazon Simple Queue Service Developer Guide.
	//
	// This member is required.
	AWSAccountIds []string

	// The action the client wants to allow for the specified principal. Valid values:
	// the name of any action or *. For more information about these actions, see
	// Overview of Managing Access Permissions to Your Amazon Simple Queue Service
	// Resource
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html)
	// in the Amazon Simple Queue Service Developer Guide. Specifying SendMessage,
	// DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants
	// permissions for the corresponding batch versions of those actions:
	// SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
	//
	// This member is required.
	Actions []string

	// The unique identification of the permission you're setting (for example,
	// AliceSendMessage). Maximum 80 characters. Allowed characters include
	// alphanumeric characters, hyphens (-), and underscores (_).
	//
	// This member is required.
	Label *string

	// The URL of the Amazon SQS queue to which permissions are added. Queue URLs and
	// names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type AddPermissionOutput 

type AddPermissionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ChangeMessageVisibilityBatchInput 

type ChangeMessageVisibilityBatchInput struct {

	// A list of receipt handles of the messages for which the visibility timeout must
	// be changed.
	//
	// This member is required.
	Entries []types.ChangeMessageVisibilityBatchRequestEntry

	// The URL of the Amazon SQS queue whose messages' visibility is changed. Queue
	// URLs and names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type ChangeMessageVisibilityBatchOutput 

type ChangeMessageVisibilityBatchOutput struct {

	// A list of BatchResultErrorEntry items.
	//
	// This member is required.
	Failed []types.BatchResultErrorEntry

	// A list of ChangeMessageVisibilityBatchResultEntry items.
	//
	// This member is required.
	Successful []types.ChangeMessageVisibilityBatchResultEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

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.
	//
	// This member is required.
	QueueUrl *string

	// The receipt handle associated with the message whose visibility timeout is
	// changed. This parameter is returned by the ReceiveMessage action.
	//
	// This member is required.
	ReceiptHandle *string

	// The new value for the message's visibility timeout (in seconds). Values range: 0
	// to 43200. Maximum: 12 hours.
	//
	// This member is required.
	VisibilityTimeout int32
}

type ChangeMessageVisibilityOutput 

type ChangeMessageVisibilityOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Simple Queue Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AddPermission 

func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error)

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 Simple Queue Service 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 Simple Queue Service Developer Guide.

* An Amazon SQS policy can have a maximum of 7 actions.

* To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first&AttributeName.2=second Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name (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 Simple Queue Service Developer Guide.

func (*Client) ChangeMessageVisibility 

func (c *Client) ChangeMessageVisibility(ctx context.Context, params *ChangeMessageVisibilityInput, optFns ...func(*Options)) (*ChangeMessageVisibilityOutput, error)

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 Simple Queue Service Developer Guide. For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected. 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 inflight messages. Limits that apply to inflight 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 inflight 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 inflight 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.

func (*Client) ChangeMessageVisibilityBatch 

func (c *Client) ChangeMessageVisibilityBatch(ctx context.Context, params *ChangeMessageVisibilityBatchInput, optFns ...func(*Options)) (*ChangeMessageVisibilityBatchOutput, error)

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. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first

&AttributeName.2=second

func (*Client) CreateQueue 

func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error)

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 Simple Queue Service 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.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first&AttributeName.2=second Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name (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 Simple Queue Service Developer Guide.

func (*Client) DeleteMessage 

func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, optFns ...func(*Options)) (*DeleteMessageOutput, error)

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

func (*Client) DeleteMessageBatch 

func (c *Client) DeleteMessageBatch(ctx context.Context, params *DeleteMessageBatchInput, optFns ...func(*Options)) (*DeleteMessageBatchOutput, error)

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. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first 

&AttributeName.2=second

func (*Client) DeleteQueue 

func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optFns ...func(*Options)) (*DeleteQueueOutput, error)

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 user name (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 Simple Queue Service Developer Guide.

func (*Client) GetQueueAttributes 

func (c *Client) GetQueueAttributes(ctx context.Context, params *GetQueueAttributesInput, optFns ...func(*Options)) (*GetQueueAttributesOutput, error)

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.

func (*Client) GetQueueUrl 

func (c *Client) GetQueueUrl(ctx context.Context, params *GetQueueUrlInput, optFns ...func(*Options)) (*GetQueueUrlOutput, error)

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 Simple Queue Service Developer Guide.

func (*Client) ListDeadLetterSourceQueues 

func (c *Client) ListDeadLetterSourceQueues(ctx context.Context, params *ListDeadLetterSourceQueuesInput, optFns ...func(*Options)) (*ListDeadLetterSourceQueuesOutput, error)

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 Simple Queue Service Developer Guide.

func (*Client) ListQueueTags 

func (c *Client) ListQueueTags(ctx context.Context, params *ListQueueTagsInput, optFns ...func(*Options)) (*ListQueueTagsOutput, error)

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 Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name (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 Simple Queue Service Developer Guide.

func (*Client) ListQueues 

func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error)

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 user name (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 Simple Queue Service Developer Guide.

func (*Client) PurgeQueue 

func (c *Client) PurgeQueue(ctx context.Context, params *PurgeQueueInput, optFns ...func(*Options)) (*PurgeQueueOutput, error)

Deletes the messages in a queue 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.

func (*Client) ReceiveMessage 

func (c *Client) ReceiveMessage(ctx context.Context, params *ReceiveMessageInput, optFns ...func(*Options)) (*ReceiveMessageOutput, error)

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 Simple Queue Service 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 Simple Queue Service 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 Simple Queue Service 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.

func (*Client) RemovePermission 

func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error)

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 user name (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 Simple Queue Service 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.

func (*Client) SendMessage 

func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optFns ...func(*Options)) (*SendMessageOutput, error)

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

func (*Client) SendMessageBatch 

func (c *Client) SendMessageBatch(ctx context.Context, params *SendMessageBatchInput, optFns ...func(*Options)) (*SendMessageBatchOutput, error)

Delivers up to ten messages to the specified queue. 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 KB (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. Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this: &AttributeName.1=first

&AttributeName.2=second

func (*Client) SetQueueAttributes 

func (c *Client) SetQueueAttributes(ctx context.Context, params *SetQueueAttributesInput, optFns ...func(*Options)) (*SetQueueAttributesOutput, error)

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.

* 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 user name (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 Simple Queue Service 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.

func (*Client) TagQueue 

func (c *Client) TagQueue(ctx context.Context, params *TagQueueInput, optFns ...func(*Options)) (*TagQueueOutput, error)

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 Simple Queue Service 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 Limits Related to Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) in the Amazon Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name (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 Simple Queue Service Developer Guide.

func (*Client) UntagQueue 

func (c *Client) UntagQueue(ctx context.Context, params *UntagQueueInput, optFns ...func(*Options)) (*UntagQueueOutput, error)

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 Simple Queue Service Developer Guide. Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name (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 Simple Queue Service Developer Guide.

type CreateQueueInput 

type CreateQueueInput struct {

	// 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.
	//
	// This member is required.
	QueueName *string

	// 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).
	//
	// * Policy – The queue's policy. A valid AWS policy. For more information
	// about policy structure, see Overview of AWS IAM Policies
	// (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) in the
	// Amazon 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.
	//
	// * RedrivePolicy – The
	// string that includes the parameters for the dead-letter queue functionality of
	// the source queue as a JSON object. For more information about the redrive policy
	// and 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 Simple Queue Service Developer Guide.
	//
	// * 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. When the ReceiveCount for a message exceeds the
	// maxReceiveCount for a queue, Amazon SQS moves the message to the
	// dead-letter-queue.
	//
	// 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.
	//
	// * 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 Simple Queue Service Developer Guide.
	//
	// 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 AWS-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 AWS 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 AWS 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).
	//
	// 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.html#FIFO-queues-understanding-logic)
	// in the Amazon Simple Queue Service 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.html#FIFO-queues-exactly-once-processing)
	// in the Amazon Simple Queue Service 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.
	//
	// Preview: High throughput for FIFO queues High
	// throughput for Amazon SQS FIFO queues is in preview release and is subject to
	// change. This feature provides a high number of transactions per second (TPS) for
	// messages in FIFO queues. For information on throughput quotas, see Quotas
	// related to messages
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html)
	// in the Amazon Simple Queue Service Developer Guide. This preview includes two
	// new attributes:
	//
	// * 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, standard
	// throughput is in effect and deduplication occurs as specified. This preview is
	// available in the following AWS Regions:
	//
	// * US East (Ohio); us-east-2
	//
	// * US East
	// (N. Virginia); us-east-1
	//
	// * US West (Oregon); us-west-2
	//
	// * Europe (Ireland);
	// eu-west-1
	//
	// For more information about high throughput for FIFO queues, see
	// Preview: High throughput for FIFO queues
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html)
	// in the Amazon Simple Queue Service Developer Guide.
	Attributes map[string]string

	// 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 Simple Queue Service 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 Limits Related to Queues
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues)
	// in the Amazon Simple Queue Service 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 user name
	// (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 Simple Queue Service Developer Guide.
	Tags map[string]string
}

type CreateQueueOutput 

type CreateQueueOutput struct {

	// The URL of the created Amazon SQS queue.
	QueueUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Returns the QueueUrl attribute of the created queue.

type DeleteMessageBatchInput 

type DeleteMessageBatchInput struct {

	// A list of receipt handles for the messages to be deleted.
	//
	// This member is required.
	Entries []types.DeleteMessageBatchRequestEntry

	// The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and
	// names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type DeleteMessageBatchOutput 

type DeleteMessageBatchOutput struct {

	// A list of BatchResultErrorEntry items.
	//
	// This member is required.
	Failed []types.BatchResultErrorEntry

	// A list of DeleteMessageBatchResultEntry items.
	//
	// This member is required.
	Successful []types.DeleteMessageBatchResultEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.

type DeleteMessageInput 

type DeleteMessageInput struct {

	// The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and
	// names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string

	// The receipt handle associated with the message to delete.
	//
	// This member is required.
	ReceiptHandle *string
}

type DeleteMessageOutput 

type DeleteMessageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteQueueInput 

type DeleteQueueInput struct {

	// The URL of the Amazon SQS queue to delete. Queue URLs and names are
	// case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type DeleteQueueOutput 

type DeleteQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetQueueAttributesInput 

type GetQueueAttributesInput struct {

	// The URL of the Amazon SQS queue whose attribute information is retrieved. Queue
	// URLs and names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string

	// A list of attributes for which to retrieve information. 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
	// ApproximateNumberOfMessagesVisible 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.
	//
	// * 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.
	//
	// * RedrivePolicy
	// – The string that includes the parameters for the dead-letter queue
	// functionality of the source queue as a JSON object. For more information about
	// the redrive policy and 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 Simple Queue Service Developer Guide.
	//
	// * 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. When the ReceiveCount for a message exceeds the
	// maxReceiveCount for a queue, Amazon SQS moves the message to the
	// dead-letter-queue.
	//
	// * 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 Simple Queue Service Developer Guide.
	//
	// 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 AWS-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
	// AWS 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).
	//
	// 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.html#FIFO-queues-understanding-logic)
	// in the Amazon Simple Queue Service 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.html#FIFO-queues-exactly-once-processing)
	// in the Amazon Simple Queue Service Developer Guide.
	//
	// Preview: High throughput
	// for FIFO queues High throughput for Amazon SQS FIFO queues is in preview release
	// and is subject to change. This feature provides a high number of transactions
	// per second (TPS) for messages in FIFO queues. For information on throughput
	// quotas, see Quotas related to messages
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html)
	// in the Amazon Simple Queue Service Developer Guide. This preview includes two
	// new attributes:
	//
	// * 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, standard
	// throughput is in effect and deduplication occurs as specified. This preview is
	// available in the following AWS Regions:
	//
	// * US East (Ohio); us-east-2
	//
	// * US East
	// (N. Virginia); us-east-1
	//
	// * US West (Oregon); us-west-2
	//
	// * Europe (Ireland);
	// eu-west-1
	//
	// For more information about high throughput for FIFO queues, see
	// Preview: High throughput for FIFO queues
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html)
	// in the Amazon Simple Queue Service Developer Guide.
	AttributeNames []types.QueueAttributeName
}

type GetQueueAttributesOutput 

type GetQueueAttributesOutput struct {

	// A map of attributes to their respective values.
	Attributes map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of returned queue attributes.

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.
	//
	// This member is required.
	QueueName *string

	// The AWS account ID of the account that created the queue.
	QueueOwnerAWSAccountId *string
}

type GetQueueUrlOutput 

type GetQueueUrlOutput struct {

	// The URL of the queue.
	QueueUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

For more information, see Interpreting Responses (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html) in the Amazon Simple Queue Service Developer Guide.

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListDeadLetterSourceQueuesAPIClient added in v0.30.0 

type ListDeadLetterSourceQueuesAPIClient interface {
	ListDeadLetterSourceQueues(context.Context, *ListDeadLetterSourceQueuesInput, ...func(*Options)) (*ListDeadLetterSourceQueuesOutput, error)
}

ListDeadLetterSourceQueuesAPIClient is a client that implements the ListDeadLetterSourceQueues operation.

type ListDeadLetterSourceQueuesInput 

type ListDeadLetterSourceQueuesInput struct {

	// The URL of a dead-letter queue. Queue URLs and names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string

	// 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 *int32

	// Pagination token to request the next set of results.
	NextToken *string
}

type ListDeadLetterSourceQueuesOutput 

type ListDeadLetterSourceQueuesOutput struct {

	// A list of source queue URLs that have the RedrivePolicy queue attribute
	// configured with a dead-letter queue.
	//
	// This member is required.
	QueueUrls []string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of your dead letter source queues.

type ListDeadLetterSourceQueuesPaginator added in v0.30.0 

type ListDeadLetterSourceQueuesPaginator struct {
	// contains filtered or unexported fields
}

ListDeadLetterSourceQueuesPaginator is a paginator for ListDeadLetterSourceQueues

func NewListDeadLetterSourceQueuesPaginator added in v0.30.0 

func NewListDeadLetterSourceQueuesPaginator(client ListDeadLetterSourceQueuesAPIClient, params *ListDeadLetterSourceQueuesInput, optFns ...func(*ListDeadLetterSourceQueuesPaginatorOptions)) *ListDeadLetterSourceQueuesPaginator

NewListDeadLetterSourceQueuesPaginator returns a new ListDeadLetterSourceQueuesPaginator

func (*ListDeadLetterSourceQueuesPaginator) HasMorePages added in v0.30.0 

func (p *ListDeadLetterSourceQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeadLetterSourceQueuesPaginator) NextPage added in v0.30.0 

func (p *ListDeadLetterSourceQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeadLetterSourceQueuesOutput, error)

NextPage retrieves the next ListDeadLetterSourceQueues page.

type ListDeadLetterSourceQueuesPaginatorOptions added in v0.30.0 

type ListDeadLetterSourceQueuesPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDeadLetterSourceQueuesPaginatorOptions is the paginator options for ListDeadLetterSourceQueues

type ListQueueTagsInput 

type ListQueueTagsInput struct {

	// The URL of the queue.
	//
	// This member is required.
	QueueUrl *string
}

type ListQueueTagsOutput 

type ListQueueTagsOutput struct {

	// The list of all tags added to the specified queue.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListQueuesAPIClient added in v0.30.0 

type ListQueuesAPIClient interface {
	ListQueues(context.Context, *ListQueuesInput, ...func(*Options)) (*ListQueuesOutput, error)
}

ListQueuesAPIClient is a client that implements the ListQueues operation.

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 *int32

	// Pagination token to request the next set of results.
	NextToken *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 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

	// A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you
	// sent in the request.
	QueueUrls []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of your queues.

type ListQueuesPaginator added in v0.30.0 

type ListQueuesPaginator struct {
	// contains filtered or unexported fields
}

ListQueuesPaginator is a paginator for ListQueues

func NewListQueuesPaginator added in v0.30.0 

func NewListQueuesPaginator(client ListQueuesAPIClient, params *ListQueuesInput, optFns ...func(*ListQueuesPaginatorOptions)) *ListQueuesPaginator

NewListQueuesPaginator returns a new ListQueuesPaginator

func (*ListQueuesPaginator) HasMorePages added in v0.30.0 

func (p *ListQueuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListQueuesPaginator) NextPage added in v0.30.0 

func (p *ListQueuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListQueuesOutput, error)

NextPage retrieves the next ListQueues page.

type ListQueuesPaginatorOptions added in v0.30.0 

type ListQueuesPaginatorOptions 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListQueuesPaginatorOptions is the paginator options for ListQueues

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PurgeQueueInput 

type PurgeQueueInput struct {

	// The URL of the queue from which the PurgeQueue action deletes messages. Queue
	// URLs and names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type PurgeQueueOutput 

type PurgeQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ReceiveMessageInput 

type ReceiveMessageInput struct {

	// The URL of the Amazon SQS queue from which messages are received. Queue URLs and
	// names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string

	// 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 AWS X-Ray trace header string.
	//
	// * SenderId
	//
	// * For an IAM user,
	// returns the IAM 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).
	//
	// *
	// 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 []types.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 int32

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

	// 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 Simple Queue Service 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 Simple Queue Service Developer Guide.
	ReceiveRequestAttemptId *string

	// The duration (in seconds) that the received messages are hidden from subsequent
	// retrieve requests after being retrieved by a ReceiveMessage request.
	VisibilityTimeout int32

	// 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 int32
}

type ReceiveMessageOutput 

type ReceiveMessageOutput struct {

	// A list of messages.
	Messages []types.Message

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of received messages.

type RemovePermissionInput 

type RemovePermissionInput struct {

	// The identification of the permission to remove. This is the label added using
	// the AddPermission action.
	//
	// This member is required.
	Label *string

	// The URL of the Amazon SQS queue from which permissions are removed. Queue URLs
	// and names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type RemovePermissionOutput 

type RemovePermissionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SendMessageBatchInput 

type SendMessageBatchInput struct {

	// A list of SendMessageBatchRequestEntry items.
	//
	// This member is required.
	Entries []types.SendMessageBatchRequestEntry

	// The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs
	// and names are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type SendMessageBatchOutput 

type SendMessageBatchOutput struct {

	// A list of BatchResultErrorEntry items with error details about each message that
	// can't be enqueued.
	//
	// This member is required.
	Failed []types.BatchResultErrorEntry

	// A list of SendMessageBatchResultEntry items.
	//
	// This member is required.
	Successful []types.SendMessageBatchResultEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

type SendMessageInput 

type SendMessageInput struct {

	// The message to send. The minimum size is one character. The maximum size is 256
	// KB. 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).
	//
	// This member is required.
	MessageBody *string

	// The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names
	// are case-sensitive.
	//
	// This member is required.
	QueueUrl *string

	// 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 int32

	// 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 Simple Queue Service Developer Guide.
	MessageAttributes map[string]types.MessageAttributeValue

	// 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.html#FIFO-queues-exactly-once-processing)
	// in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
	MessageDeduplicationId *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 Simple Queue Service Developer Guide. MessageGroupId is required
	// for FIFO queues. You can't use it for Standard queues.
	MessageGroupId *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 AWS 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]types.MessageSystemAttributeValue
}

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

	// 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).
	MD5OfMessageBody *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

	// 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 Simple Queue Service Developer Guide.
	MessageId *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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The MD5OfMessageBody and MessageId elements.

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).
	//
	// * Policy
	// – The queue's policy. A valid AWS policy. For more information about policy
	// structure, see Overview of AWS IAM Policies
	// (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) in the
	// Amazon 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.
	//
	// * RedrivePolicy – The
	// string that includes the parameters for the dead-letter queue functionality of
	// the source queue as a JSON object. For more information about the redrive policy
	// and 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 Simple Queue Service Developer Guide.
	//
	// * 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. When the ReceiveCount for a message exceeds the
	// maxReceiveCount for a queue, Amazon SQS moves the message to the
	// dead-letter-queue.
	//
	// 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.
	//
	// * 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 Simple Queue Service Developer Guide.
	//
	// 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 AWS-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 AWS 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 AWS 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).
	//
	// 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.html#FIFO-queues-exactly-once-processing)
	// in the Amazon Simple Queue Service 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.
	//
	// Preview: High throughput for FIFO queues High
	// throughput for Amazon SQS FIFO queues is in preview release and is subject to
	// change. This feature provides a high number of transactions per second (TPS) for
	// messages in FIFO queues. For information on throughput quotas, see Quotas
	// related to messages
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html)
	// in the Amazon Simple Queue Service Developer Guide. This preview includes two
	// new attributes:
	//
	// * 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, standard
	// throughput is in effect and deduplication occurs as specified. This preview is
	// available in the following AWS Regions:
	//
	// * US East (Ohio); us-east-2
	//
	// * US East
	// (N. Virginia); us-east-1
	//
	// * US West (Oregon); us-west-2
	//
	// * Europe (Ireland);
	// eu-west-1
	//
	// For more information about high throughput for FIFO queues, see
	// Preview: High throughput for FIFO queues
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html)
	// in the Amazon Simple Queue Service Developer Guide.
	//
	// This member is required.
	Attributes map[string]string

	// The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names
	// are case-sensitive.
	//
	// This member is required.
	QueueUrl *string
}

type SetQueueAttributesOutput 

type SetQueueAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagQueueInput 

type TagQueueInput struct {

	// The URL of the queue.
	//
	// This member is required.
	QueueUrl *string

	// The list of tags to be added to the specified queue.
	//
	// This member is required.
	Tags map[string]string
}

type TagQueueOutput 

type TagQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagQueueInput 

type UntagQueueInput struct {

	// The URL of the queue.
	//
	// This member is required.
	QueueUrl *string

	// The list of tags to be removed from the specified queue.
	//
	// This member is required.
	TagKeys []string
}

type UntagQueueOutput 

type UntagQueueOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.