sqsextendedclient

package module
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Mar 22, 2024 License: MIT Imports: 20 Imported by: 0

README

sqs-extended-client-go

Send and receive large messages through SQS via S3

Go Reference

sqs-extended-client-go is an extension to the Amazon SQS client that enables sending and receiving messages up to 2GB via Amazon S3. It is very similar to the SQS Extended Client for Java, but has an adjusted API to be more Gopher friendly.

The Extended Client also comes with a bit of extra functionality for dealing with SQS Events in Lambda. This all comes at no impact to the underlying Amazon SQS client- everything that is possible in the Amazon SQS Client, is possible in the Extended Client.

Installation

go get -u github.com/co-go/sqs-extended-client-go

Quick Start

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/config"
	"github.com/aws/aws-sdk-go-v2/service/s3"
	"github.com/aws/aws-sdk-go-v2/service/sqs"
	sqsextendedclient "github.com/co-go/sqs-extended-client-go"
)

const queueURL = "https://sqs.amazonaws.com/12345/testing-queue"

func main() {
	ctx := context.Background()

	// initialize AWS Config
	awsCfg, _ := config.LoadDefaultConfig(
		context.Background(),
		config.WithRegion("us-east-1"),
	)

	// create a new sqsextendedclient with some options
	sqsec, _ := sqsextendedclient.New(
		sqs.NewFromConfig(awsCfg),
		s3.NewFromConfig(awsCfg),
		// use "testing-bucket" for large messages
		sqsextendedclient.WithS3BucketName("testing-bucket"),
		// set the threshold to 1 KB
		sqsextendedclient.WithMessageSizeThreshold(1024),
	)

	// send a message to the queue
	sqsec.SendMessage(ctx, &sqs.SendMessageInput{
		MessageBody: aws.String("really interesting message!"),
		QueueUrl:    aws.String(queueURL),
	})

	// retrieve messages from the specified queue
	resp, _ := sqsec.ReceiveMessage(ctx, &sqs.ReceiveMessageInput{
		QueueUrl: aws.String(queueURL),
	})

	for _, m := range resp.Messages {
		// do some processing on each message...

		// delete message after processing. can also be
		// done more efficiently with 'DeleteMessageBatch'
		sqsec.DeleteMessage(ctx, &sqs.DeleteMessageInput{
			QueueUrl:      aws.String(queueURL),
			ReceiptHandle: m.ReceiptHandle,
		})
	}
}

Working with Lambda

When using an SQS queue as an event source for a Lambda function, the Lambda will be invoked on the configured interval with a batch of messages. Some of these messages might need to be fetched from S3 if they exceeded the limit of the queue and were sent with this (or another) SQS Extended Client. This is the use case for RetrieveLambdaEvent. Very similar to RetrieveMessage, it will parse any extended messages in the event and retrieve them from S3, returning a new event will the full payloads. If none of the events match the extended format, no action is taken!

Example

import (
	"context"
	"os"

	"github.com/aws/aws-lambda-go/events"
	"github.com/aws/aws-lambda-go/lambda"
	"github.com/aws/aws-sdk-go-v2/config"
	"github.com/aws/aws-sdk-go-v2/service/s3"
	"github.com/aws/aws-sdk-go-v2/service/sqs"
	sqsextendedclient "github.com/co-go/sqs-extended-client-go"
)

type Environment struct {
	queueURL string
	sqsec    *sqsextendedclient.Client
}

func (e *Environment) HandleRequest(
	ctx context.Context,
	evt events.SQSEvent
) error {
	parsedEvt, _ := e.sqsec.RetrieveLambdaEvent(ctx, &evt)

	for _, record := range parsedEvt.Records {
		// do some processing

		// delete message after processing. can also be done
		// more efficiently with 'DeleteMessageBatch'. see
		// note below about processing extended events.
		e.sqsec.DeleteMessage(ctx, &sqs.DeleteMessageInput{
			QueueUrl:      &e.queueURL,
			ReceiptHandle: &record.ReceiptHandle,
		})
	}

	return nil
}

func main() {
	// initialize AWS Config
	awsCfg, _ := config.LoadDefaultConfig(
		context.Background(),
		config.WithRegion("us-east-1"),
	)

	// create a new sqsextendedclient
	sqsec, _ := sqsextendedclient.New(
		sqs.NewFromConfig(awsCfg),
		s3.NewFromConfig(awsCfg),
	)

	// struct to share initialized client across invocations
	e := Environment{
		queueURL: os.Getenv("QUEUE_URL"),
		sqsec:    sqsec,
	}

	lambda.Start(e.HandleRequest)
}

[!NOTE]

If you plan on processing extended events within a Lambda function

