@aws-sdk/client-datasync 3.315.0 → 3.319.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.
@@ -44,398 +44,282 @@ import { UpdateLocationSmbCommandInput, UpdateLocationSmbCommandOutput } from ".
44
44
  import { UpdateTaskCommandInput, UpdateTaskCommandOutput } from "./commands/UpdateTaskCommand";
45
45
  import { UpdateTaskExecutionCommandInput, UpdateTaskExecutionCommandOutput } from "./commands/UpdateTaskExecutionCommand";
46
46
  import { DataSyncClient } from "./DataSyncClient";
47
- /**
48
- * @public
49
- * <fullname>DataSync</fullname>
50
- * <p>DataSync is a managed data transfer service that makes it simpler for you
51
- * 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
- * <p>This API interface reference includes documentation for using DataSync
53
- * programmatically. For complete information, see the <i>
54
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
55
- * Guide</a>
56
- * </i>.</p>
57
- */
58
- export declare class DataSync extends DataSyncClient {
47
+ export interface DataSync {
59
48
  /**
60
- * @public
61
- * <p>Stops an DataSync task execution that's in progress. The transfer of some
62
- * files are abruptly interrupted. File contents that're transferred to the destination might be
63
- * incomplete or inconsistent with the source files.</p>
64
- * <p>However, if you start a new task execution using the same task and allow it to finish,
65
- * file content on the destination will be complete and consistent. This applies to other
66
- * unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task
67
- * execution.</p>
49
+ * @see {@link CancelTaskExecutionCommand}
68
50
  */
69
51
  cancelTaskExecution(args: CancelTaskExecutionCommandInput, options?: __HttpHandlerOptions): Promise<CancelTaskExecutionCommandOutput>;
70
52
  cancelTaskExecution(args: CancelTaskExecutionCommandInput, cb: (err: any, data?: CancelTaskExecutionCommandOutput) => void): void;
71
53
  cancelTaskExecution(args: CancelTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelTaskExecutionCommandOutput) => void): void;
72
54
  /**
73
- * @public
74
- * <p>Activates an DataSync agent that you have deployed in your storage
75
- * environment. The activation process associates your agent with your account. In the activation
76
- * process, you specify information such as the Amazon Web Services Region that you want to
77
- * activate the agent in. You activate the agent in the Amazon Web Services Region where your
78
- * target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.</p>
79
- * <p>You can activate the agent in a VPC (virtual private cloud) or provide the agent access to
80
- * a VPC endpoint so you can run tasks without going over the public internet.</p>
81
- * <p>You can use an agent for more than one location. If a task uses multiple agents, all of
82
- * them need to have status AVAILABLE for the task to run. If you use multiple agents for a
83
- * source location, the status of all the agents must be AVAILABLE for the task to run. </p>
84
- * <p>Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that
85
- * ensures minimal interruption to your tasks.</p>
55
+ * @see {@link CreateAgentCommand}
86
56
  */
87
57
  createAgent(args: CreateAgentCommandInput, options?: __HttpHandlerOptions): Promise<CreateAgentCommandOutput>;
88
58
  createAgent(args: CreateAgentCommandInput, cb: (err: any, data?: CreateAgentCommandOutput) => void): void;
89
59
  createAgent(args: CreateAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAgentCommandOutput) => void): void;
90
60
  /**
91
- * @public
92
- * <p>Creates an endpoint for an Amazon EFS file system that DataSync
93
- * can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html">Creating a location for Amazon EFS</a>.</p>
61
+ * @see {@link CreateLocationEfsCommand}
94
62
  */
95
63
  createLocationEfs(args: CreateLocationEfsCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationEfsCommandOutput>;
96
64
  createLocationEfs(args: CreateLocationEfsCommandInput, cb: (err: any, data?: CreateLocationEfsCommandOutput) => void): void;
97
65
  createLocationEfs(args: CreateLocationEfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationEfsCommandOutput) => void): void;
98
66
  /**
99
- * @public
100
- * <p>Creates an endpoint for an Amazon FSx for Lustre file system.</p>
67
+ * @see {@link CreateLocationFsxLustreCommand}
101
68
  */
102
69
  createLocationFsxLustre(args: CreateLocationFsxLustreCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationFsxLustreCommandOutput>;
103
70
  createLocationFsxLustre(args: CreateLocationFsxLustreCommandInput, cb: (err: any, data?: CreateLocationFsxLustreCommandOutput) => void): void;
104
71
  createLocationFsxLustre(args: CreateLocationFsxLustreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxLustreCommandOutput) => void): void;
