List Message Move Tasks

sqs_list_message_move_tasks

R Documentation

Gets the most recent message movement tasks (up to 10) under a specific source queue

Description

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) 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_list_message_move_tasks(SourceArn, MaxResults)

Arguments

SourceArn

[required] The ARN of the queue whose message movement tasks are to be listed.

MaxResults

The maximum number of results to include in the response. The default is 1, which provides the most recent message movement task. The upper limit is 10.

Value

A list with the following syntax:

list(
  Results = list(
    list(
      TaskHandle = "string",
      Status = "string",
      SourceArn = "string",
      DestinationArn = "string",
      MaxNumberOfMessagesPerSecond = 123,
      ApproximateNumberOfMessagesMoved = 123,
      ApproximateNumberOfMessagesToMove = 123,
      FailureReason = "string",
      StartedTimestamp = 123
    )
  )
)

Request syntax

svc$list_message_move_tasks(
  SourceArn = "string",
  MaxResults = 123
)