feat(client-datasync): AWS DataSync now supports Enhanced mode tasks.…

… This task mode supports transfer of virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. This mode currently supports transfers between Amazon S3 locations.
aws · Oct 30, 2024 · c86827e · c86827e
1 parent 09bd2fa
commit c86827e
Show file tree

Hide file tree

Showing 11 changed files with 621 additions and 217 deletions.
diff --git a/clients/client-datasync/README.md b/clients/client-datasync/README.md
@@ -19,7 +19,7 @@ Guide</a>
 
 ## Installing
 
-To install the this package, simply type add or install @aws-sdk/client-datasync
+To install this package, simply type add or install @aws-sdk/client-datasync
 using your favorite package manager:
 
 - `npm install @aws-sdk/client-datasync`

diff --git a/clients/client-datasync/src/commands/CreateAgentCommand.ts b/clients/client-datasync/src/commands/CreateAgentCommand.ts
@@ -28,25 +28,10 @@ export interface CreateAgentCommandInput extends CreateAgentRequest {}
 export interface CreateAgentCommandOutput extends CreateAgentResponse, __MetadataBearer {}
 
 /**
- * <p>Activates an DataSync agent that you've deployed in your storage
- *       environment. The activation process associates the agent with your Amazon Web Services account.</p>
- *          <p>If you haven't deployed an agent yet, see the following topics to learn more:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html">Agent requirements</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html">Create an agent</a>
- *                </p>
- *             </li>
- *          </ul>
- *          <note>
- *             <p>If you're transferring between Amazon Web Services storage services, you don't need a
- *           DataSync agent. </p>
- *          </note>
+ * <p>Activates an DataSync agent that you deploy in your storage environment.
+ *       The activation process associates the agent with your Amazon Web Services account.</p>
+ *          <p>If you haven't deployed an agent yet, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html">Do I need a DataSync agent?</a>
+ *          </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-datasync/src/commands/CreateTaskCommand.ts b/clients/client-datasync/src/commands/CreateTaskCommand.ts
@@ -125,6 +125,7 @@ export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataB
  *       },
  *     },
  *   },
+ *   TaskMode: "BASIC" || "ENHANCED",
  * };
  * const command = new CreateTaskCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-datasync/src/commands/DescribeTaskCommand.ts b/clients/client-datasync/src/commands/DescribeTaskCommand.ts
@@ -133,6 +133,7 @@ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __Metad
  * //     DisabledReason: "STRING_VALUE",
  * //     DisabledBy: "USER" || "SERVICE",
  * //   },
+ * //   TaskMode: "BASIC" || "ENHANCED",
  * // };
  *
  * ```

diff --git a/clients/client-datasync/src/commands/DescribeTaskExecutionCommand.ts b/clients/client-datasync/src/commands/DescribeTaskExecutionCommand.ts
@@ -29,8 +29,13 @@ export interface DescribeTaskExecutionCommandOutput extends DescribeTaskExecutio
 
 /**
  * <p>Provides information about an execution of your DataSync task. You can
- *       use this operation to help monitor the progress of an ongoing transfer or check the results of
- *       the transfer.</p>
+ *       use this operation to help monitor the progress of an ongoing data transfer or check the
+ *       results of the transfer.</p>
+ *          <note>
+ *             <p>Some <code>DescribeTaskExecution</code> response elements are only relevant to a
+ *         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
+ *           transfer performance metrics</a>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -139,6 +144,18 @@ export interface DescribeTaskExecutionCommandOutput extends DescribeTaskExecutio
  * //     ErrorDetail: "STRING_VALUE",
  * //   },
  * //   EstimatedFilesToDelete: Number("long"),
+ * //   TaskMode: "BASIC" || "ENHANCED",
+ * //   FilesPrepared: Number("long"),
+ * //   FilesListed: { // TaskExecutionFilesListedDetail
+ * //     AtSource: Number("long"),
+ * //     AtDestinationForDelete: Number("long"),
+ * //   },
+ * //   FilesFailed: { // TaskExecutionFilesFailedDetail
+ * //     Prepare: Number("long"),
+ * //     Transfer: Number("long"),
+ * //     Verify: Number("long"),
+ * //     Delete: Number("long"),
+ * //   },
  * // };
  *
  * ```

diff --git a/clients/client-datasync/src/commands/ListTaskExecutionsCommand.ts b/clients/client-datasync/src/commands/ListTaskExecutionsCommand.ts
@@ -47,6 +47,7 @@ export interface ListTaskExecutionsCommandOutput extends ListTaskExecutionsRespo
  * //     { // TaskExecutionListEntry
  * //       TaskExecutionArn: "STRING_VALUE",
  * //       Status: "QUEUED" || "CANCELLING" || "LAUNCHING" || "PREPARING" || "TRANSFERRING" || "VERIFYING" || "SUCCESS" || "ERROR",
+ * //       TaskMode: "BASIC" || "ENHANCED",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

diff --git a/clients/client-datasync/src/commands/ListTasksCommand.ts b/clients/client-datasync/src/commands/ListTasksCommand.ts
@@ -56,6 +56,7 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
  * //       TaskArn: "STRING_VALUE",
  * //       Status: "AVAILABLE" || "CREATING" || "QUEUED" || "RUNNING" || "UNAVAILABLE",
  * //       Name: "STRING_VALUE",
+ * //       TaskMode: "BASIC" || "ENHANCED",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

diff --git a/clients/client-datasync/src/commands/StartTaskExecutionCommand.ts b/clients/client-datasync/src/commands/StartTaskExecutionCommand.ts
@@ -30,7 +30,7 @@ export interface StartTaskExecutionCommandOutput extends StartTaskExecutionRespo
 /**
  * <p>Starts an DataSync transfer task. For each task, you can only run one task
  *       execution at a time.</p>
- *          <p>There are several phases to a task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses">Task execution statuses</a>.</p>
+ *          <p>There are several steps to a task execution. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses">Task execution statuses</a>.</p>
  *          <important>
  *             <p>If you're planning to transfer data to or from an Amazon S3 location, review
  *           <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how
-Original file line number
+Diff line change
@@ Expand Up @@
      *       },
      *     },
      *   },
+     *   TaskMode: "BASIC" || "ENHANCED",
      * };
      * const command = new CreateTaskCommand(input);
      * const response = await client.send(command);
@@ Expand Down @@