105
72
  /**
106
- * @public
107
- * <p>Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync
108
- * can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html">Creating a location for FSx for ONTAP</a>.</p>
73
+ * @see {@link CreateLocationFsxOntapCommand}
109
74
  */
110
75
  createLocationFsxOntap(args: CreateLocationFsxOntapCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationFsxOntapCommandOutput>;
111
76
  createLocationFsxOntap(args: CreateLocationFsxOntapCommandInput, cb: (err: any, data?: CreateLocationFsxOntapCommandOutput) => void): void;
112
77
  createLocationFsxOntap(args: CreateLocationFsxOntapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxOntapCommandOutput) => void): void;
113
78
  /**
114
- * @public
115
- * <p>Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync
116
- * can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html">Creating a location for FSx for OpenZFS</a>.</p>
117
- * <note>
118
- * <p>Request parameters related to <code>SMB</code> aren't supported with the
119
- * <code>CreateLocationFsxOpenZfs</code> operation.</p>
120
- * </note>
79
+ * @see {@link CreateLocationFsxOpenZfsCommand}
121
80
  */
122
81
  createLocationFsxOpenZfs(args: CreateLocationFsxOpenZfsCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationFsxOpenZfsCommandOutput>;
123
82
  createLocationFsxOpenZfs(args: CreateLocationFsxOpenZfsCommandInput, cb: (err: any, data?: CreateLocationFsxOpenZfsCommandOutput) => void): void;
124
83
  createLocationFsxOpenZfs(args: CreateLocationFsxOpenZfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxOpenZfsCommandOutput) => void): void;
125
84
  /**
126
- * @public
127
- * <p>Creates an endpoint for an Amazon FSx for Windows File Server file system.</p>
85
+ * @see {@link CreateLocationFsxWindowsCommand}
128
86
  */
129
87
  createLocationFsxWindows(args: CreateLocationFsxWindowsCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationFsxWindowsCommandOutput>;
130
88
  createLocationFsxWindows(args: CreateLocationFsxWindowsCommandInput, cb: (err: any, data?: CreateLocationFsxWindowsCommandOutput) => void): void;
131
89
  createLocationFsxWindows(args: CreateLocationFsxWindowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationFsxWindowsCommandOutput) => void): void;
132
90
  /**
133
- * @public
134
- * <p>Creates an endpoint for a Hadoop Distributed File System (HDFS). </p>
91
+ * @see {@link CreateLocationHdfsCommand}
135
92
  */
136
93
  createLocationHdfs(args: CreateLocationHdfsCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationHdfsCommandOutput>;
137
94
  createLocationHdfs(args: CreateLocationHdfsCommandInput, cb: (err: any, data?: CreateLocationHdfsCommandOutput) => void): void;
138
95
  createLocationHdfs(args: CreateLocationHdfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationHdfsCommandOutput) => void): void;
139
96
  /**
140
- * @public
141
- * <p>Defines a file system on a Network File System (NFS) server that can be read from or
142
- * written to.</p>
97
+ * @see {@link CreateLocationNfsCommand}
143
98
  */
144
99
  createLocationNfs(args: CreateLocationNfsCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationNfsCommandOutput>;
145
100
  createLocationNfs(args: CreateLocationNfsCommandInput, cb: (err: any, data?: CreateLocationNfsCommandOutput) => void): void;
146
101
  createLocationNfs(args: CreateLocationNfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationNfsCommandOutput) => void): void;
147
102
  /**
148
- * @public
149
- * <p>Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object storage</a>.</p>
103
+ * @see {@link CreateLocationObjectStorageCommand}
150
104
  */
151
105
  createLocationObjectStorage(args: CreateLocationObjectStorageCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationObjectStorageCommandOutput>;
152
106
  createLocationObjectStorage(args: CreateLocationObjectStorageCommandInput, cb: (err: any, data?: CreateLocationObjectStorageCommandOutput) => void): void;
153
107
  createLocationObjectStorage(args: CreateLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationObjectStorageCommandOutput) => void): void;
154
108
  /**
155
- * @public
156
- * <p>Creates an endpoint for an Amazon S3 bucket that DataSync can
157
- * access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli">Create an Amazon S3 location</a>.</p>
109
+ * @see {@link CreateLocationS3Command}
158
110
  */
