Skip to content

Commit 11a264e

Browse files
author
awstools
committed
docs(client-datasync): Doc-only updates and enhancements related to creating DataSync tasks and describing task executions.
1 parent 5aadfed commit 11a264e

File tree

3 files changed

+30
-32
lines changed

3 files changed

+30
-32
lines changed

clients/client-datasync/src/commands/DescribeTaskExecutionCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface DescribeTaskExecutionCommandOutput extends DescribeTaskExecutio
3333
* results of the transfer.</p>
3434
* <note>
3535
* <p>Some <code>DescribeTaskExecution</code> response elements are only relevant to a
36-
* specific task mode. For information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding task mode differences</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-metrics.html">Understanding data
37-
* transfer performance metrics</a>.</p>
36+
* specific task mode. For information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding task mode differences</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html">Understanding data
37+
* transfer performance counters</a>.</p>
3838
* </note>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

clients/client-datasync/src/models/models_0.ts

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2777,7 +2777,10 @@ export interface CreateTaskRequest {
27772777
* <ul>
27782778
* <li>
27792779
* <p>
2780-
* <code>ENHANCED</code> - 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.</p>
2780+
* <code>ENHANCED</code> - Transfer virtually unlimited numbers of objects with higher
2781+
* performance than Basic mode. Enhanced mode tasks optimize the data transfer process by
2782+
* listing, preparing, transferring, and verifying data in parallel. Enhanced mode is
2783+
* currently available for transfers between Amazon S3 locations.</p>
27812784
* <note>
27822785
* <p>To create an Enhanced mode task, the IAM role that you use to call
27832786
* the <code>CreateTask</code> operation must have the
@@ -2787,8 +2790,10 @@ export interface CreateTaskRequest {
27872790
* <li>
27882791
* <p>
27892792
* <code>BASIC</code> (default) - Transfer files or objects between Amazon Web Services
2790-
* storage and on-premises, edge, or other cloud storage. DataSync
2791-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html">quotas</a> apply.</p>
2793+
* storage and all other supported DataSync locations. Basic mode tasks are subject
2794+
* to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html">quotas</a> on the number of files, objects, and directories in a dataset. Basic
2795+
* mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced
2796+
* mode for most workloads.</p>
27922797
* </li>
27932798
* </ul>
27942799
* <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding task mode differences</a>.</p>
@@ -4904,7 +4909,7 @@ export interface TaskExecutionFilesListedDetail {
49044909
AtSource?: number | undefined;
49054910

49064911
/**
4907-
* <p>The number of objects that DataSync finds at your destination location. This metric is only applicable if you <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling">configure your task</a> to delete data in the destination that isn't in the source.</p>
4912+
* <p>The number of objects that DataSync finds at your destination location. This counter is only applicable if you <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling">configure your task</a> to delete data in the destination that isn't in the source.</p>
49084913
* @public
49094914
*/
49104915
AtDestinationForDelete?: number | undefined;
@@ -5117,9 +5122,7 @@ export interface DescribeTaskExecutionResponse {
51175122

51185123
/**
51195124
* <p>The number of files, objects, and directories that DataSync expects to
5120-
* transfer over the network. This value is calculated during the task execution's
5121-
* <code>PREPARING</code>
5122-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">step</a> before the <code>TRANSFERRING</code> step.</p>
5125+
* transfer over the network. This value is calculated while DataSync <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">prepares</a> the transfer.</p>
51235126
* <p>How this gets calculated depends primarily on your task’s <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode">transfer
51245127
* mode</a> configuration:</p>
51255128
* <ul>
@@ -5161,9 +5164,8 @@ export interface DescribeTaskExecutionResponse {
51615164

51625165
/**
51635166
* <p>The number of files, objects, and directories that DataSync actually
5164-
* transfers over the network. This value is updated periodically during the task execution's
5165-
* <code>TRANSFERRING</code>
5166-
* <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses">step</a> when something is read from the source and sent over the network.</p>
5167+
* transfers over the network. This value is updated periodically during your task execution when
5168+
* something is read from the source and sent over the network.</p>
51675169
* <p>If DataSync fails to transfer something, this value can be less than
51685170
* <code>EstimatedFilesToTransfer</code>. In some cases, this value can also be greater than
51695171
* <code>EstimatedFilesToTransfer</code>. This element is implementation-specific for some
@@ -5190,10 +5192,6 @@ export interface DescribeTaskExecutionResponse {
51905192
/**
51915193
* <p>The number of physical bytes that DataSync transfers over the network after
51925194
* compression (if compression is possible). This number is typically less than <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred">BytesTransferred</a> unless the data isn't compressible.</p>
5193-
* <note>
5194-
* <p>Not currently supported with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
5195-
* tasks</a>.</p>
5196-
* </note>
51975195
* @public
51985196
*/
51995197
BytesCompressed?: number | undefined;
@@ -5213,9 +5211,8 @@ export interface DescribeTaskExecutionResponse {
52135211

52145212
/**
52155213
* <p>The number of files, objects, and directories that DataSync actually deletes in
5216-
* your destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to
5217-
* delete data in the destination that isn't in the source, the value is always
5218-
* <code>0</code>.</p>
5214+
* your destination location. If you don't configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">delete data in the destination that
5215+
* isn't in the source</a>, the value is always <code>0</code>.</p>
52195216
* @public
52205217
*/
52215218
FilesDeleted?: number | undefined;
@@ -5248,9 +5245,8 @@ export interface DescribeTaskExecutionResponse {
52485245

52495246
/**
52505247
* <p>The number of files, objects, and directories that DataSync expects to delete in
5251-
* your destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to
5252-
* delete data in the destination that isn't in the source, the value is always
5253-
* <code>0</code>.</p>
5248+
* your destination location. If you don't configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">delete data in the destination that
5249+
* isn't in the source</a>, the value is always <code>0</code>.</p>
52545250
* @public
52555251
*/
52565252
EstimatedFilesToDelete?: number | undefined;
@@ -5268,7 +5264,9 @@ export interface DescribeTaskExecutionResponse {
52685264
* <p>Applies only to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Enhanced mode
52695265
* tasks</a>.</p>
52705266
* </note>
5271-
* <p>This metric isn't applicable if you configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode">transfer all data</a>. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.</p>
5267+
* <p>This counter isn't applicable if you configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode">transfer
5268+
* all data</a>. In that scenario, DataSync copies everything from the source to
5269+
* the destination without comparing differences between the locations.</p>
52725270
* @public
52735271
*/
52745272
FilesPrepared?: number | undefined;

0 commit comments

Comments
 (0)