When processing SQS events in a Lambda function, if the invocation doesn’t return an error (indicating success), AWS will delete the SQS messages from the queue to prevent re-processing. This is a good thing! However, due to the special way extended messages are deleted, if AWS deletes an extended message that has a linked payload in S3, AWS will NOT delete the S3 payload.

There are multiple different ways to solve this (S3 lifecycle policies, etc.), but the recommended way to ensure the entire message is always cleaned up after processing is to explicitly call the DeleteMessage (or DeleteMessageBatch) functions.

Documentation

Index

Constants

View Source
const (
	LegacyReservedAttributeName = "SQSLargePayloadSize"
	LegacyS3PointerClass        = "com.amazon.sqs.javamessaging.MessageS3Pointer"
)

Variables

View Source
var (
	ErrObjectPrefix = errors.New("object prefix contains invalid characters")
)

Functions

This section is empty.

Types

type Client

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

Client is a wrapper for the github.com/aws/aws-sdk-go-v2/service/sqs.Client, providing extra functionality for retrieving, sending and deleting messages.

func New

func New(
	sqsc SQSClient,
	s3c S3Client,
	optFns ...ClientOption,
) (*Client, error)

New returns a newly created *Client with defaults:

  • MessageSizeThreshold: 262144 (256 KiB)
  • BatchMessageSizeThreshold: 262144 (256 KiB)
  • S3PointerClass: "software.amazon.payloadoffloading.PayloadS3Pointer"
  • ReservedAttributeName: "ExtendedPayloadSize"

Further options can be passed in to configure these or other options. See ClientOption functions for more details.

func (*Client) ChangeMessageVisibility

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

ChangeMessageVisibility is a SQS Extended Client wrapper for the github.com/aws/aws-sdk-go-v2/service/sqs.Client.ChangeMessageVisibility function. If the provided params.ReceiptHandle matches with the format expected for the extended SQS client, it will be parsed and the original SQS client method will be called.

AWS doc for github.com/aws/aws-sdk-go-v2/service/sqs.Client.ChangeMessageVisibility for completeness:

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.

func (*Client) DeleteMessage

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

DeleteMessage is a SQS Extended Client wrapper for the github.com/aws/aws-sdk-go-v2/service/sqs.Client.DeleteMessage function. If the provided params.ReceiptHandle matches with the format expected for the extended SQS client, it will be parsed and the linked S3 file will be deleted along with the actual SQS message.

AWS doc for github.com/aws/aws-sdk-go-v2/service/sqs.Client.DeleteMessage for completeness:

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.

func (*Client) DeleteMessageBatch

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

DeleteMessageBatch is a SQS Extended Client wrapper for the github.com/aws/aws-sdk-go-v2/service/sqs.Client.DeleteMessageBatch function. For each entry provided, if its ReceiptHandle matches with the format expected for the extended SQS client, it will be parsed and the linked S3 file will be deleted along with the actual SQS message.

AWS doc for github.com/aws/aws-sdk-go-v2/service/sqs.Client.DeleteMessageBatch for completeness:

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.

func (*Client) ReceiveMessage

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

ReceiveMessage is a wrapper for the github.com/aws/aws-sdk-go-v2/service/sqs.Client.ReceiveMessage function, but it automatically retrieves S3 files for each applicable message returned by the internal ReceiveMessage call.

For each record in the provided event, if the configured Reserved Attribute Name ("ExtendedPayloadSize" by default) IS NOT present, the record is copied over without change to the returned event. However, if the Reserved Attribute Name IS present, the body of the record will be parsed to determine the S3 location of the full message body. This S3 location is read, and the body of the record will be overwritten with the contents. The last update is made to the record's ReceiptHandle, setting it to a unique pattern for the Extended SQS Client to be able to delete the S3 file when the SQS message is deleted (see *Client.DeleteMessage for more details).

AWS doc for github.com/aws/aws-sdk-go-v2/service/sqs.Client.ReceiveMessage for completeness:

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.

func (*Client) RetrieveLambdaEvent

func (c *Client) RetrieveLambdaEvent(ctx context.Context, evt *events.SQSEvent) (*events.SQSEvent, error)

RetrieveLambdaEvent is very similar to ReceiveMessage, but it operates on an already-fetched event (events.SQSEvent). This is meant to be used by those who need to interact with Extended SQS Messages that originate from a SQS -> Lambda event source. This function will fetch applicable S3 messages for a provided github.com/aws/aws-lambda-go/events.SQSEvent. The provided SQSEvent will NOT be mutated, and a new SQSEvent will be returned that has a cloned Records array with any S3 Pointers resolved to their actual files.

For each record in the provided event, if the configured Reserved Attribute Name ("ExtendedPayloadSize" by default) IS NOT present, the record is copied over without change to the returned event. However, if the Reserved Attribute Name IS present, the body of the record will be parsed to determine the S3 location of the full message body. This S3 location is read, and the body of the record will be overwritten with the contents. The last update is made to the record's ReceiptHandle, setting it to a unique pattern for the Extended SQS Client to be able to delete the S3 file when the SQS message is deleted (see *Client.DeleteMessage for more details).

