feat(client-datasync): This change allows users to disable and enable…

… the schedules associated with their tasks.
aws · Apr 24, 2024 · 02eab1f · 02eab1f
1 parent 87c90f1
commit 02eab1f
Show file tree

Hide file tree

Showing 6 changed files with 308 additions and 137 deletions.
diff --git a/clients/client-datasync/src/commands/CreateTaskCommand.ts b/clients/client-datasync/src/commands/CreateTaskCommand.ts
@@ -27,11 +27,9 @@ export interface CreateTaskCommandInput extends CreateTaskRequest {}
 export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataBearer {}
 
 /**
- * <p>Configures a transfer task, which defines where and how DataSync moves your
+ * <p>Configures a <i>task</i>, which defines where and how DataSync transfers your
  *       data.</p>
- *          <p>A task includes a source location, destination location, and the options for how and
- *       when you want to transfer your data (such as bandwidth limits, scheduling, among other
- *       options).</p>
+ *          <p>A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).</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
@@ -74,6 +72,7 @@ export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataB
  *   ],
  *   Schedule: { // TaskSchedule
  *     ScheduleExpression: "STRING_VALUE", // required
+ *     Status: "ENABLED" || "DISABLED",
  *   },
  *   Tags: [ // InputTagList
  *     { // TagListEntry

diff --git a/clients/client-datasync/src/commands/DescribeTaskCommand.ts b/clients/client-datasync/src/commands/DescribeTaskCommand.ts
@@ -27,7 +27,7 @@ export interface DescribeTaskCommandInput extends DescribeTaskRequest {}
 export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __MetadataBearer {}
 
 /**
- * <p>Provides information about an DataSync transfer task.</p>
+ * <p>Provides information about a <i>task</i>, which defines where and how DataSync transfers your data.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -78,6 +78,7 @@ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __Metad
  * //   ],
  * //   Schedule: { // TaskSchedule
  * //     ScheduleExpression: "STRING_VALUE", // required
+ * //     Status: "ENABLED" || "DISABLED",
  * //   },
  * //   ErrorCode: "STRING_VALUE",
  * //   ErrorDetail: "STRING_VALUE",
@@ -126,6 +127,11 @@ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __Metad
  * //       },
  * //     },
  * //   },
+ * //   ScheduleDetails: { // TaskScheduleDetails
+ * //     StatusUpdateTime: new Date("TIMESTAMP"),
+ * //     DisabledReason: "STRING_VALUE",
+ * //     DisabledBy: "USER" || "SERVICE",
+ * //   },
  * // };
  *
  * ```

diff --git a/clients/client-datasync/src/commands/UpdateTaskCommand.ts b/clients/client-datasync/src/commands/UpdateTaskCommand.ts
@@ -27,7 +27,7 @@ export interface UpdateTaskCommandInput extends UpdateTaskRequest {}
 export interface UpdateTaskCommandOutput extends UpdateTaskResponse, __MetadataBearer {}
 
 /**
- * <p>Updates the configuration of an DataSync transfer task.</p>
+ * <p>Updates the configuration of a <i>task</i>, which defines where and how DataSync transfers your data.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -61,6 +61,7 @@ export interface UpdateTaskCommandOutput extends UpdateTaskResponse, __MetadataB
  *   ],
  *   Schedule: { // TaskSchedule
  *     ScheduleExpression: "STRING_VALUE", // required
+ *     Status: "ENABLED" || "DISABLED",
  *   },
  *   Name: "STRING_VALUE",
  *   CloudWatchLogGroupArn: "STRING_VALUE",