ListMessageMoveTasksResultEntry - Amazon Simple Queue Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ListMessageMoveTasksResultEntry

Contains the details of a message movement task.

Contents

ApproximateNumberOfMessagesMoved

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

Type: Long

Required: No

ApproximateNumberOfMessagesToMove

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 is only included after the message movement task is selected to start.

Type: Long

Required: No

DestinationArn

The ARN of the destination queue if it has been specified in the StartMessageMoveTask request. If a DestinationArn has not been specified in the StartMessageMoveTask request, this field value will be NULL.

Type: String

Required: No

FailureReason

The task failure reason (only included if the task status is FAILED).

Type: String

Required: No

MaxNumberOfMessagesPerSecond

The number of messages to be moved per second (the message movement rate), if it has been specified in the StartMessageMoveTask request. If a MaxNumberOfMessagesPerSecond has not been specified in the StartMessageMoveTask request, this field value will be NULL.

Type: Integer

Required: No

SourceArn

The ARN of the queue that contains the messages to be moved to another queue.

Type: String

Required: No

StartedTimestamp

The timestamp of starting the message movement task.

Type: Long

Required: No

Status

The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.

Type: String

Required: No

TaskHandle

An identifier associated with a message movement task. When this field is returned in the response of the ListMessageMoveTasks action, it is only populated for tasks that are in RUNNING status.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: