| Column Name | Column Data Type |
|---|
task_execution_arn Required Input Column
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. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
bytes_compressed
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. | BIGINT |
bytes_transferred
The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed. | BIGINT |
bytes_written
The number of logical bytes written to the destination location. | BIGINT |
estimated_bytes_to_transfer
The estimated physical number of bytes that will transfer over the network. | BIGINT |
estimated_files_to_delete
The expected number of files, objects, and directories that DataSync will 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. | BIGINT |
estimated_files_to_transfer
The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred. | BIGINT |
excludes
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync. | STRUCT(
"filter_type" VARCHAR,
"value" VARCHAR
)[] |
Show child fields- excludes[]
Show child fields- excludes[].filter_type
The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type. - excludes[].value
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
|
files_deleted
The number of files, objects, and directories that DataSync deleted 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. | BIGINT |
files_skipped
The number of files, objects, and directories that DataSync skipped during your transfer. | BIGINT |
files_transferred
The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase 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 transferred or to monitor your task execution. | BIGINT |
files_verified
The number of files, objects, and directories that DataSync verified 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. | BIGINT |
includes
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync. | STRUCT(
"filter_type" VARCHAR,
"value" VARCHAR
)[] |
Show child fields- includes[]
Show child fields- includes[].filter_type
The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type. - includes[].value
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
|
manifest_config
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. | STRUCT(
"action" VARCHAR,
"format" VARCHAR,
"source" STRUCT(
"s3" STRUCT(
"manifest_object_path" VARCHAR,
"bucket_access_role_arn" VARCHAR,
"s3_bucket_arn" VARCHAR,
"manifest_object_version_id" VARCHAR
)
)
) |
Show child fields- manifest_config.action
Specifies what DataSync uses the manifest for. - manifest_config.format
Specifies the file format of your manifest. For more information, see Creating a manifest. - manifest_config.source
Specifies the manifest that you want DataSync to use and where it's hosted. You must specify this parameter if you're configuring a new manifest on or after February 7, 2024. If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest. Show child fields- manifest_config.source.s3
Specifies the S3 bucket where you're hosting your manifest. Show child fields- manifest_config.source.s3.bucket_access_role_arn
Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest. - manifest_config.source.s3.manifest_object_path
Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv). - manifest_config.source.s3.manifest_object_version_id
Specifies the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object. - manifest_config.source.s3.s3_bucket_arn
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
|
options
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. | STRUCT(
"verify_mode" VARCHAR,
"overwrite_mode" VARCHAR,
"atime" VARCHAR,
"mtime" VARCHAR,
"uid" VARCHAR,
"gid" VARCHAR,
"preserve_deleted_files" VARCHAR,
"preserve_devices" VARCHAR,
"posix_permissions" VARCHAR,
"bytes_per_second" BIGINT,
"task_queueing" VARCHAR,
"log_level" VARCHAR,
"transfer_mode" VARCHAR,
"security_descriptor_copy_flags" VARCHAR,
"object_tags" VARCHAR
) |
Show child fields- options.atime
Specifies whether to preserve metadata indicating the last time a file was read or written to. The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis. If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE. - options.bytes_per_second
Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). - options.gid
Specifies the POSIX group ID (GID) of the file's owners. -
INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended. -
NONE - Ignores UID and GID. For more information, see Metadata copied by DataSync. - options.log_level
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn. -
BASIC - Publishes logs with only basic information (such as transfer errors). -
TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on. -
OFF - No logs are published. - options.mtime
Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once. If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. If Mtime is set to NONE, Atime must also be set to NONE. - options.object_tags
Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. - options.overwrite_mode
Specifies whether DataSync should modify or preserve data at the destination location. -
ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers. -
NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination. - options.posix_permissions
Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. For more information, see Metadata copied by DataSync. -
PRESERVE (default) - Preserves POSIX-style permissions, which is recommended. -
NONE - Ignores POSIX-style permissions. DataSync can preserve extant permissions of a source location. - options.preserve_deleted_files
Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync. -
PRESERVE (default) - Ignores such destination files, which is recommended. -
REMOVE - Deletes destination files that aren’t present in the source. If you set this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete. - options.preserve_devices
Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices. DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker. - options.security_descriptor_copy_flags
Specifies which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata. -
OWNER_DACL (default) - For each copied object, DataSync copies the following metadata: -
The object owner. -
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. DataSync won't copy NTFS system access control lists (SACLs) with this option. -
OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata: -
The object owner. -
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. -
SACLs, which are used by administrators to log attempts to access a secured object. Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer). -
NONE - None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration. - options.task_queueing
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is ENABLED by default. - options.transfer_mode
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination). -
CHANGED (default) - DataSync copies only data or metadata that is new or different content from the source location to the destination location. -
ALL - DataSync copies everything in the source to the destination without comparing differences between the locations. - options.uid
Specifies the POSIX user ID (UID) of the file's owner. -
INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended. -
NONE - Ignores UID and GID. For more information, see Metadata copied by DataSync. - options.verify_mode
Specifies how and when DataSync checks the integrity of your data during a transfer. -
ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination. We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations. -
POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized. If you use a manifest, DataSync only scans and verifies what's listed in the manifest. You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations. -
NONE - DataSync doesn't run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.
|
report_result
Indicates whether DataSync generated a complete task report for your transfer. | STRUCT(
"status" VARCHAR,
"error_code" VARCHAR,
"error_detail" VARCHAR
) |
Show child fields- report_result.error_code
Indicates the code associated with the error if DataSync can't create a complete report. - report_result.error_detail
Provides details about issues creating a report. - report_result.status
Indicates whether DataSync is still working on your report, created a report, or can't create a complete report.
|
result
The result of the task execution. | STRUCT(
"prepare_duration" BIGINT,
"prepare_status" VARCHAR,
"total_duration" BIGINT,
"transfer_duration" BIGINT,
"transfer_status" VARCHAR,
"verify_duration" BIGINT,
"verify_status" VARCHAR,
"error_code" VARCHAR,
"error_detail" VARCHAR
) |
Show child fields- result.error_code
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues. - result.error_detail
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues. - result.prepare_duration
The total time in milliseconds that DataSync spent in the PREPARING phase. - result.prepare_status
The status of the PREPARING phase. - result.total_duration
The total time in milliseconds that DataSync took to transfer the file from the source to the destination location. - result.transfer_duration
The total time in milliseconds that DataSync spent in the TRANSFERRING phase. - result.transfer_status
The status of the TRANSFERRING phase. - result.verify_duration
The total time in milliseconds that DataSync spent in the VERIFYING phase. - result.verify_status
The status of the VERIFYING phase.
|
start_time
The time when the task execution started. | TIMESTAMP_S |
status
The status of the task execution. | VARCHAR |
task_report_config
The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report. | STRUCT(
"destination" STRUCT(
"s3" STRUCT(
"subdirectory" VARCHAR,
"s3_bucket_arn" VARCHAR,
"bucket_access_role_arn" VARCHAR
)
),
"output_type" VARCHAR,
"report_level" VARCHAR,
"object_version_ids" VARCHAR,
"overrides" STRUCT(
"transferred" STRUCT(
"report_level" VARCHAR
),
"verified" STRUCT(
"report_level" VARCHAR
),
"deleted" STRUCT(
"report_level" VARCHAR
),
"skipped" STRUCT(
"report_level" VARCHAR
)
)
) |
Show child fields- task_report_config.destination
Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports. Show child fields- task_report_config.destination.s3
Specifies the Amazon S3 bucket where DataSync uploads your task report. Show child fields- task_report_config.destination.s3.bucket_access_role_arn
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket. - task_report_config.destination.s3.s3_bucket_arn
Specifies the ARN of the S3 bucket where DataSync uploads your report. - task_report_config.destination.s3.subdirectory
Specifies a bucket prefix for your report.
- task_report_config.object_version_ids
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. - task_report_config.output_type
Specifies the type of task report that you want: -
SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration. -
STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more. - task_report_config.overrides
Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location. Show child fields- task_report_config.overrides.deleted
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Show child fields- task_report_config.overrides.deleted.report_level
Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).
- task_report_config.overrides.skipped
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Show child fields- task_report_config.overrides.skipped.report_level
Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).
- task_report_config.overrides.transferred
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Show child fields- task_report_config.overrides.transferred.report_level
Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).
- task_report_config.overrides.verified
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Show child fields- task_report_config.overrides.verified.report_level
Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).
- task_report_config.report_level
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. -
ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete. -
SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.
|