DescribeTaskExecution
Returns detailed metadata about a task that is being executed.
Request Syntax
{
"TaskExecutionArn": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- TaskExecutionArn
-
The Amazon Resource Name (ARN) of the task that is being executed.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$
Required: Yes
Response Syntax
{
"BytesCompressed": number,
"BytesTransferred": number,
"BytesWritten": number,
"EstimatedBytesToTransfer": number,
"EstimatedFilesToTransfer": number,
"Excludes": [
{
"FilterType": "string",
"Value": "string"
}
],
"FilesTransferred": number,
"Includes": [
{
"FilterType": "string",
"Value": "string"
}
],
"Options": {
"Atime": "string",
"BytesPerSecond": number,
"Gid": "string",
"LogLevel": "string",
"Mtime": "string",
"ObjectTags": "string",
"OverwriteMode": "string",
"PosixPermissions": "string",
"PreserveDeletedFiles": "string",
"PreserveDevices": "string",
"SecurityDescriptorCopyFlags": "string",
"TaskQueueing": "string",
"TransferMode": "string",
"Uid": "string",
"VerifyMode": "string"
},
"Result": {
"ErrorCode": "string",
"ErrorDetail": "string",
"PrepareDuration": number,
"PrepareStatus": "string",
"TotalDuration": number,
"TransferDuration": number,
"TransferStatus": "string",
"VerifyDuration": number,
"VerifyStatus": "string"
},
"StartTime": number,
"Status": "string",
"TaskExecutionArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- BytesCompressed
-
The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than
BytesTransferred
unless the data isn't compressible.Type: Long
- BytesTransferred
-
The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see
BytesCompressed
.Type: Long
- BytesWritten
-
The number of logical bytes written to the destination AWS storage resource.
Type: Long
- EstimatedBytesToTransfer
-
The estimated physical number of bytes that is to be transferred over the network.
Type: Long
- EstimatedFilesToTransfer
-
The expected number of files that is to be transferred over the network. This value is calculated during the
PREPARING
phase before theTRANSFERRING
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.Type: Long
- Excludes
-
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
Type: Array of FilterRule objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
- FilesTransferred
-
The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the
TRANSFERRING
phase of the task execution. It's updated periodically when each file is read from the source and sent over the network.If failures occur during a transfer, this value can be less than
EstimatedFilesToTransfer
. In some cases, this value can also be greater thanEstimatedFilesToTransfer
. 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.Type: Long
- Includes
-
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
Type: Array of FilterRule objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
- Options
-
Configures your AWS DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.
Each task setting has a default value. Unless you need to, you don't have to configure any of these
Options
before starting your task.Type: Options object
- Result
-
The result of the task execution.
Type: TaskExecutionResultDetail object
- StartTime
-
The time that the task execution was started.
Type: Timestamp
- Status
-
The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses.
Type: String
Valid Values:
QUEUED | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR
- TaskExecutionArn
-
The Amazon Resource Name (ARN) of the task execution that was described.
TaskExecutionArn
is hierarchical and includesTaskArn
for the task that was executed.For example, a
TaskExecution
value with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
Examples
Sample Request
This example illustrates a DescribeTaskExecution
request.
{ "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" }
Sample Response
This example illustrates a DescribeTaskExecution
response.
{ "BytesCompressed": "3500", "BytesTransferred": "5000", "BytesWritten": "5000", "EstimatedBytesToTransfer": "5000", "EstimatedFilesToTransfer": "100", "FilesTransferred": "100", "Result": { "ErrorCode": "??????", "ErrorDetail": "??????", "PrepareDuration": "100", "PrepareStatus": "SUCCESS", "TransferDuration": "60", "TransferStatus": "AVAILABLE", "VerifyDuration": "30", "VerifyStatus": "SUCCESS" }, "StartTime": "1532660733.39", "Status": "SUCCESS", "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": "1000", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: