Some DescribeTaskExecution response elements are only relevant to a
- * specific task mode. For information, see Understanding task mode differences and Understanding data
- * transfer performance metrics.
- * ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
ENHANCED - Transfer virtually unlimited numbers of objects with higher
+ * performance than Basic mode. Enhanced mode tasks optimize the data transfer process by
+ * listing, preparing, transferring, and verifying data in parallel. Enhanced mode is
+ * currently available for transfers between Amazon S3 locations.
* To create an Enhanced mode task, the IAM role that you use to call
* the CreateTask operation must have the
@@ -2787,8 +2790,10 @@ export interface CreateTaskRequest {
*
* BASIC (default) - Transfer files or objects between Amazon Web Services
- * storage and on-premises, edge, or other cloud storage. DataSync
- * quotas apply.
For more information, see Understanding task mode differences.
@@ -4904,7 +4909,7 @@ export interface TaskExecutionFilesListedDetail { AtSource?: number | undefined; /** - *The number of objects that DataSync finds at your destination location. This metric is only applicable if you configure your task to delete data in the destination that isn't in the source.
+ *The number of objects that DataSync finds at your destination location. This counter is only applicable if you configure your task to delete data in the destination that isn't in the source.
* @public */ AtDestinationForDelete?: number | undefined; @@ -5117,9 +5122,7 @@ export interface DescribeTaskExecutionResponse { /** *The number of files, objects, and directories that DataSync expects to
- * transfer over the network. This value is calculated during the task execution's
- * PREPARING
- * step before the TRANSFERRING step.
How this gets calculated depends primarily on your task’s transfer * mode configuration:
*The number of files, objects, and directories that DataSync actually
- * transfers over the network. This value is updated periodically during the task execution's
- * TRANSFERRING
- * step 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
@@ -5190,10 +5192,6 @@ export interface DescribeTaskExecutionResponse {
/**
*
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.
- *Not currently supported with Enhanced mode - * tasks.
- *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.
0.
* @public
*/
FilesDeleted?: number | undefined;
@@ -5248,9 +5245,8 @@ export interface DescribeTaskExecutionResponse {
/**
* 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.
0.
* @public
*/
EstimatedFilesToDelete?: number | undefined;
@@ -5268,7 +5264,9 @@ export interface DescribeTaskExecutionResponse {
* Applies only to Enhanced mode * tasks.
* - *This metric 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.
+ *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.
* @public */ FilesPrepared?: number | undefined; diff --git a/codegen/sdk-codegen/aws-models/datasync.json b/codegen/sdk-codegen/aws-models/datasync.json index 06f4c7da7c18d..a55139fcf0124 100644 --- a/codegen/sdk-codegen/aws-models/datasync.json +++ b/codegen/sdk-codegen/aws-models/datasync.json @@ -1572,7 +1572,7 @@ "TaskMode": { "target": "com.amazonaws.datasync#TaskMode", "traits": { - "smithy.api#documentation": "Specifies one of the following task modes for your data transfer:
\n\n ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
To create an Enhanced mode task, the IAM role that you use to call\n the CreateTask operation must have the\n iam:CreateServiceLinkedRole permission.
\n BASIC (default) - Transfer files or objects between Amazon Web Services\n storage and on-premises, edge, or other cloud storage. DataSync\n quotas apply.
For more information, see Understanding task mode differences.
" + "smithy.api#documentation": "Specifies one of the following task modes for your data transfer:
\n\n ENHANCED - Transfer virtually unlimited numbers of objects with higher\n performance than Basic mode. Enhanced mode tasks optimize the data transfer process by\n listing, preparing, transferring, and verifying data in parallel. Enhanced mode is\n currently available for transfers between Amazon S3 locations.
To create an Enhanced mode task, the IAM role that you use to call\n the CreateTask operation must have the\n iam:CreateServiceLinkedRole permission.
\n BASIC (default) - Transfer files or objects between Amazon Web Services\n storage and all other supported DataSync locations. Basic mode tasks are subject\n to quotas on the number of files, objects, and directories in a dataset. Basic\n mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced\n mode for most workloads.
For more information, see Understanding task mode differences.
" } } }, @@ -3176,7 +3176,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing data transfer or check the\n results of the transfer.
\nSome DescribeTaskExecution response elements are only relevant to a\n specific task mode. For information, see Understanding task mode differences and Understanding data\n transfer performance metrics.
Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing data transfer or check the\n results of the transfer.
\nSome DescribeTaskExecution response elements are only relevant to a\n specific task mode. For information, see Understanding task mode differences and Understanding data\n transfer performance counters.
The number of files, objects, and directories that DataSync expects to\n transfer over the network. This value is calculated during the task execution's\n PREPARING\n step before the TRANSFERRING step.
How this gets calculated depends primarily on your task’s transfer\n mode configuration:
\nIf TranserMode is set to CHANGED - The calculation is based\n on comparing the content of the source and destination locations and determining the\n difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
\nAnything that's in both locations and modified at the destination after an initial\n transfer (unless OverwriteMode is set to NEVER).
\n (Basic task mode only) The number of items that\n DataSync expects to delete (if PreserveDeletedFiles is set to\n REMOVE).
If TranserMode is set to ALL - The calculation is based only\n on the items that DataSync finds at the source location.
The number of files, objects, and directories that DataSync expects to\n transfer over the network. This value is calculated while DataSync prepares the transfer.
\nHow this gets calculated depends primarily on your task’s transfer\n mode configuration:
\nIf TranserMode is set to CHANGED - The calculation is based\n on comparing the content of the source and destination locations and determining the\n difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
\nAnything that's in both locations and modified at the destination after an initial\n transfer (unless OverwriteMode is set to NEVER).
\n (Basic task mode only) The number of items that\n DataSync expects to delete (if PreserveDeletedFiles is set to\n REMOVE).
If TranserMode is set to ALL - The calculation is based only\n on the items that DataSync finds at the source location.
The number of files, objects, and directories that DataSync actually\n transfers over the network. This value is updated periodically during the task execution's\n TRANSFERRING\n step when something is read from the source and sent over the network.
If DataSync fails to transfer something, this value can be less than\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an exact indication of what's transferring or to monitor\n your task execution.
The number of files, objects, and directories that DataSync actually\n transfers over the network. This value is updated periodically during your task execution when\n something is read from the source and sent over the network.
\nIf DataSync fails to transfer something, this value can be less than\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an exact indication of what's transferring or to monitor\n your task execution.
The number of physical bytes that DataSync transfers over the network after\n compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
\nNot currently supported with Enhanced mode\n tasks.
\nThe number of physical bytes that DataSync transfers over the network after\n compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
" } }, "Result": { @@ -3295,7 +3295,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of files, objects, and directories that DataSync actually deletes in\n your destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.
The number of files, objects, and directories that DataSync actually deletes in\n your destination location. If you don't configure your task to delete data in the destination that\n isn't in the source, the value is always 0.
The number of files, objects, and directories that DataSync expects to delete in\n your destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.
The number of files, objects, and directories that DataSync expects to delete in\n your destination location. If you don't configure your task to delete data in the destination that\n isn't in the source, the value is always 0.
The number of objects that DataSync will attempt to transfer after comparing\n your source and destination locations.
\nApplies only to Enhanced mode\n tasks.
\nThis metric 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.
" + "smithy.api#documentation": "The number of objects that DataSync will attempt to transfer after comparing\n your source and destination locations.
\nApplies only to Enhanced mode\n tasks.
\nThis counter isn't applicable if you configure your task to transfer\n all data. In that scenario, DataSync copies everything from the source to\n the destination without comparing differences between the locations.
" } }, "FilesListed": { @@ -8523,7 +8523,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of objects that DataSync finds at your destination location. This metric is only applicable if you configure your task to delete data in the destination that isn't in the source.
" + "smithy.api#documentation": "The number of objects that DataSync finds at your destination location. This counter is only applicable if you configure your task to delete data in the destination that isn't in the source.
" } } },