Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444219188.6 KB

Returns metadata about a task.

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

Headers

X-Amz-Target'FmrsService.DescribeTask' required

Request body

TaskArnstring required

The Amazon Resource Name (ARN) of the task to describe.

Response

Success

TaskArnstring

The Amazon Resource Name (ARN) of the task that was described.

Status'AVAILABLE' | 'CREATING' | 'QUEUED' | 'RUNNING' | 'UNAVAILABLE'
<p>The status of the task that was described.</p> <p>For detailed information about task execution statuses, see Understanding Task Statuses in the <i>DataSync User Guide</i>.</p>
Namestring

The name of the task that was described.

CurrentTaskExecutionArnstring

The Amazon Resource Name (ARN) of the task execution that is transferring files.

SourceLocationArnstring

The Amazon Resource Name (ARN) of the source file system's location.

DestinationLocationArnstring

The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

CloudWatchLogGroupArnstring
<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.</p> <p>For more information on these groups, see Working with Log Groups and Log Streams in the <i>Amazon CloudWatch User Guide</i>.</p>
SourceNetworkInterfaceArnsNetworkInterfaceArn[]

The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network interface requirements</a>.

DestinationNetworkInterfaceArnsNetworkInterfaceArn[]

The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network interface requirements</a>.

ErrorCodestring

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

ErrorDetailstring

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

CreationTimestring date-time

The time that the task was created.