From ff82299a6ebbc5e5f0a9eddff7776c072f0cb4e8 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Fri, 28 Jul 2023 00:29:39 +0000 Subject: [PATCH] Regenerated Clients --- .../811f921bb719455884ce4929051224fb.json | 8 ++++++++ service/sqs/api_op_CancelMessageMoveTask.go | 17 +++++++++++----- service/sqs/api_op_ListMessageMoveTasks.go | 8 ++++++++ service/sqs/api_op_PurgeQueue.go | 14 ++++++------- service/sqs/api_op_StartMessageMoveTask.go | 20 ++++++++++++------- 5 files changed, 48 insertions(+), 19 deletions(-) create mode 100644 .changelog/811f921bb719455884ce4929051224fb.json diff --git a/.changelog/811f921bb719455884ce4929051224fb.json b/.changelog/811f921bb719455884ce4929051224fb.json new file mode 100644 index 00000000000..763802136f8 --- /dev/null +++ b/.changelog/811f921bb719455884ce4929051224fb.json @@ -0,0 +1,8 @@ +{ + "id": "811f921b-b719-4558-84ce-4929051224fb", + "type": "documentation", + "description": "Documentation changes related to SQS APIs.", + "modules": [ + "service/sqs" + ] +} \ No newline at end of file diff --git a/service/sqs/api_op_CancelMessageMoveTask.go b/service/sqs/api_op_CancelMessageMoveTask.go index 049bf81233c..8b45902973f 100644 --- a/service/sqs/api_op_CancelMessageMoveTask.go +++ b/service/sqs/api_op_CancelMessageMoveTask.go @@ -10,11 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) CancelMessageMoveTask(ctx context.Context, params *CancelMessageMoveTaskInput, optFns ...func(*Options)) (*CancelMessageMoveTaskOutput, error) { if params == nil { params = &CancelMessageMoveTaskInput{} diff --git a/service/sqs/api_op_ListMessageMoveTasks.go b/service/sqs/api_op_ListMessageMoveTasks.go index 9119ff88c17..1bca34afd4f 100644 --- a/service/sqs/api_op_ListMessageMoveTasks.go +++ b/service/sqs/api_op_ListMessageMoveTasks.go @@ -13,6 +13,14 @@ import ( // 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. func (c *Client) ListMessageMoveTasks(ctx context.Context, params *ListMessageMoveTasksInput, optFns ...func(*Options)) (*ListMessageMoveTasksOutput, error) { if params == nil { params = &ListMessageMoveTasksInput{} diff --git a/service/sqs/api_op_PurgeQueue.go b/service/sqs/api_op_PurgeQueue.go index f7dc3409d37..95fa30f8fc1 100644 --- a/service/sqs/api_op_PurgeQueue.go +++ b/service/sqs/api_op_PurgeQueue.go @@ -10,13 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) PurgeQueue(ctx context.Context, params *PurgeQueueInput, optFns ...func(*Options)) (*PurgeQueueOutput, error) { if params == nil { params = &PurgeQueueInput{} diff --git a/service/sqs/api_op_StartMessageMoveTask.go b/service/sqs/api_op_StartMessageMoveTask.go index 2a8f5d1dc23..f46233c35ba 100644 --- a/service/sqs/api_op_StartMessageMoveTask.go +++ b/service/sqs/api_op_StartMessageMoveTask.go @@ -12,12 +12,16 @@ import ( // 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 -// dead-letter queues (DLQs) 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. +// - 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. func (c *Client) StartMessageMoveTask(ctx context.Context, params *StartMessageMoveTaskInput, optFns ...func(*Options)) (*StartMessageMoveTaskOutput, error) { @@ -38,7 +42,9 @@ func (c *Client) StartMessageMoveTask(ctx context.Context, params *StartMessageM type StartMessageMoveTaskInput struct { // The ARN of the queue that contains the messages to be moved to another queue. - // Currently, only dead-letter queue (DLQ) ARNs are accepted. + // Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon + // SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda + // or Amazon SNS topics, are not currently supported. // // This member is required. SourceArn *string