@aws-sdk/client-datasync 3.554.0 → 3.562.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist-cjs/index.js CHANGED
@@ -119,6 +119,8 @@ __export(src_exports, {
119
119
  ReportLevel: () => ReportLevel,
120
120
  ReportOutputType: () => ReportOutputType,
121
121
  S3StorageClass: () => S3StorageClass,
122
+ ScheduleDisabledBy: () => ScheduleDisabledBy,
123
+ ScheduleStatus: () => ScheduleStatus,
122
124
  SmbSecurityDescriptorCopyFlags: () => SmbSecurityDescriptorCopyFlags,
123
125
  SmbVersion: () => SmbVersion,
124
126
  StartDiscoveryJobCommand: () => StartDiscoveryJobCommand,
@@ -505,6 +507,10 @@ var VerifyMode = {
505
507
  ONLY_FILES_TRANSFERRED: "ONLY_FILES_TRANSFERRED",
506
508
  POINT_IN_TIME_CONSISTENT: "POINT_IN_TIME_CONSISTENT"
507
509
  };
510
+ var ScheduleStatus = {
511
+ DISABLED: "DISABLED",
512
+ ENABLED: "ENABLED"
513
+ };
508
514
  var ObjectVersionIds = {
509
515
  INCLUDE: "INCLUDE",
510
516
  NONE: "NONE"
@@ -550,6 +556,10 @@ var RecommendationStatus = {
550
556
  IN_PROGRESS: "IN_PROGRESS",
551
557
  NONE: "NONE"
552
558
  };
559
+ var ScheduleDisabledBy = {
560
+ SERVICE: "SERVICE",
561
+ USER: "USER"
562
+ };
553
563
  var TaskStatus = {
554
564
  AVAILABLE: "AVAILABLE",
555
565
  CREATING: "CREATING",
@@ -2234,6 +2244,7 @@ var de_DescribeTaskResponse = /* @__PURE__ */ __name((output, context) => {
2234
2244
  Name: import_smithy_client.expectString,
2235
2245
  Options: import_smithy_client._json,
2236
2246
  Schedule: import_smithy_client._json,
2247
+ ScheduleDetails: (_) => de_TaskScheduleDetails(_, context),
2237
2248
  SourceLocationArn: import_smithy_client.expectString,
2238
2249
  SourceNetworkInterfaceArns: import_smithy_client._json,
2239
2250
  Status: import_smithy_client.expectString,
@@ -2371,6 +2382,13 @@ var de_ResourceMetrics = /* @__PURE__ */ __name((output, context) => {
2371
2382
  Timestamp: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_)))
2372
2383
  });
2373
2384
  }, "de_ResourceMetrics");
2385
+ var de_TaskScheduleDetails = /* @__PURE__ */ __name((output, context) => {
2386
+ return (0, import_smithy_client.take)(output, {
2387
+ DisabledBy: import_smithy_client.expectString,
2388
+ DisabledReason: import_smithy_client.expectString,
2389
+ StatusUpdateTime: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_)))
2390
+ });
2391
+ }, "de_TaskScheduleDetails");
2374
2392
  var de_Throughput = /* @__PURE__ */ __name((output, context) => {
2375
2393
  return (0, import_smithy_client.take)(output, {
2376
2394
  Other: import_smithy_client.limitedParseDouble,
@@ -3641,6 +3659,7 @@ var paginateListTasks = (0, import_core.createPaginator)(DataSyncClient, ListTas
3641
3659
  TransferMode,
3642
3660
  Uid,
3643
3661
  VerifyMode,
3662
+ ScheduleStatus,
3644
3663
  ObjectVersionIds,
3645
3664
  ReportOutputType,
3646
3665
  ReportLevel,
@@ -3650,6 +3669,7 @@ var paginateListTasks = (0, import_core.createPaginator)(DataSyncClient, ListTas
3650
3669
  DiscoveryResourceType,
3651
3670
  DiscoveryResourceFilter,
3652
3671
  RecommendationStatus,
3672
+ ScheduleDisabledBy,
3653
3673
  TaskStatus,
3654
3674
  PhaseStatus,
3655
3675
  TaskExecutionStatus,
@@ -164,6 +164,10 @@ export const VerifyMode = {
164
164
  ONLY_FILES_TRANSFERRED: "ONLY_FILES_TRANSFERRED",
165
165
  POINT_IN_TIME_CONSISTENT: "POINT_IN_TIME_CONSISTENT",
166
166
  };
167
+ export const ScheduleStatus = {
168
+ DISABLED: "DISABLED",
169
+ ENABLED: "ENABLED",
170
+ };
167
171
  export const ObjectVersionIds = {
168
172
  INCLUDE: "INCLUDE",
169
173
  NONE: "NONE",
@@ -209,6 +213,10 @@ export const RecommendationStatus = {
209
213
  IN_PROGRESS: "IN_PROGRESS",
210
214
  NONE: "NONE",
211
215
  };
216
+ export const ScheduleDisabledBy = {
217
+ SERVICE: "SERVICE",
218
+ USER: "USER",
219
+ };
212
220
  export const TaskStatus = {
213
221
  AVAILABLE: "AVAILABLE",
214
222
  CREATING: "CREATING",
@@ -1571,6 +1571,7 @@ const de_DescribeTaskResponse = (output, context) => {
1571
1571
  Name: __expectString,
1572
1572
  Options: _json,
1573
1573
  Schedule: _json,
1574
+ ScheduleDetails: (_) => de_TaskScheduleDetails(_, context),
1574
1575
  SourceLocationArn: __expectString,
1575
1576
  SourceNetworkInterfaceArns: _json,
1576
1577
  Status: __expectString,
@@ -1716,6 +1717,13 @@ const de_ResourceMetrics = (output, context) => {
1716
1717
  Timestamp: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1717
1718
  });
1718
1719
  };
1720
+ const de_TaskScheduleDetails = (output, context) => {
1721
+ return take(output, {
1722
+ DisabledBy: __expectString,
1723
+ DisabledReason: __expectString,
1724
+ StatusUpdateTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1725
+ });
1726
+ };
1719
1727
  const de_Throughput = (output, context) => {
1720
1728
  return take(output, {
1721
1729
  Other: __limitedParseDouble,
@@ -26,11 +26,9 @@ declare const CreateTaskCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Configures a transfer task, which defines where and how DataSync moves your
29
+ * <p>Configures a <i>task</i>, which defines where and how DataSync transfers your
30
30
  * data.</p>
31
- * <p>A task includes a source location, destination location, and the options for how and
32
- * when you want to transfer your data (such as bandwidth limits, scheduling, among other
33
- * options).</p>
31
+ * <p>A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).</p>
34
32
  * <important>
35
33
  * <p>If you're planning to transfer data to or from an Amazon S3 location, review
36
34
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how
@@ -73,6 +71,7 @@ declare const CreateTaskCommand_base: {
73
71
  * ],
74
72
  * Schedule: { // TaskSchedule
75
73
  * ScheduleExpression: "STRING_VALUE", // required
74
+ * Status: "ENABLED" || "DISABLED",
76
75
  * },
77
76
  * Tags: [ // InputTagList
78
77
  * { // TagListEntry
@@ -26,7 +26,7 @@ declare const DescribeTaskCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Provides information about an DataSync transfer task.</p>
29
+ * <p>Provides information about a <i>task</i>, which defines where and how DataSync transfers your data.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -77,6 +77,7 @@ declare const DescribeTaskCommand_base: {
77
77
  * // ],
78
78
  * // Schedule: { // TaskSchedule
79
79
  * // ScheduleExpression: "STRING_VALUE", // required
80
+ * // Status: "ENABLED" || "DISABLED",
80
81
  * // },
81
82
  * // ErrorCode: "STRING_VALUE",
82
83
  * // ErrorDetail: "STRING_VALUE",
@@ -125,6 +126,11 @@ declare const DescribeTaskCommand_base: {
125
126
  * // },
126
127
  * // },
127
128
  * // },
129
+ * // ScheduleDetails: { // TaskScheduleDetails
130
+ * // StatusUpdateTime: new Date("TIMESTAMP"),
131
+ * // DisabledReason: "STRING_VALUE",
132
+ * // DisabledBy: "USER" || "SERVICE",
133
+ * // },
128
134
  * // };
129
135
  *
130
136
  * ```
@@ -26,7 +26,7 @@ declare const UpdateTaskCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates the configuration of an DataSync transfer task.</p>
29
+ * <p>Updates the configuration of a <i>task</i>, which defines where and how DataSync transfers your data.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -60,6 +60,7 @@ declare const UpdateTaskCommand_base: {
60
60
  * ],
61
61
  * Schedule: { // TaskSchedule
62
62
  * ScheduleExpression: "STRING_VALUE", // required
63
+ * Status: "ENABLED" || "DISABLED",
63
64
  * },
64
65
  * Name: "STRING_VALUE",
65
66
  * CloudWatchLogGroupArn: "STRING_VALUE",
@@ -172,9 +172,6 @@ export declare class InvalidRequestException extends __BaseException {
172
172
  export interface Platform {
173
173
  /**
174
174
  * <p>The version of the DataSync agent.</p>
175
- * <important>
176
- * <p>On December 7, 2023, we discontinued version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, <a href="https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html">replace</a> those agents or <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deleting-agent.html">delete</a> them if they aren't in use. If you need more help, contact <a href="https://aws.amazon.com/contact-us/">Amazon Web Services Support</a>.</p>
177
- * </important>
178
175
  * @public
179
176
  */
180
177
  Version?: string;
@@ -1827,8 +1824,8 @@ export type VerifyMode = (typeof VerifyMode)[keyof typeof VerifyMode];
1827
1824
  * <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
1828
1825
  * also can specify how to verify data integrity, set bandwidth limits for your task, among other
1829
1826
  * options.</p>
1830
- * <p>Each option has a default value. Unless you need to, you don't have to configure any of
1831
- * these options before starting your task.</p>
1827
+ * <p>Each option has a default value. Unless you need to, you don't have to configure any option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
1828
+ * <p>You also can override your task options for each task execution. For example, you might want to adjust the <code>LogLevel</code> for an individual execution.</p>
1832
1829
  * @public
1833
1830
  */
1834
1831
  export interface Options {
@@ -1852,6 +1849,8 @@ export interface Options {
1852
1849
  * <code>POINT_IN_TIME_CONSISTENT</code> (default) - At the end of the transfer,
1853
1850
  * DataSync scans the entire source and destination to verify that both locations
1854
1851
  * are fully synchronized.</p>
1852
+ * <p>If you use a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">manifest</a>, DataSync only scans and
1853
+ * verifies what's listed in the manifest.</p>
1855
1854
  * <p>You can't use this option when transferring to S3 Glacier Flexible Retrieval
1856
1855
  * or S3 Glacier Deep Archive storage classes. For more information, see
1857
1856
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage
@@ -2161,18 +2160,41 @@ export interface Options {
2161
2160
  ObjectTags?: ObjectTags;
2162
2161
  }
2163
2162
  /**
2164
- * <p>Specifies the schedule you want your task to use for repeated executions. For more
2165
- * information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for
2166
- * Rules</a>.</p>
2163
+ * @public
2164
+ * @enum
2165
+ */
2166
+ export declare const ScheduleStatus: {
2167
+ readonly DISABLED: "DISABLED";
2168
+ readonly ENABLED: "ENABLED";
2169
+ };
2170
+ /**
2171
+ * @public
2172
+ */
2173
+ export type ScheduleStatus = (typeof ScheduleStatus)[keyof typeof ScheduleStatus];
2174
+ /**
2175
+ * <p>Configures your DataSync task to run on a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">schedule</a>
2176
+ * (at a minimum interval of 1 hour).</p>
2167
2177
  * @public
2168
2178
  */
2169
2179
  export interface TaskSchedule {
2170
2180
  /**
2171
- * <p>A cron expression that specifies when DataSync initiates a scheduled
2172
- * transfer from a source to a destination location. </p>
2181
+ * <p>Specifies your task schedule by using a cron expression in UTC time. For information about
2182
+ * cron expression syntax, see the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html">
2183
+ * <i>Amazon EventBridge User
2184
+ * Guide</i>
2185
+ * </a>.</p>
2173
2186
  * @public
2174
2187
  */
2175
2188
  ScheduleExpression: string | undefined;
2189
+ /**
2190
+ * <p>Specifies whether to enable or disable your task schedule. Your schedule is enabled by
2191
+ * default, but there can be situations where you need to disable it. For example,
2192
+ * you might need to pause a recurring transfer or fix an issue with your task or perform maintenance on your storage system.</p>
2193
+ * <p>DataSync might disable your schedule automatically if your task fails repeatedly
2194
+ * with the same error. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html">TaskScheduleDetails</a>.</p>
2195
+ * @public
2196
+ */
2197
+ Status?: ScheduleStatus;
2176
2198
  }
2177
2199
  /**
2178
2200
  * <p>Specifies the Amazon S3 bucket where DataSync uploads your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a>.</p>
@@ -2351,52 +2373,46 @@ export interface TaskReportConfig {
2351
2373
  */
2352
2374
  export interface CreateTaskRequest {
2353
2375
  /**
2354
- * <p>The Amazon Resource Name (ARN) of the source location for the task.</p>
2376
+ * <p>Specifies the ARN of your transfer's source location.</p>
2355
2377
  * @public
2356
2378
  */
2357
2379
  SourceLocationArn: string | undefined;
2358
2380
  /**
2359
- * <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
2360
- * </p>
2381
+ * <p>Specifies the ARN of your transfer's destination location. </p>
2361
2382
  * @public
2362
2383
  */
2363
2384
  DestinationLocationArn: string | undefined;
2364
2385
  /**
2365
- * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to
2366
- * monitor and log events in the task. </p>
2386
+ * <p>Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
2387
+ * monitoring your task.</p>
2367
2388
  * @public
2368
2389
  */
2369
2390
  CloudWatchLogGroupArn?: string;
2370
2391
  /**
2371
- * <p>The name of a task. This value is a text reference that is used to identify the task in
2372
- * the console. </p>
2392
+ * <p>Specifies the name of your task.</p>
2373
2393
  * @public
2374
2394
  */
2375
2395
  Name?: string;
2376
2396
  /**
2377
- * <p>Specifies the configuration options for a task. Some options include preserving file or
2378
- * object metadata and verifying data integrity.</p>
2379
- * <p>You can also override these options before starting an individual run of a task (also
2380
- * known as a <i>task execution</i>). For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2397
+ * <p>Specifies your task's settings, such as preserving file metadata, verifying data
2398
+ * integrity, among other options.</p>
2381
2399
  * @public
2382
2400
  */
2383
2401
  Options?: Options;
2384
2402
  /**
2385
- * <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
2386
- * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
2403
+ * <p>Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more
2404
+ * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
2387
2405
  * @public
2388
2406
  */
2389
2407
  Excludes?: FilterRule[];
2390
2408
  /**
2391
- * <p>Specifies a schedule used to periodically transfer files from a source to a destination
2392
- * location. The schedule should be specified in UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
2409
+ * <p>Specifies a schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
2393
2410
  * task</a>.</p>
2394
2411
  * @public
2395
2412
  */
2396
2413
  Schedule?: TaskSchedule;
2397
2414
  /**
2398
- * <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN)
2399
- * representing the task.</p>
2415
+ * <p>Specifies the tags that you want to apply to your task.</p>
2400
2416
  * <p>
2401
2417
  * <i>Tags</i> are key-value pairs that help you manage, filter, and search
2402
2418
  * for your DataSync resources.</p>
@@ -2404,8 +2420,8 @@ export interface CreateTaskRequest {
2404
2420
  */
2405
2421
  Tags?: TagListEntry[];
2406
2422
  /**
2407
- * <p>Specifies a list of filter rules that include specific data during your transfer. For more
2408
- * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
2423
+ * <p>Specifies include filters define the files, objects, and folders in your source location
2424
+ * that you want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
2409
2425
  * @public
2410
2426
  */
2411
2427
  Includes?: FilterRule[];
@@ -3998,11 +4014,62 @@ export interface DescribeStorageSystemResourcesResponse {
3998
4014
  */
3999
4015
  export interface DescribeTaskRequest {
4000
4016
  /**
4001
- * <p>Specifies the Amazon Resource Name (ARN) of the transfer task.</p>
4017
+ * <p>Specifies the Amazon Resource Name (ARN) of the transfer task that you want information
4018
+ * about.</p>
4002
4019
  * @public
4003
4020
  */
4004
4021
  TaskArn: string | undefined;
4005
4022
  }
4023
+ /**
4024
+ * @public
4025
+ * @enum
4026
+ */
4027
+ export declare const ScheduleDisabledBy: {
4028
+ readonly SERVICE: "SERVICE";
4029
+ readonly USER: "USER";
4030
+ };
4031
+ /**
4032
+ * @public
4033
+ */
4034
+ export type ScheduleDisabledBy = (typeof ScheduleDisabledBy)[keyof typeof ScheduleDisabledBy];
4035
+ /**
4036
+ * <p>Provides information about your DataSync
4037
+ * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">task schedule</a>.</p>
4038
+ * @public
4039
+ */
4040
+ export interface TaskScheduleDetails {
4041
+ /**
4042
+ * <p>Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see
4043
+ * when the schedule was disabled.</p>
4044
+ * @public
4045
+ */
4046
+ StatusUpdateTime?: Date;
4047
+ /**
4048
+ * <p>Provides a reason if the task schedule is disabled.</p>
4049
+ * <p>If your schedule is disabled by <code>USER</code>, you see a <code>Manually disabled by user.</code> message.</p>
4050
+ * <p>If your schedule is disabled by <code>SERVICE</code>, you see an error message to help you
4051
+ * understand why the task keeps failing. For information on resolving DataSync errors,
4052
+ * see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
4053
+ * @public
4054
+ */
4055
+ DisabledReason?: string;
4056
+ /**
4057
+ * <p>Indicates how your task schedule was disabled.</p>
4058
+ * <ul>
4059
+ * <li>
4060
+ * <p>
4061
+ * <code>USER</code> - Your schedule was manually disabled by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html">UpdateTask</a> operation or DataSync console.</p>
4062
+ * </li>
4063
+ * <li>
4064
+ * <p>
4065
+ * <code>SERVICE</code> - Your schedule was automatically disabled by DataSync
4066
+ * because the task failed repeatedly with the same error.</p>
4067
+ * </li>
4068
+ * </ul>
4069
+ * @public
4070
+ */
4071
+ DisabledBy?: ScheduleDisabledBy;
4072
+ }
4006
4073
  /**
4007
4074
  * @public
4008
4075
  * @enum
@@ -4024,91 +4091,82 @@ export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
4024
4091
  */
4025
4092
  export interface DescribeTaskResponse {
4026
4093
  /**
4027
- * <p>The Amazon Resource Name (ARN) of the task that was described.</p>
4094
+ * <p>The ARN of your task.</p>
4028
4095
  * @public
4029
4096
  */
4030
4097
  TaskArn?: string;
4031
4098
  /**
4032
- * <p>The status of the task that was described.</p>
4033
- * <p>For detailed information about task execution statuses, see Understanding
4034
- * Task Statuses in the <i>DataSync User Guide</i>.</p>
4099
+ * <p>The status of your task. For information about what each status means, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses">Task statuses</a>.</p>
4035
4100
  * @public
4036
4101
  */
4037
4102
  Status?: TaskStatus;
4038
4103
  /**
4039
- * <p>The name of the task that was described.</p>
4104
+ * <p>The name of your task.</p>
4040
4105
  * @public
4041
4106
  */
4042
4107
  Name?: string;
4043
4108
  /**
4044
- * <p>The Amazon Resource Name (ARN) of the task execution that is transferring
4045
- * files.</p>
4109
+ * <p>The ARN of the most recent task execution.</p>
4046
4110
  * @public
4047
4111
  */
4048
4112
  CurrentTaskExecutionArn?: string;
4049
4113
  /**
4050
- * <p>The Amazon Resource Name (ARN) of the source file system's location.</p>
4114
+ * <p>The ARN of your transfer's source location.</p>
4051
4115
  * @public
4052
4116
  */
4053
4117
  SourceLocationArn?: string;
4054
4118
  /**
4055
- * <p>The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's
4056
- * location.</p>
4119
+ * <p>The ARN of your transfer's destination location.</p>
4057
4120
  * @public
4058
4121
  */
4059
4122
  DestinationLocationArn?: string;
4060
4123
  /**
4061
- * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to
4062
- * monitor and log events in the task.</p>
4063
- * <p>For more information on these groups, see Working with Log Groups and Log
4064
- * Streams in the <i>Amazon CloudWatch User Guide</i>.</p>
4124
+ * <p>The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your
4125
+ * task.</p>
4126
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html">Monitoring DataSync with
4127
+ * Amazon CloudWatch</a>.</p>
4065
4128
  * @public
4066
4129
  */
4067
4130
  CloudWatchLogGroupArn?: string;
4068
4131
  /**
4069
- * <p>The Amazon Resource Names (ARNs) of the network interfaces created for your source
4070
- * location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network
4071
- * interface requirements</a>.</p>
4132
+ * <p>The ARNs of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network
4133
+ * interfaces</a> that DataSync created for your source location.</p>
4072
4134
  * @public
4073
4135
  */
4074
4136
  SourceNetworkInterfaceArns?: string[];
4075
4137
  /**
4076
- * <p>The Amazon Resource Names (ARNs) of the network interfaces created for your destination
4077
- * location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network
4078
- * interface requirements</a>.</p>
4138
+ * <p>The ARNs of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network
4139
+ * interfaces</a> that DataSync created for your destination location.</p>
4079
4140
  * @public
4080
4141
  */
4081
4142
  DestinationNetworkInterfaceArns?: string[];
4082
4143
  /**
4083
- * <p>The configuration options that control the behavior of the
4084
- * <code>StartTaskExecution</code> operation. Some options include preserving file or object
4085
- * metadata and verifying data integrity.</p>
4086
- * <p>You can override these options for each task execution. For more information, see
4087
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
4144
+ * <p>The task's settings. For example, what file metadata gets preserved, how data integrity
4145
+ * gets verified at the end of your transfer, bandwidth limits, among other options.</p>
4088
4146
  * @public
4089
4147
  */
4090
4148
  Options?: Options;
4091
4149
  /**
4092
- * <p>A list of filter rules that exclude specific data during your transfer. For more
4093
- * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
4150
+ * <p>The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more
4151
+ * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
4094
4152
  * @public
4095
4153
  */
4096
4154
  Excludes?: FilterRule[];
4097
4155
  /**
4098
- * <p>The schedule used to periodically transfer files from a source to a destination
4099
- * location.</p>
4156
+ * <p>The schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
4157
+ * task</a>.</p>
4100
4158
  * @public
4101
4159
  */
4102
4160
  Schedule?: TaskSchedule;
4103
4161
  /**
4104
- * <p>Errors that DataSync encountered during execution of the task. You can
4105
- * use this error code to help troubleshoot issues.</p>
4162
+ * <p>If there's an issue with your task, you can use the error code to help you troubleshoot
4163
+ * the problem. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
4106
4164
  * @public
4107
4165
  */
4108
4166
  ErrorCode?: string;
4109
4167
  /**
4110
- * <p>Detailed description of an error that was encountered during the task execution. You
4111
- * can use this information to help troubleshoot issues. </p>
4168
+ * <p>If there's an issue with your task, you can use the error details to help you
4169
+ * troubleshoot the problem. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
4112
4170
  * @public
4113
4171
  */
4114
4172
  ErrorDetail?: string;
@@ -4118,23 +4176,28 @@ export interface DescribeTaskResponse {
4118
4176
  */
4119
4177
  CreationTime?: Date;
4120
4178
  /**
4121
- * <p>A list of filter rules that include specific data during your transfer. For more
4122
- * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
4179
+ * <p>The include filters that define the files, objects, and folders in your source location
4180
+ * that you want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
4123
4181
  * @public
4124
4182
  */
4125
4183
  Includes?: FilterRule[];
4126
4184
  /**
4127
- * <p>The configuration of the manifest that lists the files or objects to transfer. For more
4128
- * information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">Specifying what DataSync transfers by using a manifest</a>.</p>
4185
+ * <p>The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">Specifying what DataSync transfers by using a manifest</a>.</p>
4129
4186
  * @public
4130
4187
  */
4131
4188
  ManifestConfig?: ManifestConfig;
4132
4189
  /**
4133
- * <p>The configuration of your task report, which provides detailed information about for your
4134
- * DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Creating a task report</a>.</p>
4190
+ * <p>The configuration of your task report, which provides detailed information about your
4191
+ * DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync
4192
+ * transfers with task reports</a>.</p>
4135
4193
  * @public
4136
4194
  */
4137
4195
  TaskReportConfig?: TaskReportConfig;
4196
+ /**
4197
+ * <p>The details about your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">task schedule</a>.</p>
4198
+ * @public
4199
+ */
4200
+ ScheduleDetails?: TaskScheduleDetails;
4138
4201
  }
4139
4202
  /**
4140
4203
  * <p>DescribeTaskExecutionRequest</p>
@@ -4286,8 +4349,8 @@ export interface DescribeTaskExecutionResponse {
4286
4349
  * <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
4287
4350
  * also can specify how to verify data integrity, set bandwidth limits for your task, among other
4288
4351
  * options.</p>
4289
- * <p>Each option has a default value. Unless you need to, you don't have to configure any of
4290
- * these options before starting your task.</p>
4352
+ * <p>Each option has a default value. Unless you need to, you don't have to configure any option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
4353
+ * <p>You also can override your task options for each task execution. For example, you might want to adjust the <code>LogLevel</code> for an individual execution.</p>
4291
4354
  * @public
4292
4355
  */
4293
4356
  Options?: Options;
@@ -4995,8 +5058,8 @@ export interface StartTaskExecutionRequest {
4995
5058
  * <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
4996
5059
  * also can specify how to verify data integrity, set bandwidth limits for your task, among other
4997
5060
  * options.</p>
4998
- * <p>Each option has a default value. Unless you need to, you don't have to configure any of
4999
- * these options before starting your task.</p>
5061
+ * <p>Each option has a default value. Unless you need to, you don't have to configure any option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
5062
+ * <p>You also can override your task options for each task execution. For example, you might want to adjust the <code>LogLevel</code> for an individual execution.</p>
5000
5063
  * @public
5001
5064
  */
5002
5065
  OverrideOptions?: Options;
@@ -5493,7 +5556,7 @@ export interface UpdateStorageSystemResponse {
5493
5556
  */
5494
5557
  export interface UpdateTaskRequest {
5495
5558
  /**
5496
- * <p>The Amazon Resource Name (ARN) of the resource name of the task to update.</p>
5559
+ * <p>Specifies the ARN of the task that you want to update.</p>
5497
5560
  * @public
5498
5561
  */
5499
5562
  TaskArn: string | undefined;
@@ -5501,39 +5564,37 @@ export interface UpdateTaskRequest {
5501
5564
  * <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
5502
5565
  * also can specify how to verify data integrity, set bandwidth limits for your task, among other
5503
5566
  * options.</p>
5504
- * <p>Each option has a default value. Unless you need to, you don't have to configure any of
5505
- * these options before starting your task.</p>
5567
+ * <p>Each option has a default value. Unless you need to, you don't have to configure any option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
5568
+ * <p>You also can override your task options for each task execution. For example, you might want to adjust the <code>LogLevel</code> for an individual execution.</p>
5506
5569
  * @public
5507
5570
  */
5508
5571
  Options?: Options;
5509
5572
  /**
5510
- * <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
5511
- * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
5573
+ * <p>Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more
5574
+ * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
5512
5575
  * @public
5513
5576
  */
5514
5577
  Excludes?: FilterRule[];
5515
5578
  /**
5516
- * <p>Specifies a schedule used to periodically transfer files from a source to a destination
5517
- * location. You can configure your task to execute hourly, daily, weekly or on specific days of
5518
- * the week. You control when in the day or hour you want the task to execute. The time you
5519
- * specify is UTC time. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>
5579
+ * <p>Specifies a schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your
5580
+ * task</a>.</p>
5520
5581
  * @public
5521
5582
  */
5522
5583
  Schedule?: TaskSchedule;
5523
5584
  /**
5524
- * <p>The name of the task to update.</p>
5585
+ * <p>Specifies the name of your task.</p>
5525
5586
  * @public
5526
5587
  */
5527
5588
  Name?: string;
5528
5589
  /**
5529
- * <p>The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log
5530
- * group.</p>
5590
+ * <p>Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for
5591
+ * monitoring your task.</p>
5531
5592
  * @public
5532
5593
  */
5533
5594
  CloudWatchLogGroupArn?: string;
5534
5595
  /**
5535
- * <p>Specifies a list of filter rules that include specific data during your transfer. For more
5536
- * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
5596
+ * <p>Specifies include filters define the files, objects, and folders in your source location
5597
+ * that you want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
5537
5598
  * @public
5538
5599
  */
5539
5600
  Includes?: FilterRule[];
@@ -5573,8 +5634,8 @@ export interface UpdateTaskExecutionRequest {
5573
5634
  * <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You
5574
5635
  * also can specify how to verify data integrity, set bandwidth limits for your task, among other
5575
5636
  * options.</p>
5576
- * <p>Each option has a default value. Unless you need to, you don't have to configure any of
5577
- * these options before starting your task.</p>
5637
+ * <p>Each option has a default value. Unless you need to, you don't have to configure any option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
5638
+ * <p>You also can override your task options for each task execution. For example, you might want to adjust the <code>LogLevel</code> for an individual execution.</p>
5578
5639
  * @public
5579
5640
  */
5580
5641
  Options: Options | undefined;
@@ -460,8 +460,15 @@ export interface Options {
460
460
  SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags;
461
461
  ObjectTags?: ObjectTags;
462
462
  }
463
+ export declare const ScheduleStatus: {
464
+ readonly DISABLED: "DISABLED";
465
+ readonly ENABLED: "ENABLED";
466
+ };
467
+ export type ScheduleStatus =
468
+ (typeof ScheduleStatus)[keyof typeof ScheduleStatus];
463
469
  export interface TaskSchedule {
464
470
  ScheduleExpression: string | undefined;
471
+ Status?: ScheduleStatus;
465
472
  }
466
473
  export interface ReportDestinationS3 {
467
474
  Subdirectory?: string;
@@ -877,6 +884,17 @@ export interface DescribeStorageSystemResourcesResponse {
877
884
  export interface DescribeTaskRequest {
878
885
  TaskArn: string | undefined;
879
886
  }
887
+ export declare const ScheduleDisabledBy: {
888
+ readonly SERVICE: "SERVICE";
889
+ readonly USER: "USER";
890
+ };
891
+ export type ScheduleDisabledBy =
892
+ (typeof ScheduleDisabledBy)[keyof typeof ScheduleDisabledBy];
893
+ export interface TaskScheduleDetails {
894
+ StatusUpdateTime?: Date;
895
+ DisabledReason?: string;
896
+ DisabledBy?: ScheduleDisabledBy;
897
+ }
880
898
  export declare const TaskStatus: {
881
899
  readonly AVAILABLE: "AVAILABLE";
882
900
  readonly CREATING: "CREATING";
@@ -904,6 +922,7 @@ export interface DescribeTaskResponse {
904
922
  Includes?: FilterRule[];
905
923
  ManifestConfig?: ManifestConfig;
906
924
  TaskReportConfig?: TaskReportConfig;
925
+ ScheduleDetails?: TaskScheduleDetails;
907
926
  }
908
927
  export interface DescribeTaskExecutionRequest {
909
928
  TaskExecutionArn: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-datasync",
3
3
  "description": "AWS SDK for JavaScript Datasync Client for Node.js, Browser and React Native",
4
- "version": "3.554.0",
4
+ "version": "3.562.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-datasync",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.554.0",
24
- "@aws-sdk/core": "3.554.0",
25
- "@aws-sdk/credential-provider-node": "3.554.0",
23
+ "@aws-sdk/client-sts": "3.556.0",
24
+ "@aws-sdk/core": "3.556.0",
25
+ "@aws-sdk/credential-provider-node": "3.556.0",
26
26
  "@aws-sdk/middleware-host-header": "3.535.0",
27
27
  "@aws-sdk/middleware-logger": "3.535.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.535.0",