Amazon Web Services/CancelMessageMoveTask

Loading the complete reference automatically…

Amazon Web ServicesAmazon SQS message-queue API

CancelMessageMoveTask

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

Only one active message movement task is supported per queue at any given time.

The complete 23-action Amazon Simple Queue Service API, preserving AWS JSON 1.0, AWS Query compatibility, SigV4, and regional endpoint rules. The web Playground does not yet have an AWS SigV4 and region-selection execution adapter; use the local SDK/CLI to call SQS.

Request

operationId
CancelMessageMoveTask
Server
https://sqs.{Region}.{PartitionResult#dnsSuffix}
Authentication
awsSigV4

Request parameters

No URL, query, or header parameters.

Request body

stringrequired

Responses

200

string

Successful response.

error

string

Declared service error