task_executions
Creates, updates, deletes, gets or lists a task_executions resource.
Overview
| Name | task_executions |
| Type | Resource |
| Id | aws.datasync.task_executions |
Fields
The following fields are returned by SELECT queries:
- describe_task_execution
- list_task_executions
| Name | Datatype | Description |
|---|---|---|
bytes_compressed | integer (int64) | 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 | integer (int64) | 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 | integer (int64) | The number of logical bytes that DataSync actually writes to the destination location. |
end_time | string (date-time) | The time that the transfer task ends. |
estimated_bytes_to_transfer | integer (int64) | The number of logical bytes that DataSync expects to write to the destination location. |
estimated_files_to_delete | integer (int64) | 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 | integer (int64) | 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 TranserMode is set to CHANGED - 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 TranserMode is set to ALL - 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 | integer (int64) | 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 | integer (int64) | 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 TranserMode is set to CHANGED - 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 TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location. Applies only to Enhanced mode tasks. |
excludes | array | 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 | integer (int64) | 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 | object | 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 | object | The number of files or objects that DataSync finds at your locations. Applies only to Enhanced mode tasks. |
files_prepared | integer (int64) | 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 | integer (int64) | 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 | integer (int64) | 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 | integer (int64) | 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 | integer (int64) | 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 | object | 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 | object | The number of directories that DataSync finds at your locations. Applies only to Enhanced mode tasks. |
folders_prepared | integer (int64) | 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 | integer (int64) | The number of directories that DataSync skips during your transfer. Applies only to Enhanced mode tasks. |
folders_transferred | integer (int64) | 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 | integer (int64) | The number of directories that DataSync verifies during your transfer. Applies only to Enhanced mode tasks. |
includes | array | 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 | string (date-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 | object | 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. |
options | object | Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution. You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution. |
report_result | object | Indicates whether DataSync generated a complete task report for your transfer. |
result | object | The result of the task execution. |
start_time | string (date-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 | string | The status of the task execution. (QUEUED, CANCELLING, LAUNCHING, PREPARING, TRANSFERRING, VERIFYING, SUCCESS, ERROR) |
task_execution_arn | string | 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. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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}$</code>) |
task_mode | string | The task mode that you're using. For more information, see Choosing a task mode for your data transfer. (BASIC, ENHANCED) |
task_report_config | object | The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report. |
| Name | Datatype | Description |
|---|---|---|
status | string | The status of a task execution. For more information, see Task execution statuses. (QUEUED, CANCELLING, LAUNCHING, PREPARING, TRANSFERRING, VERIFYING, SUCCESS, ERROR) |
task_execution_arn | string | The Amazon Resource Name (ARN) of a task execution. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|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}$</code>) |
task_mode | string | The task mode that you're using. For more information, see Choosing a task mode for your data transfer. (BASIC, ENHANCED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_task_execution | select | region | Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer. Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance counters. | |
list_task_executions | select | region | Returns a list of executions for an DataSync transfer task. | |
update_task_execution | update | region, TaskExecutionArn | Updates the configuration of a running DataSync task execution. Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_task_execution
- list_task_executions
Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer. Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance counters.
SELECT
bytes_compressed,
bytes_transferred,
bytes_written,
end_time,
estimated_bytes_to_transfer,
estimated_files_to_delete,
estimated_files_to_transfer,
estimated_folders_to_delete,
estimated_folders_to_transfer,
excludes,
files_deleted,
files_failed,
files_listed,
files_prepared,
files_skipped,
files_transferred,
files_verified,
folders_deleted,
folders_failed,
folders_listed,
folders_prepared,
folders_skipped,
folders_transferred,
folders_verified,
includes,
launch_time,
manifest_config,
options,
report_result,
result,
start_time,
status,
task_execution_arn,
task_mode,
task_report_config
FROM aws.datasync.task_executions
WHERE region = '{{ region }}' -- required
;
Returns a list of executions for an DataSync transfer task.
SELECT
status,
task_execution_arn,
task_mode
FROM aws.datasync.task_executions
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_task_execution
Updates the configuration of a running DataSync task execution. Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.
UPDATE aws.datasync.task_executions
SET
TaskExecutionArn = '{{ TaskExecutionArn }}',
Options = '{{ Options }}'
WHERE
region = '{{ region }}' --required
AND TaskExecutionArn = '{{ TaskExecutionArn }}' --required;