func (*Client) SendMessage

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

Extended SQS Client wrapper around github.com/aws/aws-sdk-go-v2/service/sqs.Client.SendMessage. If the provided message exceeds the message size threshold (defaults to 256KiB), then the message will be uploaded to S3. Assuming a successful upload, the message will be altered by:

  1. Adding a custom attribute under the configured reserved attribute name that contains the size of the large payload.
  2. Body of the original message overridden with a S3 Pointer to the newly created S3 location that holds the entirety of the message

The S3 bucket used for large messages can be specified at either the client level (through the WithS3BucketName ClientOption) or for an individual call by appending the QueueURL with a "|" and the bucket name. For example: "https://sqs.amazonaws.com/1234/queue|bucket-for-messages". If the bucket name is provided like this, it will override any S3 bucket that was provided at the client level.

AWS doc for github.com/aws/aws-sdk-go-v2/service/sqs.Client.SendMessage for completeness:

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.

func (*Client) SendMessageBatch

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

Extended SQS Client wrapper around github.com/aws/aws-sdk-go-v2/service/sqs.Client.SendMessageBatch. When preparing the messages for transport, if the size of any message exceeds the messageSizeThreshold or if alwaysS3 is set to true, the message will be uploaded to S3. For the remaining messages, this method will calculate the least amount of messages required to upload to S3 in order to reduce the overall payload size under the batchMessageSizeThreshold. If there are multiple combinations to reduce the payload below the threshold with uploading the same amount of messages, preference will be given to the combination that results in the smallest amount of data sent to S3 in order to minimize costs.

For each message that is successfully uploaded to S3, the messages will be altered by:

  1. Adding a custom attribute under the configured reserved attribute name that contains the size of the large payload.
  2. Body of the original message overridden with a S3 Pointer to the newly created S3 location that holds the entirety of the message.

After all applicable messages are uploaded to S3, then the SQS native SendMessageBatch call is invoked.

The S3 bucket used for large messages can be specified at either the client level (through the WithS3BucketName ClientOption) or for an individual call by appending the QueueURL with a "|" and the bucket name. For example: "https://sqs.amazonaws.com/1234/queue|bucket-for-messages". If the bucket name is provided like this, it will override any S3 bucket that was provided at the client level.

AWS doc for github.com/aws/aws-sdk-go-v2/service/sqs.Client.SendMessageBatch for completeness:

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.

type ClientOption

type ClientOption func(*Client) error

func WithAlwaysS3

func WithAlwaysS3(alwaysS3 bool) ClientOption

Set the behavior of the client to always send messages to S3, regardless of the size of their body or attributes. By default this is false.

func WithBatchMessageSizeThreshold

func WithBatchMessageSizeThreshold(size int) ClientOption

Set the BatchMessageSizeThreshold to some other value (in bytes). By default this is 262144 (256 KiB).

func WithLogger added in v1.4.0

func WithLogger(logger Logger) ClientOption

WithLogger allows the caller to control how messages will be logged from the client. The expected interface matches the `log/slog` function signature and will default to a TextHandler unless overwritten by this method.

func WithMessageSizeThreshold

func WithMessageSizeThreshold(size int) ClientOption

Set the MessageSizeThreshold to some other value (in bytes). By default this is 262144 (256 KiB).

func WithObjectPrefix

func WithObjectPrefix(prefix string) ClientOption

WithObjectPrefix attaches a prefix to the object key (prefix/uuid)

func WithPointerClass

func WithPointerClass(pointerClass string) ClientOption

Override PointerClass with custom value (i.e. LegacyS3PointerClass)

func WithReservedAttributeNames

func WithReservedAttributeNames(attributeNames []string) ClientOption

WithReservedAttributeNames allows the user of the client to provide a list of attributes that will be used to identify large messages both sent and received by the created client. When sending messages, only the first attribute provided will be attached to the MessageAttributes. When receiving messages, all provided attributes will be checked to determine if the message has an extended payload in S3.

func WithS3BucketName

func WithS3BucketName(bucketName string) ClientOption

Set the destination bucket for large messages that are sent by this client. This is a soft-requirement for using the SendMessage function.

type Logger added in v1.4.0

type Logger interface {
	Warn(msg string, args ...any)
}

type S3Client

type S3Client interface {
	PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
	GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
	DeleteObjects(ctx context.Context, params *s3.DeleteObjectsInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectsOutput, error)
}

type SQSClient

