Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444219188.6 KB

Returns detailed metadata about a task that is being executed.

post/#X-Amz-Target=FmrsService.DescribeTaskExecution

Headers

X-Amz-Target'FmrsService.DescribeTaskExecution' required

Request body

TaskExecutionArnstring required

The Amazon Resource Name (ARN) of the task that is being executed.

Response

Success

TaskExecutionArnstring
<p>The Amazon Resource Name (ARN) of the task execution that was described. <code>TaskExecutionArn</code> is hierarchical and includes <code>TaskArn</code> for the task that was executed. </p> <p>For example, a <code>TaskExecution</code> value with the ARN <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b</code> executed the task with the ARN <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2</code>. </p>
Status'QUEUED' | 'LAUNCHING' | 'PREPARING' | 'TRANSFERRING' | 'VERIFYING' | 'SUCCESS' | 'ERROR'
<p>The status of the task execution. </p> <p>For detailed information about task execution statuses, see Understanding Task Statuses in the <i>DataSync User Guide.</i> </p>
StartTimestring date-time

The time that the task execution was started.

EstimatedFilesToTransferinteger

The expected number of files that is to be transferred over the network. This value is calculated during the <code>PREPARING</code> phase before the <code>TRANSFERRING</code> phase of the task execution. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

EstimatedBytesToTransferinteger

The estimated physical number of bytes that is to be transferred over the network.

FilesTransferredinteger
<p>The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the <code>TRANSFERRING</code> phase of the task execution. It's updated periodically when each file is read from the source and sent over the network. </p> <p>If failures occur during a transfer, this value can be less than <code>EstimatedFilesToTransfer</code>. In some cases, this value can also be greater than <code>EstimatedFilesToTransfer</code>. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.</p>
BytesWritteninteger

The number of logical bytes written to the destination Amazon Web Services storage resource.

BytesTransferredinteger

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see <code>BytesCompressed</code>.

BytesCompressedinteger

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than <code>BytesTransferred</code> unless the data isn't compressible.