159
111
  createLocationS3(args: CreateLocationS3CommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationS3CommandOutput>;
160
112
  createLocationS3(args: CreateLocationS3CommandInput, cb: (err: any, data?: CreateLocationS3CommandOutput) => void): void;
161
113
  createLocationS3(args: CreateLocationS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationS3CommandOutput) => void): void;
162
114
  /**
163
- * @public
164
- * <p>Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">Creating an SMB location</a>.</p>
115
+ * @see {@link CreateLocationSmbCommand}
165
116
  */
166
117
  createLocationSmb(args: CreateLocationSmbCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationSmbCommandOutput>;
167
118
  createLocationSmb(args: CreateLocationSmbCommandInput, cb: (err: any, data?: CreateLocationSmbCommandOutput) => void): void;
168
119
  createLocationSmb(args: CreateLocationSmbCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationSmbCommandOutput) => void): void;
169
120
  /**
170
- * @public
171
- * <p>Configures a task, which defines where and how DataSync transfers your
172
- * data.</p>
173
- * <p>A task includes a source location, a destination location, and the preferences for how and
174
- * when you want to transfer your data (such as bandwidth limits, scheduling, among other
175
- * options).</p>
121
+ * @see {@link CreateTaskCommand}
176
122
  */
177
123
  createTask(args: CreateTaskCommandInput, options?: __HttpHandlerOptions): Promise<CreateTaskCommandOutput>;
178
124
  createTask(args: CreateTaskCommandInput, cb: (err: any, data?: CreateTaskCommandOutput) => void): void;
179
125
  createTask(args: CreateTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTaskCommandOutput) => void): void;
180
126
  /**
181
- * @public
182
- * <p>Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN)
183
- * of the agent in your request. The operation disassociates the agent from your Amazon Web Services account.
184
- * However, it doesn't delete the agent virtual machine (VM) from your on-premises
185
- * environment.</p>
127
+ * @see {@link DeleteAgentCommand}
186
128
  */
187
129
  deleteAgent(args: DeleteAgentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAgentCommandOutput>;
188
130
  deleteAgent(args: DeleteAgentCommandInput, cb: (err: any, data?: DeleteAgentCommandOutput) => void): void;
189
131
  deleteAgent(args: DeleteAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAgentCommandOutput) => void): void;
190
132
  /**
191
- * @public
192
- * <p>Deletes the configuration of a location used by DataSync. </p>
133
+ * @see {@link DeleteLocationCommand}
193
134
  */