type SQSClient interface {
	// Options returns a copy of the client configuration.
	//
	// Callers SHOULD NOT perform mutations on any inner structures within client
	// config. Config overrides should instead be made on a per-operation basis through
	// functional options.
	Options() sqs.Options
	// 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.
	AddPermission(ctx context.Context, params *sqs.AddPermissionInput, optFns ...func(*sqs.Options)) (*sqs.AddPermissionOutput, error)
	// 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.
	CancelMessageMoveTask(ctx context.Context, params *sqs.CancelMessageMoveTaskInput, optFns ...func(*sqs.Options)) (*sqs.CancelMessageMoveTaskOutput, 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 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.
	ChangeMessageVisibility(ctx context.Context, params *sqs.ChangeMessageVisibilityInput, optFns ...func(*sqs.Options)) (*sqs.ChangeMessageVisibilityOutput, 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 .
	ChangeMessageVisibilityBatch(ctx context.Context, params *sqs.ChangeMessageVisibilityBatchInput, optFns ...func(*sqs.Options)) (*sqs.ChangeMessageVisibilityBatchOutput, 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 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.
	CreateQueue(ctx context.Context, params *sqs.CreateQueueInput, optFns ...func(*sqs.Options)) (*sqs.CreateQueueOutput, 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
	// 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.
	DeleteMessage(ctx context.Context, params *sqs.DeleteMessageInput, optFns ...func(*sqs.Options)) (*sqs.DeleteMessageOutput, 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 .
	DeleteMessageBatch(ctx context.Context, params *sqs.DeleteMessageBatchInput, optFns ...func(*sqs.Options)) (*sqs.DeleteMessageBatchOutput, 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 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.
	DeleteQueue(ctx context.Context, params *sqs.DeleteQueueInput, optFns ...func(*sqs.Options)) (*sqs.DeleteQueueOutput, 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.
	GetQueueAttributes(ctx context.Context, params *sqs.GetQueueAttributesInput, optFns ...func(*sqs.Options)) (*sqs.GetQueueAttributesOutput, 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 SQS Developer Guide.
	GetQueueUrl(ctx context.Context, params *sqs.GetQueueUrlInput, optFns ...func(*sqs.Options)) (*sqs.GetQueueUrlOutput, 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 SQS Developer Guide.
	ListDeadLetterSourceQueues(ctx context.Context, params *sqs.ListDeadLetterSourceQueuesInput, optFns ...func(*sqs.Options)) (*sqs.ListDeadLetterSourceQueuesOutput, error)
	// 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.
	ListMessageMoveTasks(ctx context.Context, params *sqs.ListMessageMoveTasksInput, optFns ...func(*sqs.Options)) (*sqs.ListMessageMoveTasksOutput, 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 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.
	ListQueueTags(ctx context.Context, params *sqs.ListQueueTagsInput, optFns ...func(*sqs.Options)) (*sqs.ListQueueTagsOutput, 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 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.
	ListQueues(ctx context.Context, params *sqs.ListQueuesInput, optFns ...func(*sqs.Options)) (*sqs.ListQueuesOutput, error)
	// 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.
	PurgeQueue(ctx context.Context, params *sqs.PurgeQueueInput, optFns ...func(*sqs.Options)) (*sqs.PurgeQueueOutput, 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 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.
	ReceiveMessage(ctx context.Context, params *sqs.ReceiveMessageInput, optFns ...func(*sqs.Options)) (*sqs.ReceiveMessageOutput, 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 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.
	RemovePermission(ctx context.Context, params *sqs.RemovePermissionInput, optFns ...func(*sqs.Options)) (*sqs.RemovePermissionOutput, 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) .
	SendMessage(ctx context.Context, params *sqs.SendMessageInput, optFns ...func(*sqs.Options)) (*sqs.SendMessageOutput, error)
	// 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.
	SendMessageBatch(ctx context.Context, params *sqs.SendMessageBatchInput, optFns ...func(*sqs.Options)) (*sqs.SendMessageBatchOutput, 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 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.
	SetQueueAttributes(ctx context.Context, params *sqs.SetQueueAttributesInput, optFns ...func(*sqs.Options)) (*sqs.SetQueueAttributesOutput, error)
	// 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.
	StartMessageMoveTask(ctx context.Context, params *sqs.StartMessageMoveTaskInput, optFns ...func(*sqs.Options)) (*sqs.StartMessageMoveTaskOutput, 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 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.
	TagQueue(ctx context.Context, params *sqs.TagQueueInput, optFns ...func(*sqs.Options)) (*sqs.TagQueueOutput, 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 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.
	UntagQueue(ctx context.Context, params *sqs.UntagQueueInput, optFns ...func(*sqs.Options)) (*sqs.UntagQueueOutput, error)
}

SQSClient is a wrapper interface for the github.com/aws/aws-sdk-go-v2/service/sqs.Client. Client provides the API client to make operations call for Amazon Simple Queue Service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL