Skip to main content

ISQSListMessageMoveTasksResultEntry

Interface in AWS.SQS

Interface for SQS ListMessageMoveTasksResultEntry.

Properties​

ApproximateNumberOfMessagesMoved​

property ApproximateNumberOfMessagesMoved: TOptional<Int64>

The approximate number of messages already moved to the destination queue.

This value represents the count of messages that have been successfully transferred from the source queue to the destination queue as part of this movement task. The count is approximate due to the distributed nature of Amazon SQS and may not reflect the exact number at any given moment.

ApproximateNumberOfMessagesToMove​

property ApproximateNumberOfMessagesToMove: TOptional<Int64>

The number of messages to be moved from the source queue.

This number is obtained at the time of starting the message movement task and represents the total count of messages that were available for movement. This field is only populated after the message movement task is selected to start and may not reflect messages added to the source queue after task initiation.

DestinationArn​

property DestinationArn: TARN

The ARN of the destination queue where messages are being moved.

This field contains the Amazon Resource Name (ARN) of the destination queue if it was specified in the StartMessageMoveTask request. If no destination ARN was specified when starting the task, this field will be null. The destination can be the original source queue or a custom destination queue.

FailureReason​

property FailureReason: string

The reason for task failure when the movement task has failed.

This field is only populated when the task status is FAILED and provides detailed information about what caused the message movement task to fail. For tasks in other states (RUNNING, COMPLETED, CANCELLING, CANCELLED), this field will be empty.

MaxNumberOfMessagesPerSecond​

property MaxNumberOfMessagesPerSecond: TOptional<Integer>

The configured message movement rate in messages per second.

This field contains the rate limit for message movement if it was specified in the StartMessageMoveTask request to control throughput. If no rate limit was specified when starting the task, this field will be null and messages will be moved at the default system rate.

SourceArn​

property SourceArn: TARN

The ARN of the source queue containing the messages to be moved.

This field contains the Amazon Resource Name (ARN) of the source queue, typically a dead-letter queue (DLQ) from which messages are being redriven. The source queue ARN identifies the queue that was specified when the message movement task was initiated.

StartedTimestamp​

property StartedTimestamp: TOptional<TDateTime>

The timestamp when the message movement task was started.

This value represents the time when the message movement task was initiated. This timestamp can be used to determine the age and duration of message movement tasks.

Status​

property Status: string

The current status of the message movement task.

Possible status values include:

  • RUNNING – The task is actively moving messages
  • COMPLETED – All messages have been successfully moved
  • CANCELLING – The task is in the process of being cancelled
  • CANCELLED – The task has been successfully cancelled
  • FAILED – The task has failed (see FailureReason for details)

TaskHandle​

property TaskHandle: string

An identifier associated with the message movement task for cancellation operations.

This handle is used to identify and cancel the specific message movement task using the CancelMessageMoveTask operation. The task handle is only populated for tasks that are in RUNNING status. For completed, cancelled, or failed tasks, this field will be null.