194
135
  deleteLocation(args: DeleteLocationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLocationCommandOutput>;
195
136
  deleteLocation(args: DeleteLocationCommandInput, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void;
196
137
  deleteLocation(args: DeleteLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void;
197
138
  /**
198
- * @public
199
- * <p>Deletes an DataSync task.</p>
139
+ * @see {@link DeleteTaskCommand}
200
140
  */
201
141
  deleteTask(args: DeleteTaskCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTaskCommandOutput>;
202
142
  deleteTask(args: DeleteTaskCommandInput, cb: (err: any, data?: DeleteTaskCommandOutput) => void): void;
203
143
  deleteTask(args: DeleteTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTaskCommandOutput) => void): void;
204
144
  /**
205
- * @public
206
- * <p>Returns metadata about an DataSync agent, such as its name, endpoint type, and status.</p>
145
+ * @see {@link DescribeAgentCommand}
207
146
  */
208
147
  describeAgent(args: DescribeAgentCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAgentCommandOutput>;
209
148
  describeAgent(args: DescribeAgentCommandInput, cb: (err: any, data?: DescribeAgentCommandOutput) => void): void;
210
149
  describeAgent(args: DescribeAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAgentCommandOutput) => void): void;
211
150
  /**
212
- * @public
213
- * <p>Returns metadata about your DataSync location for an Amazon EFS file system.</p>
151
+ * @see {@link DescribeLocationEfsCommand}
214
152
  */
215
153
  describeLocationEfs(args: DescribeLocationEfsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationEfsCommandOutput>;
216
154
  describeLocationEfs(args: DescribeLocationEfsCommandInput, cb: (err: any, data?: DescribeLocationEfsCommandOutput) => void): void;
217
155
  describeLocationEfs(args: DescribeLocationEfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationEfsCommandOutput) => void): void;
218
156
  /**
219
- * @public
220
- * <p>Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.</p>
157
+ * @see {@link DescribeLocationFsxLustreCommand}
221
158
  */
222
159
  describeLocationFsxLustre(args: DescribeLocationFsxLustreCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationFsxLustreCommandOutput>;
223
160
  describeLocationFsxLustre(args: DescribeLocationFsxLustreCommandInput, cb: (err: any, data?: DescribeLocationFsxLustreCommandOutput) => void): void;
224
161
  describeLocationFsxLustre(args: DescribeLocationFsxLustreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxLustreCommandOutput) => void): void;
225
162
  /**
226
- * @public
227
- * <p>Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.</p>
228
- * <note>
229
- * <p>If your location uses SMB, the <code>DescribeLocationFsxOntap</code> operation doesn't
230
- * actually return a <code>Password</code>.</p>
231
- * </note>
163
+ * @see {@link DescribeLocationFsxOntapCommand}
232
164
  */
233
165
  describeLocationFsxOntap(args: DescribeLocationFsxOntapCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationFsxOntapCommandOutput>;
234
166
  describeLocationFsxOntap(args: DescribeLocationFsxOntapCommandInput, cb: (err: any, data?: DescribeLocationFsxOntapCommandOutput) => void): void;
235
167
  describeLocationFsxOntap(args: DescribeLocationFsxOntapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxOntapCommandOutput) => void): void;
236
168
  /**
237
- * @public
238
- * <p>Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.</p>
239
- * <note>
240
- * <p>Response elements related to <code>SMB</code> aren't supported with the
241
- * <code>DescribeLocationFsxOpenZfs</code> operation.</p>
242
- * </note>
169
+ * @see {@link DescribeLocationFsxOpenZfsCommand}
243
170
  */
244
171
  describeLocationFsxOpenZfs(args: DescribeLocationFsxOpenZfsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationFsxOpenZfsCommandOutput>;
245
172
  describeLocationFsxOpenZfs(args: DescribeLocationFsxOpenZfsCommandInput, cb: (err: any, data?: DescribeLocationFsxOpenZfsCommandOutput) => void): void;
246
173
  describeLocationFsxOpenZfs(args: DescribeLocationFsxOpenZfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxOpenZfsCommandOutput) => void): void;
247
174
  /**
248
- * @public
249
- * <p>Returns metadata about an Amazon FSx for Windows File Server
250
- * location, such as information about its path.</p>
175
+ * @see {@link DescribeLocationFsxWindowsCommand}
251
176
  */
252
177
  describeLocationFsxWindows(args: DescribeLocationFsxWindowsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationFsxWindowsCommandOutput>;
253
178
  describeLocationFsxWindows(args: DescribeLocationFsxWindowsCommandInput, cb: (err: any, data?: DescribeLocationFsxWindowsCommandOutput) => void): void;
254
179
  describeLocationFsxWindows(args: DescribeLocationFsxWindowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationFsxWindowsCommandOutput) => void): void;
255
180
  /**
256
- * @public
257
- * <p>Returns metadata, such as the authentication information about the Hadoop Distributed File
258
- * System (HDFS) location. </p>
181
+ * @see {@link DescribeLocationHdfsCommand}
259
182
  */
260
183
  describeLocationHdfs(args: DescribeLocationHdfsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationHdfsCommandOutput>;
261
184
  describeLocationHdfs(args: DescribeLocationHdfsCommandInput, cb: (err: any, data?: DescribeLocationHdfsCommandOutput) => void): void;
262
185
  describeLocationHdfs(args: DescribeLocationHdfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationHdfsCommandOutput) => void): void;
263
186
  /**
264
- * @public
265
- * <p>Returns metadata, such as the path information, about an NFS location.</p>
187
+ * @see {@link DescribeLocationNfsCommand}
266
188
  */
267
189
  describeLocationNfs(args: DescribeLocationNfsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationNfsCommandOutput>;
268
190
  describeLocationNfs(args: DescribeLocationNfsCommandInput, cb: (err: any, data?: DescribeLocationNfsCommandOutput) => void): void;
269
191
  describeLocationNfs(args: DescribeLocationNfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationNfsCommandOutput) => void): void;
270
192
  /**
271
- * @public
272
- * <p>Returns metadata about your DataSync location for an object storage system.</p>
193
+ * @see {@link DescribeLocationObjectStorageCommand}
273
194
  */
274
195
  describeLocationObjectStorage(args: DescribeLocationObjectStorageCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationObjectStorageCommandOutput>;
275
196
  describeLocationObjectStorage(args: DescribeLocationObjectStorageCommandInput, cb: (err: any, data?: DescribeLocationObjectStorageCommandOutput) => void): void;
276
197
  describeLocationObjectStorage(args: DescribeLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationObjectStorageCommandOutput) => void): void;
277
198
  /**
278
- * @public
279
- * <p>Returns metadata, such as bucket name, about an Amazon S3 bucket location.</p>
199
+ * @see {@link DescribeLocationS3Command}
280
200
  */
281
201
  describeLocationS3(args: DescribeLocationS3CommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationS3CommandOutput>;
282
202
  describeLocationS3(args: DescribeLocationS3CommandInput, cb: (err: any, data?: DescribeLocationS3CommandOutput) => void): void;
283
203
  describeLocationS3(args: DescribeLocationS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationS3CommandOutput) => void): void;
284
204
  /**
285
- * @public
286
- * <p>Returns metadata, such as the path and user information about an SMB location.</p>
205
+ * @see {@link DescribeLocationSmbCommand}
287
206
  */
288
207
  describeLocationSmb(args: DescribeLocationSmbCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLocationSmbCommandOutput>;
289
208
  describeLocationSmb(args: DescribeLocationSmbCommandInput, cb: (err: any, data?: DescribeLocationSmbCommandOutput) => void): void;
290
209
  describeLocationSmb(args: DescribeLocationSmbCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLocationSmbCommandOutput) => void): void;
291
210
  /**
292
- * @public
293
- * <p>Returns metadata about a task.</p>
211
+ * @see {@link DescribeTaskCommand}
294
212
  */
295
213
  describeTask(args: DescribeTaskCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTaskCommandOutput>;
296
214
  describeTask(args: DescribeTaskCommandInput, cb: (err: any, data?: DescribeTaskCommandOutput) => void): void;
297
215
  describeTask(args: DescribeTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskCommandOutput) => void): void;
298
216
  /**
299
- * @public
300
- * <p>Returns detailed metadata about a task that is being executed.</p>
217
+ * @see {@link DescribeTaskExecutionCommand}
301
218
  */
302
219
  describeTaskExecution(args: DescribeTaskExecutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTaskExecutionCommandOutput>;
303
220
  describeTaskExecution(args: DescribeTaskExecutionCommandInput, cb: (err: any, data?: DescribeTaskExecutionCommandOutput) => void): void;
304
221
  describeTaskExecution(args: DescribeTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTaskExecutionCommandOutput) => void): void;
305
222
  /**
306
- * @public
307
- * <p>Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.</p>
308
- * <p>With pagination, you can reduce the number of agents returned in a response. If you get
309
- * a truncated list of agents in a response, the response contains a marker that you can specify
310
- * in your next request to fetch the next page of agents.</p>
311
- * <p>
312
- * <code>ListAgents</code> is eventually consistent. This means the result of running the
313
- * operation might not reflect that you just created or deleted an agent. For example, if you
314
- * create an agent with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html">CreateAgent</a> and then
315
- * immediately run <code>ListAgents</code>, that agent might not show up in the list right away.
316
- * In situations like this, you can always confirm whether an agent has been created (or deleted)
317
- * by using <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html">DescribeAgent</a>.</p>
223
+ * @see {@link ListAgentsCommand}
318
224
  */
319
225
  listAgents(args: ListAgentsCommandInput, options?: __HttpHandlerOptions): Promise<ListAgentsCommandOutput>;
320
226
  listAgents(args: ListAgentsCommandInput, cb: (err: any, data?: ListAgentsCommandOutput) => void): void;
321
227
  listAgents(args: ListAgentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAgentsCommandOutput) => void): void;
322
228
  /**
323
- * @public
324
- * <p>Returns a list of source and destination locations.</p>
325
- * <p>If you have more locations than are returned in a response (that is, the response
326
- * returns only a truncated list of your agents), the response contains a token that you can
327
- * specify in your next request to fetch the next page of locations.</p>
229
+ * @see {@link ListLocationsCommand}
328
230
  */
329
231
  listLocations(args: ListLocationsCommandInput, options?: __HttpHandlerOptions): Promise<ListLocationsCommandOutput>;
330
232
  listLocations(args: ListLocationsCommandInput, cb: (err: any, data?: ListLocationsCommandOutput) => void): void;
331
233
  listLocations(args: ListLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocationsCommandOutput) => void): void;
332
234
  /**
333
- * @public
334
- * <p>Returns all the tags associated with an Amazon Web Services resource.</p>
235
+ * @see {@link ListTagsForResourceCommand}
335
236
  */
336
237
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
337
238
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
338
239
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
339
240
  /**
340
- * @public
341
- * <p>Returns a list of executed tasks.</p>
241
+ * @see {@link ListTaskExecutionsCommand}
342
242
  */
343
243
  listTaskExecutions(args: ListTaskExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListTaskExecutionsCommandOutput>;
344
244
  listTaskExecutions(args: ListTaskExecutionsCommandInput, cb: (err: any, data?: ListTaskExecutionsCommandOutput) => void): void;
345
245
  listTaskExecutions(args: ListTaskExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTaskExecutionsCommandOutput) => void): void;
346
246
  /**
347
- * @public
348
- * <p>Returns a list of the DataSync tasks you created.</p>
247
+ * @see {@link ListTasksCommand}
349
248
  */
350
249
  listTasks(args: ListTasksCommandInput, options?: __HttpHandlerOptions): Promise<ListTasksCommandOutput>;
351
250
  listTasks(args: ListTasksCommandInput, cb: (err: any, data?: ListTasksCommandOutput) => void): void;
352
251
  listTasks(args: ListTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTasksCommandOutput) => void): void;
