@aws-sdk/client-datasync 3.229.0 → 3.233.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.
@@ -6,7 +6,7 @@ exports.ruleSet = {
6
6
  parameters: {
7
7
  Region: {
8
8
  builtIn: "AWS::Region",
9
- required: false,
9
+ required: true,
10
10
  documentation: "The AWS region used to dispatch the request.",
11
11
  type: "String",
12
12
  },
@@ -56,15 +56,6 @@ exports.ruleSet = {
56
56
  },
57
57
  ],
58
58
  },
59
- {
60
- fn: "parseURL",
61
- argv: [
62
- {
63
- ref: "Endpoint",
64
- },
65
- ],
66
- assign: "url",
67
- },
68
59
  ],
69
60
  type: "tree",
70
61
  rules: [
@@ -90,6 +90,7 @@ var S3StorageClass;
90
90
  (function (S3StorageClass) {
91
91
  S3StorageClass["DEEP_ARCHIVE"] = "DEEP_ARCHIVE";
92
92
  S3StorageClass["GLACIER"] = "GLACIER";
93
+ S3StorageClass["GLACIER_INSTANT_RETRIEVAL"] = "GLACIER_INSTANT_RETRIEVAL";
93
94
  S3StorageClass["INTELLIGENT_TIERING"] = "INTELLIGENT_TIERING";
94
95
  S3StorageClass["ONEZONE_IA"] = "ONEZONE_IA";
95
96
  S3StorageClass["OUTPOSTS"] = "OUTPOSTS";
@@ -2527,6 +2527,7 @@ const serializeAws_json1_1StartTaskExecutionRequest = (input, context) => {
2527
2527
  ...(input.OverrideOptions != null && {
2528
2528
  OverrideOptions: serializeAws_json1_1Options(input.OverrideOptions, context),
2529
2529
  }),
2530
+ ...(input.Tags != null && { Tags: serializeAws_json1_1InputTagList(input.Tags, context) }),
2530
2531
  ...(input.TaskArn != null && { TaskArn: input.TaskArn }),
2531
2532
  };
2532
2533
  };
@@ -3,7 +3,7 @@ export const ruleSet = {
3
3
  parameters: {
4
4
  Region: {
5
5
  builtIn: "AWS::Region",
6
- required: false,
6
+ required: true,
7
7
  documentation: "The AWS region used to dispatch the request.",
8
8
  type: "String",
9
9
  },
@@ -53,15 +53,6 @@ export const ruleSet = {
53
53
  },
54
54
  ],
55
55
  },
56
- {
57
- fn: "parseURL",
58
- argv: [
59
- {
60
- ref: "Endpoint",
61
- },
62
- ],
63
- assign: "url",
64
- },
65
56
  ],
66
57
  type: "tree",
67
58
  rules: [
@@ -83,6 +83,7 @@ export var S3StorageClass;
83
83
  (function (S3StorageClass) {
84
84
  S3StorageClass["DEEP_ARCHIVE"] = "DEEP_ARCHIVE";
85
85
  S3StorageClass["GLACIER"] = "GLACIER";
86
+ S3StorageClass["GLACIER_INSTANT_RETRIEVAL"] = "GLACIER_INSTANT_RETRIEVAL";
86
87
  S3StorageClass["INTELLIGENT_TIERING"] = "INTELLIGENT_TIERING";
87
88
  S3StorageClass["ONEZONE_IA"] = "ONEZONE_IA";
88
89
  S3StorageClass["OUTPOSTS"] = "OUTPOSTS";
@@ -2435,6 +2435,7 @@ const serializeAws_json1_1StartTaskExecutionRequest = (input, context) => {
2435
2435
  ...(input.OverrideOptions != null && {
2436
2436
  OverrideOptions: serializeAws_json1_1Options(input.OverrideOptions, context),
2437
2437
  }),
2438
+ ...(input.Tags != null && { Tags: serializeAws_json1_1InputTagList(input.Tags, context) }),
2438
2439
  ...(input.TaskArn != null && { TaskArn: input.TaskArn }),
2439
2440
  };
2440
2441
  };
@@ -46,13 +46,12 @@ import { UpdateTaskExecutionCommandInput, UpdateTaskExecutionCommandOutput } fro
46
46
  import { DataSyncClient } from "./DataSyncClient";
47
47
  /**
48
48
  * <fullname>DataSync</fullname>
49
- *
50
49
  * <p>DataSync is a managed data transfer service that makes it simpler for you
51
50
  * to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p>
52
51
  * <p>This API interface reference includes documentation for using DataSync
53
52
  * programmatically. For complete information, see the <i>
54
53
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
55
- * Guide</a>
54
+ * Guide</a>
56
55
  * </i>.</p>
57
56
  */
58
57
  export declare class DataSync extends DataSyncClient {
@@ -79,8 +78,6 @@ export declare class DataSync extends DataSyncClient {
79
78
  * <p>You can use an agent for more than one location. If a task uses multiple agents, all of
80
79
  * them need to have status AVAILABLE for the task to run. If you use multiple agents for a
81
80
  * source location, the status of all the agents must be AVAILABLE for the task to run. </p>
82
- *
83
- *
84
81
  * <p>Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that
85
82
  * ensures minimal interruption to your tasks.</p>
86
83
  */
@@ -145,8 +142,6 @@ export declare class DataSync extends DataSyncClient {
145
142
  createLocationObjectStorage(args: CreateLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationObjectStorageCommandOutput) => void): void;
146
143
  /**
147
144
  * <p>Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.</p>
148
- *
149
- *
150
145
  * <p>For
151
146
  * more information, see
152
147
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli">Create an Amazon S3 location</a>
@@ -168,22 +163,6 @@ export declare class DataSync extends DataSyncClient {
168
163
  * <p>A task includes a source location, a destination location, and the preferences for how and
169
164
  * when you want to transfer your data (such as bandwidth limits, scheduling, among other
170
165
  * options).</p>
171
- * <p>When you create a task that transfers data between Amazon Web Services services in
172
- * different Amazon Web Services Regions, one of your locations must reside in the Region where
173
- * you're using DataSync.</p>
174
- * <p>For more information, see the following topics:</p>
175
- * <ul>
176
- * <li>
177
- * <p>
178
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html">Working with DataSync locations</a>
179
- * </p>
180
- * </li>
181
- * <li>
182
- * <p>
183
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html">Configure DataSync task settings</a>
184
- * </p>
185
- * </li>
186
- * </ul>
187
166
  */
188
167
  createTask(args: CreateTaskCommandInput, options?: __HttpHandlerOptions): Promise<CreateTaskCommandOutput>;
189
168
  createTask(args: CreateTaskCommandInput, cb: (err: any, data?: CreateTaskCommandOutput) => void): void;
@@ -204,7 +183,7 @@ export declare class DataSync extends DataSyncClient {
204
183
  deleteLocation(args: DeleteLocationCommandInput, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void;
205
184
  deleteLocation(args: DeleteLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void;
206
185
  /**
207
- * <p>Deletes a task.</p>
186
+ * <p>Deletes an DataSync task.</p>
208
187
  */
209
188
  deleteTask(args: DeleteTaskCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTaskCommandOutput>;
210
189
  deleteTask(args: DeleteTaskCommandInput, cb: (err: any, data?: DeleteTaskCommandOutput) => void): void;
@@ -322,7 +301,7 @@ export declare class DataSync extends DataSyncClient {
322
301
  listLocations(args: ListLocationsCommandInput, cb: (err: any, data?: ListLocationsCommandOutput) => void): void;
323
302
  listLocations(args: ListLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocationsCommandOutput) => void): void;
324
303
  /**
325
- * <p>Returns all the tags associated with a specified resource. </p>
304
+ * <p>Returns all the tags associated with an Amazon Web Services resource.</p>
326
305
  */
327
306
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
328
307
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
@@ -340,27 +319,22 @@ export declare class DataSync extends DataSyncClient {
340
319
  listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void;
341
320
  listTasks(args: ListTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTasksCommandOutput) => void): void;
342
321
  /**
343
- * <p>Starts a specific invocation of a task. A <code>TaskExecution</code> value represents
344
- * an individual run of a task. Each task can have at most one <code>TaskExecution</code> at a
345
- * time.</p>
346
- * <p>
347
- * <code>TaskExecution</code> has the following transition phases: INITIALIZING |
348
- * PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. </p>
349
- *
350
- * <p>For detailed information, see the Task Execution section in the Components and
351
- * Terminology topic in the <i>DataSync User Guide</i>.</p>
322
+ * <p>Starts an DataSync task. For each task, you can only run one task execution at a time.</p>
323
+ * <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>
352
324
  */
353
325
  startTaskExecution(args: StartTaskExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartTaskExecutionCommandOutput>;
354
326
  startTaskExecution(args: StartTaskExecutionCommandInput, cb: (err: any, data?: StartTaskExecutionCommandOutput) => void): void;
355
327
  startTaskExecution(args: StartTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTaskExecutionCommandOutput) => void): void;
356
328
  /**
357
- * <p>Applies a key-value pair to an Amazon Web Services resource.</p>
329
+ * <p>Applies a <i>tag</i> to an Amazon Web Services
330
+ * resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.</p>
331
+ * <p>These include DataSync resources, such as locations, tasks, and task executions.</p>
358
332
  */
359
333
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
360
334
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
361
335
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
362
336
  /**
363
- * <p>Removes a tag from an Amazon Web Services resource.</p>
337
+ * <p>Removes tags from an Amazon Web Services resource.</p>
364
338
  */
365
339
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
366
340
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
@@ -412,7 +386,6 @@ export declare class DataSync extends DataSyncClient {
412
386
  * <p>Updates execution of a task.</p>
413
387
  * <p>You can modify bandwidth throttling for a task execution that is running or queued.
414
388
  * For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling">Adjusting Bandwidth Throttling for a Task Execution</a>.</p>
415
- *
416
389
  * <note>
417
390
  * <p>The only <code>Option</code> that can be modified by <code>UpdateTaskExecution</code>
418
391
  * is <code>
@@ -168,13 +168,12 @@ export interface DataSyncClientResolvedConfig extends DataSyncClientResolvedConf
168
168
  }
169
169
  /**
170
170
  * <fullname>DataSync</fullname>
171
- *
172
171
  * <p>DataSync is a managed data transfer service that makes it simpler for you
173
172
  * to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.</p>
174
173
  * <p>This API interface reference includes documentation for using DataSync
175
174
  * programmatically. For complete information, see the <i>
176
175
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
177
- * Guide</a>
176
+ * Guide</a>
178
177
  * </i>.</p>
179
178
  */
180
179
  export declare class DataSyncClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DataSyncClientResolvedConfig> {
@@ -18,8 +18,6 @@ export interface CreateAgentCommandOutput extends CreateAgentResponse, __Metadat
18
18
  * <p>You can use an agent for more than one location. If a task uses multiple agents, all of
19
19
  * them need to have status AVAILABLE for the task to run. If you use multiple agents for a
20
20
  * source location, the status of all the agents must be AVAILABLE for the task to run. </p>
21
- *
22
- *
23
21
  * <p>Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that
24
22
  * ensures minimal interruption to your tasks.</p>
25
23
  * @example
@@ -9,8 +9,6 @@ export interface CreateLocationS3CommandOutput extends CreateLocationS3Response,
9
9
  }
10
10
  /**
11
11
  * <p>Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.</p>
12
- *
13
- *
14
12
  * <p>For
15
13
  * more information, see
16
14
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli">Create an Amazon S3 location</a>
@@ -13,22 +13,6 @@ export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataB
13
13
  * <p>A task includes a source location, a destination location, and the preferences for how and
14
14
  * when you want to transfer your data (such as bandwidth limits, scheduling, among other
15
15
  * options).</p>
16
- * <p>When you create a task that transfers data between Amazon Web Services services in
17
- * different Amazon Web Services Regions, one of your locations must reside in the Region where
18
- * you're using DataSync.</p>
19
- * <p>For more information, see the following topics:</p>
20
- * <ul>
21
- * <li>
22
- * <p>
23
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html">Working with DataSync locations</a>
24
- * </p>
25
- * </li>
26
- * <li>
27
- * <p>
28
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html">Configure DataSync task settings</a>
29
- * </p>
30
- * </li>
31
- * </ul>
32
16
  * @example
33
17
  * Use a bare-bones client and the command you need to make an API call.
34
18
  * ```javascript
@@ -8,7 +8,7 @@ export interface DeleteTaskCommandInput extends DeleteTaskRequest {
8
8
  export interface DeleteTaskCommandOutput extends DeleteTaskResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a task.</p>
11
+ * <p>Deletes an DataSync task.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -8,7 +8,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
8
8
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Returns all the tags associated with a specified resource. </p>
11
+ * <p>Returns all the tags associated with an Amazon Web Services resource.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -8,15 +8,8 @@ export interface StartTaskExecutionCommandInput extends StartTaskExecutionReques
8
8
  export interface StartTaskExecutionCommandOutput extends StartTaskExecutionResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Starts a specific invocation of a task. A <code>TaskExecution</code> value represents
12
- * an individual run of a task. Each task can have at most one <code>TaskExecution</code> at a
13
- * time.</p>
14
- * <p>
15
- * <code>TaskExecution</code> has the following transition phases: INITIALIZING |
16
- * PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. </p>
17
- *
18
- * <p>For detailed information, see the Task Execution section in the Components and
19
- * Terminology topic in the <i>DataSync User Guide</i>.</p>
11
+ * <p>Starts an DataSync task. For each task, you can only run one task execution at a time.</p>
12
+ * <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>
20
13
  * @example
21
14
  * Use a bare-bones client and the command you need to make an API call.
22
15
  * ```javascript
@@ -8,7 +8,9 @@ export interface TagResourceCommandInput extends TagResourceRequest {
8
8
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Applies a key-value pair to an Amazon Web Services resource.</p>
11
+ * <p>Applies a <i>tag</i> to an Amazon Web Services
12
+ * resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.</p>
13
+ * <p>These include DataSync resources, such as locations, tasks, and task executions.</p>
12
14
  * @example
13
15
  * Use a bare-bones client and the command you need to make an API call.
14
16
  * ```javascript
@@ -8,7 +8,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
8
8
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Removes a tag from an Amazon Web Services resource.</p>
11
+ * <p>Removes tags from an Amazon Web Services resource.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -11,7 +11,6 @@ export interface UpdateTaskExecutionCommandOutput extends UpdateTaskExecutionRes
11
11
  * <p>Updates execution of a task.</p>
12
12
  * <p>You can modify bandwidth throttling for a task execution that is running or queued.
13
13
  * For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling">Adjusting Bandwidth Throttling for a Task Execution</a>.</p>
14
- *
15
14
  * <note>
16
15
  * <p>The only <code>Option</code> that can be modified by <code>UpdateTaskExecution</code>
17
16
  * is <code>
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;