DescribeTaskExecutionResponse
¶
Source code in docs_src/capo_datasync/types/describe_task_execution_response.py
bytes_compressed
instance-attribute
¶
bytes_compressed: long
The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
bytes_transferred
instance-attribute
¶
bytes_transferred: long
The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
bytes_written
instance-attribute
¶
bytes_written: long
The number of logical bytes that DataSync actually writes to the destination location.
estimated_bytes_to_transfer
instance-attribute
¶
estimated_bytes_to_transfer: long
The number of logical bytes that DataSync expects to write to the destination location.
estimated_files_to_delete
instance-attribute
¶
estimated_files_to_delete: long
The number of files, objects, and directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.
For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in EstimatedFoldersToDelete.
estimated_files_to_transfer
instance-attribute
¶
estimated_files_to_transfer: long
The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
-
If
TranserModeis set toCHANGED- The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:-
Anything that's added or modified at the source location.
-
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to
NEVER). -
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to
REMOVE).
-
-
If
TranserModeis set toALL- The calculation is based only on the items that DataSync finds at the source location.
For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in EstimatedFoldersToTransfer.
estimated_folders_to_delete
instance-attribute
¶
estimated_folders_to_delete: NotRequired[ItemCount]
The number of directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.
Applies only to Enhanced mode tasks.
estimated_folders_to_transfer
instance-attribute
¶
estimated_folders_to_transfer: NotRequired[ItemCount]
The number of directories that DataSync expects to transfer over the network. This value is calculated as DataSync prepares directories to transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
-
If
TranserModeis set toCHANGED- The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:-
Anything that's added or modified at the source location.
-
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to
NEVER).
-
-
If
TranserModeis set toALL- The calculation is based only on the items that DataSync finds at the source location.
Applies only to Enhanced mode tasks.
excludes
instance-attribute
¶
excludes: NotRequired[FilterList]
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
files_deleted
instance-attribute
¶
files_deleted: long
The number of files, objects, and directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.
For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersDeleted.
files_failed
instance-attribute
¶
files_failed: NotRequired[TaskExecutionFilesFailedDetail]
The number of files or objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
Applies only to Enhanced mode tasks.
files_listed
instance-attribute
¶
files_listed: NotRequired[TaskExecutionFilesListedDetail]
The number of files or objects that DataSync finds at your locations.
Applies only to Enhanced mode tasks.
files_prepared
instance-attribute
¶
files_prepared: long
The number of files or objects that DataSync will attempt to transfer after comparing your source and destination locations.
Applies only to Enhanced mode tasks.
This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.
files_skipped
instance-attribute
¶
files_skipped: long
The number of files, objects, and directories that DataSync skips during your transfer.
For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersSkipped.
files_transferred
instance-attribute
¶
files_transferred: long
The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.
If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.
For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersTransferred.
files_verified
instance-attribute
¶
files_verified: long
The number of files, objects, and directories that DataSync verifies during your transfer.
When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.
For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersVerified.
folders_deleted
instance-attribute
¶
folders_deleted: NotRequired[ItemCount]
The number of directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.
Applies only to Enhanced mode tasks.
folders_failed
instance-attribute
¶
folders_failed: NotRequired[TaskExecutionFoldersFailedDetail]
The number of directories that DataSync fails to list, prepare, transfer, verify, and delete during your task execution.
Applies only to Enhanced mode tasks.
folders_listed
instance-attribute
¶
folders_listed: NotRequired[TaskExecutionFoldersListedDetail]
The number of directories that DataSync finds at your locations.
Applies only to Enhanced mode tasks.
folders_prepared
instance-attribute
¶
folders_prepared: NotRequired[ItemCount]
The number of directories that DataSync will attempt to transfer after comparing your source and destination locations.
Applies only to Enhanced mode tasks.
This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.
folders_skipped
instance-attribute
¶
folders_skipped: NotRequired[ItemCount]
The number of directories that DataSync skips during your transfer.
Applies only to Enhanced mode tasks.
folders_transferred
instance-attribute
¶
folders_transferred: NotRequired[ItemCount]
The number of directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.
If DataSync fails to transfer something, this value can be less than EstimatedFoldersToTransfer. In some cases, this value can also be greater than EstimatedFoldersToTransfer.
Applies only to Enhanced mode tasks.
folders_verified
instance-attribute
¶
folders_verified: NotRequired[ItemCount]
The number of directories that DataSync verifies during your transfer.
Applies only to Enhanced mode tasks.
includes
instance-attribute
¶
includes: NotRequired[FilterList]
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
launch_time
instance-attribute
¶
launch_time: NotRequired[Time]
The time that the task execution actually begins. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.
manifest_config
instance-attribute
¶
manifest_config: NotRequired[ManifestConfig]
The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
report_result
instance-attribute
¶
report_result: NotRequired[ReportResult]
Indicates whether DataSync generated a complete task report for your transfer.
result
instance-attribute
¶
result: NotRequired[TaskExecutionResultDetail]
The result of the task execution.
start_time
instance-attribute
¶
start_time: NotRequired[Time]
The time that DataSync sends the request to start the task execution. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.
status
instance-attribute
¶
status: NotRequired[TaskExecutionStatus]
The status of the task execution.
task_execution_arn
instance-attribute
¶
task_execution_arn: NotRequired[TaskExecutionArn]
The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.
For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
task_mode
instance-attribute
¶
task_mode: NotRequired[TaskMode]
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
task_report_config
instance-attribute
¶
task_report_config: NotRequired[TaskReportConfig]
The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.