353
252
  /**
354
- * @public
355
- * <p>Starts an DataSync task. For each task, you can only run one task execution at a time.</p>
356
- * <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>
253
+ * @see {@link StartTaskExecutionCommand}
357
254
  */
358
255
  startTaskExecution(args: StartTaskExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartTaskExecutionCommandOutput>;
359
256
  startTaskExecution(args: StartTaskExecutionCommandInput, cb: (err: any, data?: StartTaskExecutionCommandOutput) => void): void;
360
257
  startTaskExecution(args: StartTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTaskExecutionCommandOutput) => void): void;
361
258
  /**
362
- * @public
363
- * <p>Applies a <i>tag</i> to an Amazon Web Services
364
- * resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.</p>
365
- * <p>These include DataSync resources, such as locations, tasks, and task executions.</p>
259
+ * @see {@link TagResourceCommand}
366
260
  */
367
261
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
368
262
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
369
263
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
370
264
  /**
371
- * @public
372
- * <p>Removes tags from an Amazon Web Services resource.</p>
265
+ * @see {@link UntagResourceCommand}
373
266
  */
374
267
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
375
268
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
376
269
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
377
270
  /**
378
- * @public
379
- * <p>Updates the name of an agent.</p>
271
+ * @see {@link UpdateAgentCommand}
380
272
  */
