Cancel Message Move Task

sqs_cancel_message_move_task

R Documentation

Cancels a specified message movement task

Description

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.

Usage

sqs_cancel_message_move_task(TaskHandle)

Arguments

TaskHandle

[required] An identifier associated with a message movement task.

Value

A list with the following syntax:

list(
  ApproximateNumberOfMessagesMoved = 123
)

Request syntax

svc$cancel_message_move_task(
  TaskHandle = "string"
)