381
273
  updateAgent(args: UpdateAgentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAgentCommandOutput>;
382
274
  updateAgent(args: UpdateAgentCommandInput, cb: (err: any, data?: UpdateAgentCommandOutput) => void): void;
383
275
  updateAgent(args: UpdateAgentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAgentCommandOutput) => void): void;
384
276
  /**
385
- * @public
386
- * <p>Updates some parameters of a previously created location for a Hadoop Distributed File
387
- * System cluster.</p>
277
+ * @see {@link UpdateLocationHdfsCommand}
388
278
  */
389
279
  updateLocationHdfs(args: UpdateLocationHdfsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLocationHdfsCommandOutput>;
390
280
  updateLocationHdfs(args: UpdateLocationHdfsCommandInput, cb: (err: any, data?: UpdateLocationHdfsCommandOutput) => void): void;
391
281
  updateLocationHdfs(args: UpdateLocationHdfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationHdfsCommandOutput) => void): void;
392
282
  /**
393
- * @public
394
- * <p>Updates some of the parameters of a previously created location for Network File System (NFS) access.
395
- * For information about creating an NFS location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html">Creating a location for NFS</a>.</p>
283
+ * @see {@link UpdateLocationNfsCommand}
396
284
  */
397
285
  updateLocationNfs(args: UpdateLocationNfsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLocationNfsCommandOutput>;
398
286
  updateLocationNfs(args: UpdateLocationNfsCommandInput, cb: (err: any, data?: UpdateLocationNfsCommandOutput) => void): void;
399
287
  updateLocationNfs(args: UpdateLocationNfsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationNfsCommandOutput) => void): void;
400
288
  /**
401
- * @public
402
- * <p>Updates some parameters of an existing object storage location that DataSync
403
- * accesses for a transfer. For information about creating a self-managed object storage
404
- * location, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html">Creating a location for object
405
- * storage</a>.</p>
289
+ * @see {@link UpdateLocationObjectStorageCommand}
406
290
  */
407
291
  updateLocationObjectStorage(args: UpdateLocationObjectStorageCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLocationObjectStorageCommandOutput>;
408
292
  updateLocationObjectStorage(args: UpdateLocationObjectStorageCommandInput, cb: (err: any, data?: UpdateLocationObjectStorageCommandOutput) => void): void;
409
293
  updateLocationObjectStorage(args: UpdateLocationObjectStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationObjectStorageCommandOutput) => void): void;
410
294
  /**
411
- * @public
412
- * <p>Updates some of the parameters of a previously created location for Server Message Block
413
- * (SMB) file system access. For information about creating an SMB location, see
414
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html">Creating a location for SMB</a>.</p>
295
+ * @see {@link UpdateLocationSmbCommand}
415
296
  */
416
297
  updateLocationSmb(args: UpdateLocationSmbCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLocationSmbCommandOutput>;
417
298
  updateLocationSmb(args: UpdateLocationSmbCommandInput, cb: (err: any, data?: UpdateLocationSmbCommandOutput) => void): void;
418
299
  updateLocationSmb(args: UpdateLocationSmbCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLocationSmbCommandOutput) => void): void;
419
300
  /**
420
- * @public
421
- * <p>Updates the metadata associated with a task.</p>
301
+ * @see {@link UpdateTaskCommand}
422
302
  */
423
303
  updateTask(args: UpdateTaskCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTaskCommandOutput>;
424
304
  updateTask(args: UpdateTaskCommandInput, cb: (err: any, data?: UpdateTaskCommandOutput) => void): void;
425
305
  updateTask(args: UpdateTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskCommandOutput) => void): void;
426
306
  /**
427
- * @public
428
- * <p>Updates execution of a task.</p>
429
- * <p>You can modify bandwidth throttling for a task execution that is running or queued.
430
- * 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>
431
- * <note>
432
- * <p>The only <code>Option</code> that can be modified by <code>UpdateTaskExecution</code>
433
- * is <code>
434
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond">BytesPerSecond</a>
435
- * </code>.</p>
436
- * </note>
307
+ * @see {@link UpdateTaskExecutionCommand}
437
308
  */
438
309
  updateTaskExecution(args: UpdateTaskExecutionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTaskExecutionCommandOutput>;
439
310
  updateTaskExecution(args: UpdateTaskExecutionCommandInput, cb: (err: any, data?: UpdateTaskExecutionCommandOutput) => void): void;
440
311
  updateTaskExecution(args: UpdateTaskExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskExecutionCommandOutput) => void): void;
441
312
  }
313
+ /**
314
+ * @public
315
+ * <fullname>DataSync</fullname>
316
+ * <p>DataSync is a managed data transfer service that makes it simpler for you
317
+ * 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>
318
+ * <p>This API interface reference includes documentation for using DataSync
319
+ * programmatically. For complete information, see the <i>
320
+ * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User
321
+ * Guide</a>
322
+ * </i>.</p>
323
+ */
324
+ export declare class DataSync extends DataSyncClient implements DataSync {
325
+ }
@@ -176,7 +176,7 @@ import {
176
176
  UpdateTaskExecutionCommandOutput,
177
177
  } from "./commands/UpdateTaskExecutionCommand";
178
178
  import { DataSyncClient } from "./DataSyncClient";
179
- export declare class DataSync extends DataSyncClient {
179
+ export interface DataSync {
180
180
  cancelTaskExecution(
181
181
  args: CancelTaskExecutionCommandInput,
182
182
  options?: __HttpHandlerOptions
@@ -750,3 +750,4 @@ export declare class DataSync extends DataSyncClient {
750
750
  cb: (err: any, data?: UpdateTaskExecutionCommandOutput) => void
751
751
  ): void;
752
752
  }
753
+ export declare class DataSync extends DataSyncClient implements DataSync {}
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.315.0",
4
+ "version": "3.319.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.319.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.319.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -36,19 +36,19 @@
36
36
  "@aws-sdk/middleware-serde": "3.310.0",
37
37
  "@aws-sdk/middleware-signing": "3.310.0",
38
38
  "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.310.0",
39
+ "@aws-sdk/middleware-user-agent": "3.319.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
51
- "@aws-sdk/util-endpoints": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
+ "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",