@aws-sdk/client-datasync 3.36.0 → 3.36.1

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.
Files changed (92) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/DataSync.js +0 -9
  3. package/dist-cjs/DataSyncClient.js +0 -14
  4. package/dist-cjs/commands/CancelTaskExecutionCommand.js +0 -31
  5. package/dist-cjs/commands/CreateAgentCommand.js +0 -38
  6. package/dist-cjs/commands/CreateLocationEfsCommand.js +0 -24
  7. package/dist-cjs/commands/CreateLocationFsxWindowsCommand.js +0 -24
  8. package/dist-cjs/commands/CreateLocationNfsCommand.js +0 -25
  9. package/dist-cjs/commands/CreateLocationObjectStorageCommand.js +0 -25
  10. package/dist-cjs/commands/CreateLocationS3Command.js +0 -30
  11. package/dist-cjs/commands/CreateLocationSmbCommand.js +0 -25
  12. package/dist-cjs/commands/CreateTaskCommand.js +0 -42
  13. package/dist-cjs/commands/DeleteAgentCommand.js +0 -27
  14. package/dist-cjs/commands/DeleteLocationCommand.js +0 -24
  15. package/dist-cjs/commands/DeleteTaskCommand.js +0 -24
  16. package/dist-cjs/commands/DescribeAgentCommand.js +0 -26
  17. package/dist-cjs/commands/DescribeLocationEfsCommand.js +0 -24
  18. package/dist-cjs/commands/DescribeLocationFsxWindowsCommand.js +0 -25
  19. package/dist-cjs/commands/DescribeLocationNfsCommand.js +0 -24
  20. package/dist-cjs/commands/DescribeLocationObjectStorageCommand.js +0 -25
  21. package/dist-cjs/commands/DescribeLocationS3Command.js +0 -24
  22. package/dist-cjs/commands/DescribeLocationSmbCommand.js +0 -24
  23. package/dist-cjs/commands/DescribeTaskCommand.js +0 -24
  24. package/dist-cjs/commands/DescribeTaskExecutionCommand.js +0 -24
  25. package/dist-cjs/commands/ListAgentsCommand.js +0 -31
  26. package/dist-cjs/commands/ListLocationsCommand.js +0 -27
  27. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
  28. package/dist-cjs/commands/ListTaskExecutionsCommand.js +0 -24
  29. package/dist-cjs/commands/ListTasksCommand.js +0 -24
  30. package/dist-cjs/commands/StartTaskExecutionCommand.js +0 -32
  31. package/dist-cjs/commands/TagResourceCommand.js +0 -24
  32. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  33. package/dist-cjs/commands/UpdateAgentCommand.js +0 -24
  34. package/dist-cjs/commands/UpdateLocationNfsCommand.js +0 -25
  35. package/dist-cjs/commands/UpdateLocationObjectStorageCommand.js +0 -26
  36. package/dist-cjs/commands/UpdateLocationSmbCommand.js +0 -26
  37. package/dist-cjs/commands/UpdateTaskCommand.js +0 -24
  38. package/dist-cjs/commands/UpdateTaskExecutionCommand.js +0 -33
  39. package/dist-cjs/models/models_0.js +0 -267
  40. package/dist-cjs/pagination/ListAgentsPaginator.js +0 -10
  41. package/dist-cjs/pagination/ListLocationsPaginator.js +0 -10
  42. package/dist-cjs/pagination/ListTagsForResourcePaginator.js +0 -10
  43. package/dist-cjs/pagination/ListTaskExecutionsPaginator.js +0 -10
  44. package/dist-cjs/pagination/ListTasksPaginator.js +0 -10
  45. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  46. package/dist-cjs/runtimeConfig.browser.js +1 -5
  47. package/dist-cjs/runtimeConfig.js +1 -5
  48. package/dist-cjs/runtimeConfig.native.js +0 -3
  49. package/dist-cjs/runtimeConfig.shared.js +0 -3
  50. package/dist-types/ts3.4/DataSync.d.ts +36 -201
  51. package/dist-types/ts3.4/DataSyncClient.d.ts +24 -95
  52. package/dist-types/ts3.4/commands/CancelTaskExecutionCommand.d.ts +2 -27
  53. package/dist-types/ts3.4/commands/CreateAgentCommand.d.ts +2 -34
  54. package/dist-types/ts3.4/commands/CreateLocationEfsCommand.d.ts +2 -20
  55. package/dist-types/ts3.4/commands/CreateLocationFsxWindowsCommand.d.ts +2 -20
  56. package/dist-types/ts3.4/commands/CreateLocationNfsCommand.d.ts +2 -21
  57. package/dist-types/ts3.4/commands/CreateLocationObjectStorageCommand.d.ts +2 -21
  58. package/dist-types/ts3.4/commands/CreateLocationS3Command.d.ts +2 -26
  59. package/dist-types/ts3.4/commands/CreateLocationSmbCommand.d.ts +2 -21
  60. package/dist-types/ts3.4/commands/CreateTaskCommand.d.ts +2 -38
  61. package/dist-types/ts3.4/commands/DeleteAgentCommand.d.ts +2 -23
  62. package/dist-types/ts3.4/commands/DeleteLocationCommand.d.ts +2 -20
  63. package/dist-types/ts3.4/commands/DeleteTaskCommand.d.ts +2 -20
  64. package/dist-types/ts3.4/commands/DescribeAgentCommand.d.ts +2 -22
  65. package/dist-types/ts3.4/commands/DescribeLocationEfsCommand.d.ts +2 -20
  66. package/dist-types/ts3.4/commands/DescribeLocationFsxWindowsCommand.d.ts +2 -21
  67. package/dist-types/ts3.4/commands/DescribeLocationNfsCommand.d.ts +2 -20
  68. package/dist-types/ts3.4/commands/DescribeLocationObjectStorageCommand.d.ts +2 -21
  69. package/dist-types/ts3.4/commands/DescribeLocationS3Command.d.ts +2 -20
  70. package/dist-types/ts3.4/commands/DescribeLocationSmbCommand.d.ts +2 -20
  71. package/dist-types/ts3.4/commands/DescribeTaskCommand.d.ts +2 -20
  72. package/dist-types/ts3.4/commands/DescribeTaskExecutionCommand.d.ts +2 -20
  73. package/dist-types/ts3.4/commands/ListAgentsCommand.d.ts +2 -27
  74. package/dist-types/ts3.4/commands/ListLocationsCommand.d.ts +2 -23
  75. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  76. package/dist-types/ts3.4/commands/ListTaskExecutionsCommand.d.ts +2 -20
  77. package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +2 -20
  78. package/dist-types/ts3.4/commands/StartTaskExecutionCommand.d.ts +2 -28
  79. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
  80. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  81. package/dist-types/ts3.4/commands/UpdateAgentCommand.d.ts +2 -20
  82. package/dist-types/ts3.4/commands/UpdateLocationNfsCommand.d.ts +2 -21
  83. package/dist-types/ts3.4/commands/UpdateLocationObjectStorageCommand.d.ts +2 -22
  84. package/dist-types/ts3.4/commands/UpdateLocationSmbCommand.d.ts +2 -22
  85. package/dist-types/ts3.4/commands/UpdateTaskCommand.d.ts +2 -20
  86. package/dist-types/ts3.4/commands/UpdateTaskExecutionCommand.d.ts +2 -29
  87. package/dist-types/ts3.4/models/models_0.d.ts +419 -1922
  88. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  89. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  90. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  91. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  92. package/package.json +3 -3
@@ -3,62 +3,39 @@ export declare enum AgentStatus {
3
3
  OFFLINE = "OFFLINE",
4
4
  ONLINE = "ONLINE"
5
5
  }
6
- /**
7
- * <p>Represents a single entry in a list of agents. <code>AgentListEntry</code> returns an
8
- * array that contains a list of agents when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html">ListAgents</a>
9
- * operation is
10
- * called.</p>
11
- */
6
+
12
7
  export interface AgentListEntry {
13
- /**
14
- * <p>The Amazon Resource Name (ARN) of the agent.</p>
15
- */
8
+
16
9
  AgentArn?: string;
17
- /**
18
- * <p>The name of the agent.</p>
19
- */
10
+
20
11
  Name?: string;
21
- /**
22
- * <p>The status of the agent.</p>
23
- */
12
+
24
13
  Status?: AgentStatus | string;
25
14
  }
26
15
  export declare namespace AgentListEntry {
27
- /**
28
- * @internal
29
- */
16
+
30
17
  const filterSensitiveLog: (obj: AgentListEntry) => any;
31
18
  }
32
19
  export declare enum Atime {
33
20
  BEST_EFFORT = "BEST_EFFORT",
34
21
  NONE = "NONE"
35
22
  }
36
- /**
37
- * <p>CancelTaskExecutionRequest</p>
38
- */
23
+
39
24
  export interface CancelTaskExecutionRequest {
40
- /**
41
- * <p>The Amazon Resource Name (ARN) of the task execution to cancel.</p>
42
- */
25
+
43
26
  TaskExecutionArn: string | undefined;
44
27
  }
45
28
  export declare namespace CancelTaskExecutionRequest {
46
- /**
47
- * @internal
48
- */
29
+
49
30
  const filterSensitiveLog: (obj: CancelTaskExecutionRequest) => any;
50
31
  }
51
32
  export interface CancelTaskExecutionResponse {
52
33
  }
53
34
  export declare namespace CancelTaskExecutionResponse {
54
- /**
55
- * @internal
56
- */
35
+
57
36
  const filterSensitiveLog: (obj: CancelTaskExecutionResponse) => any;
58
37
  }
59
- /**
60
- * <p>This exception is thrown when an error occurs in the DataSync service.</p>
61
- */
38
+
62
39
  export interface InternalException extends __SmithyException, $MetadataBearer {
63
40
  name: "InternalException";
64
41
  $fault: "server";
@@ -66,14 +43,10 @@ export interface InternalException extends __SmithyException, $MetadataBearer {
66
43
  errorCode?: string;
67
44
  }
68
45
  export declare namespace InternalException {
69
- /**
70
- * @internal
71
- */
46
+
72
47
  const filterSensitiveLog: (obj: InternalException) => any;
73
48
  }
74
- /**
75
- * <p>This exception is thrown when the client submits a malformed request.</p>
76
- */
49
+
77
50
  export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
78
51
  name: "InvalidRequestException";
79
52
  $fault: "client";
@@ -81,265 +54,109 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea
81
54
  errorCode?: string;
82
55
  }
83
56
  export declare namespace InvalidRequestException {
84
- /**
85
- * @internal
86
- */
57
+
87
58
  const filterSensitiveLog: (obj: InvalidRequestException) => any;
88
59
  }
89
- /**
90
- * <p>Represents a single entry in a list of AWS resource tags. <code>TagListEntry</code>
91
- * returns an array that contains a list of tasks when the
92
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html">ListTagsForResource</a>
93
- * operation is called.</p>
94
- */
60
+
95
61
  export interface TagListEntry {
96
- /**
97
- * <p>The key for an Amazon Web Services resource tag.</p>
98
- */
62
+
99
63
  Key: string | undefined;
100
- /**
101
- * <p>The value for an Amazon Web Services resource tag.</p>
102
- */
64
+
103
65
  Value?: string;
104
66
  }
105
67
  export declare namespace TagListEntry {
106
- /**
107
- * @internal
108
- */
68
+
109
69
  const filterSensitiveLog: (obj: TagListEntry) => any;
110
70
  }
111
- /**
112
- * <p>CreateAgentRequest</p>
113
- */
71
+
114
72
  export interface CreateAgentRequest {
115
- /**
116
- * <p>Your agent activation key. You can get the activation key either by sending an HTTP GET
117
- * request with redirects that enable you to get the agent IP address (port 80). Alternatively,
118
- * you can get it from the DataSync console.</p>
119
- * <p>The redirect URL returned in the response provides you the activation key for your
120
- * agent in the query string parameter <code>activationKey</code>. It might also include other
121
- * activation-related parameters; however, these are merely defaults. The arguments you pass to
122
- * this API call determine the actual configuration of your agent.</p>
123
- *
124
- *
125
- * <p>For more information, see Activating an Agent in the <i>DataSync
126
- * User Guide.</i>
127
- * </p>
128
- */
73
+
129
74
  ActivationKey: string | undefined;
130
- /**
131
- * <p>The name you configured for your agent. This value is a text reference that is used to
132
- * identify the agent in the console.</p>
133
- */
75
+
134
76
  AgentName?: string;
135
- /**
136
- * <p>The key-value pair that represents the tag that you want to associate with the agent.
137
- * The value can be an empty string. This value helps you manage, filter, and search for your
138
- * agents.</p>
139
- * <note>
140
- * <p>Valid characters for key and value are letters, spaces, and numbers representable in
141
- * UTF-8 format, and the following special characters: + - = . _ : / @. </p>
142
- * </note>
143
- */
77
+
144
78
  Tags?: TagListEntry[];
145
- /**
146
- * <p>The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is
147
- * the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC
148
- * endpoint, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service">Creating a VPC Endpoint Service Configuration</a> in the Amazon VPC User Guide.</p>
149
- * <p>VPC endpoint ID looks like this: <code>vpce-01234d5aff67890e1</code>.</p>
150
- */
79
+
151
80
  VpcEndpointId?: string;
152
- /**
153
- * <p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic
154
- * network interfaces for each data transfer task. The agent that runs a task must be private.
155
- * When you start a task that is associated with an agent created in a VPC, or one that has
156
- * access to an IP address in a VPC, then the task is also private. In this case, DataSync
157
- * creates four network interfaces for each task in your subnet. For a data transfer to work, the
158
- * agent must be able to route to all these four network interfaces.</p>
159
- */
81
+
160
82
  SubnetArns?: string[];
161
- /**
162
- * <p>The ARNs of the security groups used to protect your data transfer task subnets. See <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns">SecurityGroupArns</a>.</p>
163
- */
83
+
164
84
  SecurityGroupArns?: string[];
165
85
  }
166
86
  export declare namespace CreateAgentRequest {
167
- /**
168
- * @internal
169
- */
87
+
170
88
  const filterSensitiveLog: (obj: CreateAgentRequest) => any;
171
89
  }
172
- /**
173
- * <p>CreateAgentResponse</p>
174
- */
90
+
175
91
  export interface CreateAgentResponse {
176
- /**
177
- * <p>The Amazon Resource Name (ARN) of the agent. Use the <code>ListAgents</code> operation
178
- * to return a list of agents for your account and Amazon Web Services Region.</p>
179
- */
92
+
180
93
  AgentArn?: string;
181
94
  }
182
95
  export declare namespace CreateAgentResponse {
183
- /**
184
- * @internal
185
- */
96
+
186
97
  const filterSensitiveLog: (obj: CreateAgentResponse) => any;
187
98
  }
188
- /**
189
- * <p>The subnet and the security group that DataSync uses to access target EFS file system.
190
- * The subnet must have at least one mount target for that file system. The security group that
191
- * you provide needs to be able to communicate with the security group on the mount target in the
192
- * subnet specified. </p>
193
- */
99
+
194
100
  export interface Ec2Config {
195
- /**
196
- * <p>The ARN of the subnet and the security group that DataSync uses to access the target
197
- * EFS file system.</p>
198
- */
101
+
199
102
  SubnetArn: string | undefined;
200
- /**
201
- * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the
202
- * Amazon EC2 resource.</p>
203
- */
103
+
204
104
  SecurityGroupArns: string[] | undefined;
205
105
  }
206
106
  export declare namespace Ec2Config {
207
- /**
208
- * @internal
209
- */
107
+
210
108
  const filterSensitiveLog: (obj: Ec2Config) => any;
211
109
  }
212
- /**
213
- * <p>CreateLocationEfsRequest</p>
214
- */
110
+
215
111
  export interface CreateLocationEfsRequest {
216
- /**
217
- * <p>A subdirectory in the location’s path. This subdirectory in the EFS file system is used
218
- * to read data from the EFS source location or write data to the EFS destination. By default,
219
- * DataSync uses the root directory.</p>
220
- * <note>
221
- * <p>
222
- * <code>Subdirectory</code> must be specified with forward slashes. For example,
223
- * <code>/path/to/folder</code>.</p>
224
- * </note>
225
- */
112
+
226
113
  Subdirectory?: string;
227
- /**
228
- * <p>The Amazon Resource Name (ARN) for the Amazon EFS file system.</p>
229
- */
114
+
230
115
  EfsFilesystemArn: string | undefined;
231
- /**
232
- * <p>The subnet and security group that the Amazon EFS file system uses. The security group
233
- * that you provide needs to be able to communicate with the security group on the mount target
234
- * in the subnet specified.</p>
235
- * <p>The exact relationship between security group M (of the mount target) and security
236
- * group S (which you provide for DataSync to use at this stage) is as follows: </p>
237
- * <ul>
238
- * <li>
239
- * <p> Security group M (which you associate with the mount target) must allow inbound
240
- * access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security
241
- * group S. You can enable inbound connections either by IP address (CIDR range) or security
242
- * group. </p>
243
- * </li>
244
- * <li>
245
- * <p>Security group S (provided to DataSync to access EFS) should have a rule that
246
- * enables outbound connections to the NFS port on one of the file system’s mount targets.
247
- * You can enable outbound connections either by IP address (CIDR range) or security
248
- * group.</p>
249
- *
250
- * <p>For information about security groups and mount targets, see Security
251
- * Groups for Amazon EC2 Instances and Mount Targets in the <i>Amazon EFS User
252
- * Guide.</i>
253
- * </p>
254
- * </li>
255
- * </ul>
256
- */
116
+
257
117
  Ec2Config: Ec2Config | undefined;
258
- /**
259
- * <p>The key-value pair that represents a tag that you want to add to the resource. The
260
- * value can be an empty string. This value helps you manage, filter, and search for your
261
- * resources. We recommend that you create a name tag for your location.</p>
262
- */
118
+
263
119
  Tags?: TagListEntry[];
264
120
  }
265
121
  export declare namespace CreateLocationEfsRequest {
266
- /**
267
- * @internal
268
- */
122
+
269
123
  const filterSensitiveLog: (obj: CreateLocationEfsRequest) => any;
270
124
  }
271
- /**
272
- * <p>CreateLocationEfs</p>
273
- */
125
+
274
126
  export interface CreateLocationEfsResponse {
275
- /**
276
- * <p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that is
277
- * created.</p>
278
- */
127
+
279
128
  LocationArn?: string;
280
129
  }
281
130
  export declare namespace CreateLocationEfsResponse {
282
- /**
283
- * @internal
284
- */
131
+
285
132
  const filterSensitiveLog: (obj: CreateLocationEfsResponse) => any;
286
133
  }
287
134
  export interface CreateLocationFsxWindowsRequest {
288
- /**
289
- * <p>A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows
290
- * File Server file system is used to read data from the Amazon FSx for Windows File Server
291
- * source location or write data to the FSx for Windows File Server destination.</p>
292
- */
135
+
293
136
  Subdirectory?: string;
294
- /**
295
- * <p>The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.</p>
296
- */
137
+
297
138
  FsxFilesystemArn: string | undefined;
298
- /**
299
- * <p>The Amazon Resource Names (ARNs) of the security groups that are to use to configure the
300
- * FSx for Windows File Server file system.</p>
301
- */
139
+
302
140
  SecurityGroupArns: string[] | undefined;
303
- /**
304
- * <p>The key-value pair that represents a tag that you want to add to the resource. The
305
- * value can be an empty string. This value helps you manage, filter, and search for your
306
- * resources. We recommend that you create a name tag for your location.</p>
307
- */
141
+
308
142
  Tags?: TagListEntry[];
309
- /**
310
- * <p>The user who has the permissions to access files and folders in the FSx for Windows File
311
- * Server file system.</p>
312
- * <p>For information about choosing a user name that ensures sufficient permissions to files,
313
- * folders, and metadata, see <a href="create-fsx-location.html#FSxWuser">user</a>.</p>
314
- */
143
+
315
144
  User: string | undefined;
316
- /**
317
- * <p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>
318
- */
145
+
319
146
  Domain?: string;
320
- /**
321
- * <p>The password of the user who has the permissions to access files and folders in the FSx
322
- * for Windows File Server file system.</p>
323
- */
147
+
324
148
  Password: string | undefined;
325
149
  }
326
150
  export declare namespace CreateLocationFsxWindowsRequest {
327
- /**
328
- * @internal
329
- */
151
+
330
152
  const filterSensitiveLog: (obj: CreateLocationFsxWindowsRequest) => any;
331
153
  }
332
154
  export interface CreateLocationFsxWindowsResponse {
333
- /**
334
- * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location
335
- * that is created.</p>
336
- */
155
+
337
156
  LocationArn?: string;
338
157
  }
339
158
  export declare namespace CreateLocationFsxWindowsResponse {
340
- /**
341
- * @internal
342
- */
159
+
343
160
  const filterSensitiveLog: (obj: CreateLocationFsxWindowsResponse) => any;
344
161
  }
345
162
  export declare enum NfsVersion {
@@ -348,242 +165,95 @@ export declare enum NfsVersion {
348
165
  NFS4_0 = "NFS4_0",
349
166
  NFS4_1 = "NFS4_1"
350
167
  }
351
- /**
352
- * <p>Represents the mount options that are available for DataSync to access an NFS
353
- * location.</p>
354
- */
168
+
355
169
  export interface NfsMountOptions {
356
- /**
357
- * <p>The specific NFS version that you want DataSync to use to mount your NFS share. If the
358
- * server refuses to use the version specified, the sync will fail. If you don't specify a
359
- * version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically
360
- * selects a version based on negotiation with the NFS server.</p>
361
- *
362
- * <p>You can specify the following NFS versions:</p>
363
- * <ul>
364
- * <li>
365
- * <p>
366
- * <b>
367
- * <a href="https://tools.ietf.org/html/rfc1813">NFSv3</a>
368
- * </b> - stateless protocol version that allows for asynchronous
369
- * writes on the server.</p>
370
- * </li>
371
- * <li>
372
- * <p>
373
- * <b>
374
- * <a href="https://tools.ietf.org/html/rfc3530">NFSv4.0</a>
375
- * </b> - stateful, firewall-friendly protocol version that supports
376
- * delegations and pseudo filesystems.</p>
377
- * </li>
378
- * <li>
379
- * <p>
380
- * <b>
381
- * <a href="https://tools.ietf.org/html/rfc5661">NFSv4.1</a>
382
- * </b> - stateful protocol version that supports sessions,
383
- * directory delegations, and parallel data processing. Version 4.1 also includes all
384
- * features available in version 4.0.</p>
385
- * </li>
386
- * </ul>
387
- */
170
+
388
171
  Version?: NfsVersion | string;
389
172
  }
390
173
  export declare namespace NfsMountOptions {
391
- /**
392
- * @internal
393
- */
174
+
394
175
  const filterSensitiveLog: (obj: NfsMountOptions) => any;
395
176
  }
396
- /**
397
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
398
- * location.</p>
399
- */
177
+
400
178
  export interface OnPremConfig {
401
- /**
402
- * <p>ARNs of the agents to use for an NFS location.</p>
403
- */
179
+
404
180
  AgentArns: string[] | undefined;
405
181
  }
406
182
  export declare namespace OnPremConfig {
407
- /**
408
- * @internal
409
- */
183
+
410
184
  const filterSensitiveLog: (obj: OnPremConfig) => any;
411
185
  }
412
- /**
413
- * <p>CreateLocationNfsRequest</p>
414
- */
186
+
415
187
  export interface CreateLocationNfsRequest {
416
- /**
417
- * <p>The subdirectory in the NFS file system that is used to read data from the NFS source
418
- * location or write data to the NFS destination. The NFS path should be a path that's
419
- * exported by the NFS server, or a subdirectory of that path. The path should be such that it
420
- * can be mounted by other NFS clients in your network. </p>
421
- * <p>To see all the paths exported by your NFS server, run "<code>showmount -e
422
- * nfs-server-name</code>" from an NFS client that has access to your server. You can specify
423
- * any directory that appears in the results, and any subdirectory of that directory. Ensure that
424
- * the NFS export is accessible without Kerberos authentication. </p>
425
- * <p>To transfer all the data in the folder you specified, DataSync needs to have
426
- * permissions to read all the data. To ensure this, either configure the NFS export with
427
- * <code>no_root_squash,</code> or ensure that the permissions for all of the files that you
428
- * want DataSync allow read access for all users. Doing either enables the agent to read the
429
- * files. For the agent to access directories, you must additionally enable all execute
430
- * access.</p>
431
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
432
- *
433
- * <p>For information about NFS export configuration, see 18.7. The /etc/exports
434
- * Configuration File in the Red Hat Enterprise Linux documentation.</p>
435
- */
188
+
436
189
  Subdirectory: string | undefined;
437
- /**
438
- * <p>The name of the NFS server. This value is the IP address or Domain Name Service (DNS)
439
- * name of the NFS server. An agent that is installed on-premises uses this host name to mount
440
- * the NFS server in a network. </p>
441
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
442
- * <note>
443
- * <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4)
444
- * address.</p>
445
- * </note>
446
- */
190
+
447
191
  ServerHostname: string | undefined;
448
- /**
449
- * <p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to
450
- * an NFS server. </p>
451
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
452
- */
192
+
453
193
  OnPremConfig: OnPremConfig | undefined;
454
- /**
455
- * <p>The NFS mount options that DataSync can use to mount your NFS share.</p>
456
- */
194
+
457
195
  MountOptions?: NfsMountOptions;
458
- /**
459
- * <p>The key-value pair that represents the tag that you want to add to the location. The
460
- * value can be an empty string. We recommend using tags to name your resources.</p>
461
- */
196
+
462
197
  Tags?: TagListEntry[];
463
198
  }
464
199
  export declare namespace CreateLocationNfsRequest {
465
- /**
466
- * @internal
467
- */
200
+
468
201
  const filterSensitiveLog: (obj: CreateLocationNfsRequest) => any;
469
202
  }
470
- /**
471
- * <p>CreateLocationNfsResponse</p>
472
- */
203
+
473
204
  export interface CreateLocationNfsResponse {
474
- /**
475
- * <p>The Amazon Resource Name (ARN) of the source NFS file system location that is
476
- * created.</p>
477
- */
205
+
478
206
  LocationArn?: string;
479
207
  }
480
208
  export declare namespace CreateLocationNfsResponse {
481
- /**
482
- * @internal
483
- */
209
+
484
210
  const filterSensitiveLog: (obj: CreateLocationNfsResponse) => any;
485
211
  }
486
212
  export declare enum ObjectStorageServerProtocol {
487
213
  HTTP = "HTTP",
488
214
  HTTPS = "HTTPS"
489
215
  }
490
- /**
491
- * <p>CreateLocationObjectStorageRequest</p>
492
- */
216
+
493
217
  export interface CreateLocationObjectStorageRequest {
494
- /**
495
- * <p>The name of the self-managed object storage server. This value is the
496
- * IP address or Domain Name Service (DNS) name of the object storage server.
497
- * An agent uses this host name to mount the object storage server in a network. </p>
498
- */
218
+
499
219
  ServerHostname: string | undefined;
500
- /**
501
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
502
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can
503
- * specify a custom port if your self-managed object storage server requires one.</p>
504
- */
220
+
505
221
  ServerPort?: number;
506
- /**
507
- * <p>The protocol that the object storage server uses to communicate.
508
- * Valid values are HTTP or HTTPS.</p>
509
- */
222
+
510
223
  ServerProtocol?: ObjectStorageServerProtocol | string;
511
- /**
512
- * <p>The subdirectory in the self-managed object storage server that is used
513
- * to read data from.</p>
514
- */
224
+
515
225
  Subdirectory?: string;
516
- /**
517
- * <p>The bucket on the self-managed object storage server that is used
518
- * to read data from.</p>
519
- */
226
+
520
227
  BucketName: string | undefined;
521
- /**
522
- * <p>Optional. The access key is used if credentials are required to access the self-managed
523
- * object storage server. If your object storage requires a user name and password to
524
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
525
- * and password, respectively.</p>
526
- */
228
+
527
229
  AccessKey?: string;
528
- /**
529
- * <p>Optional. The secret key is used if credentials are required to access the self-managed
530
- * object storage server. If your object storage requires a user name and password to
531
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
532
- * and password, respectively.</p>
533
- */
230
+
534
231
  SecretKey?: string;
535
- /**
536
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
537
- * self-managed object storage server location.</p>
538
- */
232
+
539
233
  AgentArns: string[] | undefined;
540
- /**
541
- * <p>The key-value pair that represents the tag that you want to add to the location. The
542
- * value can be an empty string. We recommend using tags to name your resources.</p>
543
- */
234
+
544
235
  Tags?: TagListEntry[];
545
236
  }
546
237
  export declare namespace CreateLocationObjectStorageRequest {
547
- /**
548
- * @internal
549
- */
238
+
550
239
  const filterSensitiveLog: (obj: CreateLocationObjectStorageRequest) => any;
551
240
  }
552
- /**
553
- * <p>CreateLocationObjectStorageResponse</p>
554
- */
241
+
555
242
  export interface CreateLocationObjectStorageResponse {
556
- /**
557
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
558
- * self-managed object storage server location.</p>
559
- */
243
+
560
244
  LocationArn?: string;
561
245
  }
562
246
  export declare namespace CreateLocationObjectStorageResponse {
563
- /**
564
- * @internal
565
- */
247
+
566
248
  const filterSensitiveLog: (obj: CreateLocationObjectStorageResponse) => any;
567
249
  }
568
- /**
569
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
570
- * that is used to access an Amazon S3 bucket.</p>
571
- *
572
- * <p>For detailed information about using such a role, see Creating a Location for
573
- * Amazon S3 in the <i>DataSync User Guide</i>.</p>
574
- */
250
+
575
251
  export interface S3Config {
576
- /**
577
- * <p>The Amazon S3 bucket to access. This bucket is used as a parameter in the
578
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationS3.html">CreateLocationS3</a>
579
- * operation. </p>
580
- */
252
+
581
253
  BucketAccessRoleArn: string | undefined;
582
254
  }
583
255
  export declare namespace S3Config {
584
- /**
585
- * @internal
586
- */
256
+
587
257
  const filterSensitiveLog: (obj: S3Config) => any;
588
258
  }
589
259
  export declare enum S3StorageClass {
@@ -595,69 +265,32 @@ export declare enum S3StorageClass {
595
265
  STANDARD = "STANDARD",
596
266
  STANDARD_IA = "STANDARD_IA"
597
267
  }
598
- /**
599
- * <p>CreateLocationS3Request</p>
600
- */
268
+
601
269
  export interface CreateLocationS3Request {
602
- /**
603
- * <p>A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read
604
- * data from the S3 source location or write data to the S3 destination.</p>
605
- */
270
+
606
271
  Subdirectory?: string;
607
- /**
608
- * <p>The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an
609
- * access point ARN.</p>
610
- */
272
+
611
273
  S3BucketArn: string | undefined;
612
- /**
613
- * <p>The Amazon S3 storage class that you want to store your files in when this location is
614
- * used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard.
615
- * For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</p>
616
- *
617
- * <p>For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage classes have behaviors that
618
- * can affect your S3 storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with S3 storage classes in DataSync</a>.</p>
619
- */
274
+
620
275
  S3StorageClass?: S3StorageClass | string;
621
- /**
622
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
623
- * that is used to access an Amazon S3 bucket.</p>
624
- *
625
- * <p>For detailed information about using such a role, see Creating a Location for
626
- * Amazon S3 in the <i>DataSync User Guide</i>.</p>
627
- */
276
+
628
277
  S3Config: S3Config | undefined;
629
- /**
630
- * <p>If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of
631
- * the DataSync agents deployed on your Outpost. For more information about launching a DataSync
632
- * agent on an Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent on Outposts</a>.</p>
633
- */
278
+
634
279
  AgentArns?: string[];
635
- /**
636
- * <p>The key-value pair that represents the tag that you want to add to the location. The
637
- * value can be an empty string. We recommend using tags to name your resources.</p>
638
- */
280
+
639
281
  Tags?: TagListEntry[];
640
282
  }
641
283
  export declare namespace CreateLocationS3Request {
642
- /**
643
- * @internal
644
- */
284
+
645
285
  const filterSensitiveLog: (obj: CreateLocationS3Request) => any;
646
286
  }
647
- /**
648
- * <p>CreateLocationS3Response</p>
649
- */
287
+
650
288
  export interface CreateLocationS3Response {
651
- /**
652
- * <p>The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is
653
- * created.</p>
654
- */
289
+
655
290
  LocationArn?: string;
656
291
  }
657
292
  export declare namespace CreateLocationS3Response {
658
- /**
659
- * @internal
660
- */
293
+
661
294
  const filterSensitiveLog: (obj: CreateLocationS3Response) => any;
662
295
  }
663
296
  export declare enum SmbVersion {
@@ -665,137 +298,59 @@ export declare enum SmbVersion {
665
298
  SMB2 = "SMB2",
666
299
  SMB3 = "SMB3"
667
300
  }
668
- /**
669
- * <p>Represents the mount options that are available for DataSync to access an SMB
670
- * location.</p>
671
- */
301
+
672
302
  export interface SmbMountOptions {
673
- /**
674
- * <p>The specific SMB version that you want DataSync to use to mount your SMB share. If you
675
- * don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync
676
- * automatically selects a version based on negotiation with the SMB server.</p>
677
- */
303
+
678
304
  Version?: SmbVersion | string;
679
305
  }
680
306
  export declare namespace SmbMountOptions {
681
- /**
682
- * @internal
683
- */
307
+
684
308
  const filterSensitiveLog: (obj: SmbMountOptions) => any;
685
309
  }
686
- /**
687
- * <p>CreateLocationSmbRequest</p>
688
- */
310
+
689
311
  export interface CreateLocationSmbRequest {
690
- /**
691
- * <p>The subdirectory in the SMB file system that is used to read data from the SMB source
692
- * location or write data to the SMB destination. The SMB path should be a path that's
693
- * exported by the SMB server, or a subdirectory of that path. The path should be such that it
694
- * can be mounted by other SMB clients in your network.</p>
695
- * <note>
696
- * <p>
697
- * <code>Subdirectory</code> must be specified with forward slashes. For example,
698
- * <code>/path/to/folder</code>.</p>
699
- * </note>
700
- *
701
- * <p>To transfer all the data in the folder you specified, DataSync needs to have permissions
702
- * to mount the SMB share, as well as to access all the data in that share. To ensure this,
703
- * either ensure that the user/password specified belongs to the user who can mount the share,
704
- * and who has the appropriate permissions for all of the files and directories that you want
705
- * DataSync to access, or use credentials of a member of the Backup Operators group to mount
706
- * the share. Doing either enables the agent to access the data. For the agent to access
707
- * directories, you must additionally enable all execute access.</p>
708
- */
312
+
709
313
  Subdirectory: string | undefined;
710
- /**
711
- * <p>The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name
712
- * of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB
713
- * server in a network.</p>
714
- * <note>
715
- * <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p>
716
- * </note>
717
- */
314
+
718
315
  ServerHostname: string | undefined;
719
- /**
720
- * <p>The user who can mount the share, has the permissions to access files and folders in the
721
- * SMB share.</p>
722
- *
723
- * <p>For information about choosing a user name that ensures sufficient permissions to files,
724
- * folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
725
- */
316
+
726
317
  User: string | undefined;
727
- /**
728
- * <p>The name of the Windows domain that the SMB server belongs to.</p>
729
- */
318
+
730
319
  Domain?: string;
731
- /**
732
- * <p>The password of the user who can mount the share, has the permissions to access files and
733
- * folders in the SMB share.</p>
734
- */
320
+
735
321
  Password: string | undefined;
736
- /**
737
- * <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)
738
- * location. </p>
739
- */
322
+
740
323
  AgentArns: string[] | undefined;
741
- /**
742
- * <p>The mount options used by DataSync to access the SMB server.</p>
743
- */
324
+
744
325
  MountOptions?: SmbMountOptions;
745
- /**
746
- * <p>The key-value pair that represents the tag that you want to add to the location. The value
747
- * can be an empty string. We recommend using tags to name your resources.</p>
748
- */
326
+
749
327
  Tags?: TagListEntry[];
750
328
  }
751
329
  export declare namespace CreateLocationSmbRequest {
752
- /**
753
- * @internal
754
- */
330
+
755
331
  const filterSensitiveLog: (obj: CreateLocationSmbRequest) => any;
756
332
  }
757
- /**
758
- * <p>CreateLocationSmbResponse</p>
759
- */
333
+
760
334
  export interface CreateLocationSmbResponse {
761
- /**
762
- * <p>The Amazon Resource Name (ARN) of the source SMB file system location that is
763
- * created.</p>
764
- */
335
+
765
336
  LocationArn?: string;
766
337
  }
767
338
  export declare namespace CreateLocationSmbResponse {
768
- /**
769
- * @internal
770
- */
339
+
771
340
  const filterSensitiveLog: (obj: CreateLocationSmbResponse) => any;
772
341
  }
773
342
  export declare enum FilterType {
774
343
  SIMPLE_PATTERN = "SIMPLE_PATTERN"
775
344
  }
776
- /**
777
- * <p>Specifies which files, folders, and objects to include or exclude when transferring files
778
- * from source to destination.</p>
779
- */
345
+
780
346
  export interface FilterRule {
781
- /**
782
- * <p>The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule
783
- * type.</p>
784
- */
347
+
785
348
  FilterType?: FilterType | string;
786
- /**
787
- * <p>A single filter string that consists of the patterns to include or exclude. The patterns
788
- * are delimited by "|" (that is, a pipe), for example: <code>/folder1|/folder2</code>
789
- * </p>
790
- * <p>
791
- * </p>
792
- */
349
+
793
350
  Value?: string;
794
351
  }
795
352
  export declare namespace FilterRule {
796
- /**
797
- * @internal
798
- */
353
+
799
354
  const filterSensitiveLog: (obj: FilterRule) => any;
800
355
  }
801
356
  export declare enum Gid {
@@ -853,409 +408,136 @@ export declare enum VerifyMode {
853
408
  ONLY_FILES_TRANSFERRED = "ONLY_FILES_TRANSFERRED",
854
409
  POINT_IN_TIME_CONSISTENT = "POINT_IN_TIME_CONSISTENT"
855
410
  }
856
- /**
857
- * <p>Represents the options that are available to control the behavior of a
858
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
859
- * operation. Behavior includes preserving metadata such as user
860
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
861
- * data integrity verification, and so on.</p>
862
- * <p>A task has a set of default options associated with it. If you don't specify an option
863
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
864
- * the default value is used. You can override the
865
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
866
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
867
- */
411
+
868
412
  export interface Options {
869
- /**
870
- * <p>A value that determines whether a data integrity verification should be performed at
871
- * the end of a task execution after all data and metadata have been transferred.
872
- * For more information, see
873
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html">Configure task settings</a>.
874
- * </p>
875
- * <p>Default value: POINT_IN_TIME_CONSISTENT.</p>
876
- * <p>ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
877
- * </p>
878
- *
879
- * <p>POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination
880
- * at the end of the transfer
881
- * to verify that source and destination are fully
882
- * synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier
883
- * Deep Archive storage classes.</p>
884
- * <p>NONE: No additional verification is done at the end of the
885
- * transfer, but all data transmissions are integrity-checked with
886
- * checksum verification during the transfer.</p>
887
- */
413
+
888
414
  VerifyMode?: VerifyMode | string;
889
- /**
890
- * <p>A value that determines whether files at the destination should be overwritten or
891
- * preserved when copying files. If set to <code>NEVER</code> a destination file will not be
892
- * replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to
893
- * protect against overwriting those changes. </p>
894
- * <p>Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see
895
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with Amazon S3 storage classes in DataSync </a>
896
- * in the <i>DataSync
897
- * User Guide</i>.</p>
898
- */
415
+
899
416
  OverwriteMode?: OverwriteMode | string;
900
- /**
901
- * <p>A file metadata value that shows the last time a file was accessed (that is, when the
902
- * file was read or written to). If you set <code>Atime</code> to BEST_EFFORT, DataSync
903
- * attempts to preserve the original <code>Atime</code> attribute on all source files (that is,
904
- * the version before the PREPARING phase). However, <code>Atime</code>'s behavior is not
905
- * fully standard across platforms, so DataSync can only do this on a best-effort basis. </p>
906
- * <p>Default value: BEST_EFFORT.</p>
907
- * <p>BEST_EFFORT: Attempt to preserve the per-file <code>Atime</code> value
908
- * (recommended).</p>
909
- * <p>NONE: Ignore <code>Atime</code>.</p>
910
- * <note>
911
- * <p>If <code>Atime</code> is set to BEST_EFFORT, <code>Mtime</code> must be set to PRESERVE. </p>
912
- * <p>If <code>Atime</code> is set to NONE, <code>Mtime</code> must also be NONE. </p>
913
- * </note>
914
- */
417
+
915
418
  Atime?: Atime | string;
916
- /**
917
- * <p>A value that indicates the last time that a file was modified (that is, a file was
918
- * written to) before the PREPARING phase. This option is required for cases when you need to run
919
- * the same task more than one time. </p>
920
- * <p>Default value: PRESERVE. </p>
921
- * <p>PRESERVE: Preserve original <code>Mtime</code> (recommended)</p>
922
- * <p> NONE: Ignore <code>Mtime</code>. </p>
923
- * <note>
924
- * <p>If <code>Mtime</code> is set to PRESERVE, <code>Atime</code> must be set to
925
- * BEST_EFFORT.</p>
926
- * <p>If <code>Mtime</code> is set to NONE, <code>Atime</code> must also be set to NONE.
927
- * </p>
928
- * </note>
929
- */
419
+
930
420
  Mtime?: Mtime | string;
931
- /**
932
- * <p>The POSIX user ID (UID) of the file's owner. This option should only be set for NFS,
933
- * EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>.</p>
934
- * <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p>
935
- * <p>INT_VALUE: Preserve the integer value of UID and group ID (GID)
936
- * (recommended).</p>
937
- * <p>NONE: Ignore UID and GID. </p>
938
- */
421
+
939
422
  Uid?: Uid | string;
940
- /**
941
- * <p>The POSIX group ID (GID) of the file's owners. This option should only be set for
942
- * NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync,
943
- * see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>. </p>
944
- * <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p>
945
- * <p>INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).</p>
946
- * <p>NONE: Ignore UID and GID. </p>
947
- */
423
+
948
424
  Gid?: Gid | string;
949
- /**
950
- * <p>A value that specifies whether files in the destination that don't exist in the source
951
- * file system should be preserved. This option can affect your storage cost.
952
- * If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed
953
- * information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with Amazon S3 storage classes in DataSync </a> in the <i>DataSync User
954
- * Guide</i>.</p>
955
- * <p>Default value: PRESERVE.</p>
956
- * <p>PRESERVE: Ignore such destination files (recommended). </p>
957
- * <p>REMOVE: Delete destination files that aren’t present in the source.</p>
958
- */
425
+
959
426
  PreserveDeletedFiles?: PreserveDeletedFiles | string;
960
- /**
961
- * <p>A value that determines whether DataSync should preserve the metadata of block
962
- * and character devices in the source file system, and re-create the files with that device name
963
- * and metadata on the destination. DataSync does not copy the contents of such devices, only the
964
- * name and metadata. </p>
965
- * <note>
966
- * <p>DataSync can't sync the actual contents of such devices, because they are
967
- * nonterminal and don't return an end-of-file (EOF) marker.</p>
968
- * </note>
969
- * <p>Default value: NONE.</p>
970
- * <p>NONE: Ignore special devices (recommended). </p>
971
- * <p>PRESERVE: Preserve character and block device metadata. This option isn't currently
972
- * supported for Amazon EFS. </p>
973
- */
427
+
974
428
  PreserveDevices?: PreserveDevices | string;
975
- /**
976
- * <p>A value that determines which users or groups can access a file for a specific purpose
977
- * such as reading, writing, or execution of the file. This option should only be set for NFS,
978
- * EFS, and S3 locations. For more information about what metadata is copied by DataSync, see
979
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>. </p>
980
- * <p>Default value: PRESERVE.</p>
981
- * <p>PRESERVE: Preserve POSIX-style permissions (recommended).</p>
982
- * <p>NONE: Ignore permissions. </p>
983
- * <note>
984
- * <p>DataSync can preserve extant permissions of a source location.</p>
985
- * </note>
986
- */
429
+
987
430
  PosixPermissions?: PosixPermissions | string;
988
- /**
989
- * <p>A value that limits the bandwidth used by DataSync. For example, if you want
990
- * DataSync to use a maximum of 1 MB, set this value to <code>1048576</code>
991
- * (<code>=1024*1024</code>).</p>
992
- */
431
+
993
432
  BytesPerSecond?: number;
994
- /**
995
- * <p>A value that determines whether tasks should be queued before executing the tasks. If set
996
- * to <code>ENABLED</code>, the tasks will be queued. The default is <code>ENABLED</code>.</p>
997
- * <p>If you use the same agent to run multiple tasks, you can enable the tasks to run in
998
- * series. For more information, see
999
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution">Queueing task executions</a>.</p>
1000
- */
433
+
1001
434
  TaskQueueing?: TaskQueueing | string;
1002
- /**
1003
- * <p>A value that determines the type of logs that DataSync publishes to a log stream in the
1004
- * Amazon CloudWatch log group that you provide. For more information about providing a log group
1005
- * for DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn">CloudWatchLogGroupArn</a>. If set to <code>OFF</code>, no logs are published.
1006
- * <code>BASIC</code> publishes logs on errors for individual files transferred, and
1007
- * <code>TRANSFER</code> publishes logs for every file or object that is transferred and
1008
- * integrity checked.</p>
1009
- */
435
+
1010
436
  LogLevel?: LogLevel | string;
1011
- /**
1012
- * <p>A value that determines whether DataSync transfers only the data and metadata that differ between the source
1013
- * and the destination location, or whether DataSync transfers all the content from the source, without comparing to
1014
- * the destination location. </p>
1015
- * <p>CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the
1016
- * destination location.</p>
1017
- * <p>ALL: DataSync copies all source location content to the destination, without comparing to existing content on
1018
- * the destination.</p>
1019
- */
437
+
1020
438
  TransferMode?: TransferMode | string;
1021
- /**
1022
- * <p>A value that determines which components of the SMB security descriptor are copied from source
1023
- * to destination objects.
1024
- * </p>
1025
- * <p>This value is only used for transfers
1026
- * between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File
1027
- * Server locations. For more information about how
1028
- * DataSync handles metadata, see
1029
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html">How DataSync Handles Metadata and Special Files</a>.
1030
- * </p>
1031
- * <p>Default value: OWNER_DACL.</p>
1032
- *
1033
- * <p>
1034
- * <b>OWNER_DACL</b>: For each copied object, DataSync copies the following metadata:</p>
1035
- * <ul>
1036
- * <li>
1037
- * <p>Object owner.</p>
1038
- * </li>
1039
- * <li>
1040
- * <p>NTFS discretionary access control lists (DACLs), which determine whether to
1041
- * grant access to an object.</p>
1042
- * </li>
1043
- * </ul>
1044
- * <p>When choosing this option, DataSync does NOT copy the NTFS system access control lists
1045
- * (SACLs), which are used by administrators to log attempts to access a secured object.</p>
1046
- *
1047
- * <p>
1048
- * <b>OWNER_DACL_SACL</b>: For each copied object, DataSync copies the following metadata:</p>
1049
- * <ul>
1050
- * <li>
1051
- * <p>Object owner.</p>
1052
- * </li>
1053
- * <li>
1054
- * <p>NTFS discretionary access control lists (DACLs), which determine whether to
1055
- * grant access to an object.</p>
1056
- * </li>
1057
- * <li>
1058
- * <p>NTFS system access control lists (SACLs), which are used by administrators
1059
- * to log attempts to access a secured object.</p>
1060
- * </li>
1061
- * </ul>
1062
- * <p>Copying SACLs requires granting additional permissions to the Windows user that DataSync
1063
- * uses to access your SMB location. For information about choosing a user that ensures
1064
- * sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
1065
- *
1066
- * <p>
1067
- * <b>NONE</b>: None of the SMB security descriptor components
1068
- * are copied. Destination objects are owned by the user that was provided for accessing the
1069
- * destination location. DACLs and SACLs are set based on the destination server’s configuration.
1070
- * </p>
1071
- */
439
+
1072
440
  SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags | string;
1073
441
  }
1074
442
  export declare namespace Options {
1075
- /**
1076
- * @internal
1077
- */
443
+
1078
444
  const filterSensitiveLog: (obj: Options) => any;
1079
445
  }
1080
- /**
1081
- * <p>Specifies the schedule you want your task to use for repeated executions. For more
1082
- * information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a>.</p>
1083
- */
446
+
1084
447
  export interface TaskSchedule {
1085
- /**
1086
- * <p>A cron expression that specifies when DataSync initiates a scheduled transfer from a
1087
- * source to a destination location. </p>
1088
- */
448
+
1089
449
  ScheduleExpression: string | undefined;
1090
450
  }
1091
451
  export declare namespace TaskSchedule {
1092
- /**
1093
- * @internal
1094
- */
452
+
1095
453
  const filterSensitiveLog: (obj: TaskSchedule) => any;
1096
454
  }
1097
- /**
1098
- * <p>CreateTaskRequest</p>
1099
- */
455
+
1100
456
  export interface CreateTaskRequest {
1101
- /**
1102
- * <p>The Amazon Resource Name (ARN) of the source location for the task.</p>
1103
- */
457
+
1104
458
  SourceLocationArn: string | undefined;
1105
- /**
1106
- * <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location. </p>
1107
- */
459
+
1108
460
  DestinationLocationArn: string | undefined;
1109
- /**
1110
- * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to
1111
- * monitor and log events in the task. </p>
1112
- */
461
+
1113
462
  CloudWatchLogGroupArn?: string;
1114
- /**
1115
- * <p>The name of a task. This value is a text reference that is used to identify the task in
1116
- * the console. </p>
1117
- */
463
+
1118
464
  Name?: string;
1119
- /**
1120
- * <p>The set of configuration options that control the behavior of a single execution of the
1121
- * task that occurs when you call <code>StartTaskExecution</code>. You can configure these
1122
- * options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data
1123
- * integrity verification, and so on.</p>
1124
- * <p>For each individual task execution, you can override these options by specifying the
1125
- * <code>OverrideOptions</code> before starting the task execution. For more information, see
1126
- * the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a> operation. </p>
1127
- */
465
+
1128
466
  Options?: Options;
1129
- /**
1130
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
1131
- * contain a single filter string that consists of the patterns to exclude. The patterns are
1132
- * delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
1133
- * <p>
1134
- * </p>
1135
- */
467
+
1136
468
  Excludes?: FilterRule[];
1137
- /**
1138
- * <p>Specifies a schedule used to periodically transfer files from a source to a destination
1139
- * 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 task</a>.</p>
1140
- */
469
+
1141
470
  Schedule?: TaskSchedule;
1142
- /**
1143
- * <p>The key-value pair that represents the tag that you want to add to the resource. The
1144
- * value can be an empty string. </p>
1145
- */
471
+
1146
472
  Tags?: TagListEntry[];
1147
- /**
1148
- * <p>A list of filter rules that determines which files to include when running a task. The
1149
- * pattern should contain a single filter string that consists of the patterns to include. The
1150
- * patterns are delimited by "|" (that is, a pipe). For example:
1151
- * <code>"/folder1|/folder2</code>"</p>
1152
- */
473
+
1153
474
  Includes?: FilterRule[];
1154
475
  }
1155
476
  export declare namespace CreateTaskRequest {
1156
- /**
1157
- * @internal
1158
- */
477
+
1159
478
  const filterSensitiveLog: (obj: CreateTaskRequest) => any;
1160
479
  }
1161
- /**
1162
- * <p>CreateTaskResponse</p>
1163
- */
480
+
1164
481
  export interface CreateTaskResponse {
1165
- /**
1166
- * <p>The Amazon Resource Name (ARN) of the task.</p>
1167
- */
482
+
1168
483
  TaskArn?: string;
1169
484
  }
1170
485
  export declare namespace CreateTaskResponse {
1171
- /**
1172
- * @internal
1173
- */
486
+
1174
487
  const filterSensitiveLog: (obj: CreateTaskResponse) => any;
1175
488
  }
1176
- /**
1177
- * <p>DeleteAgentRequest</p>
1178
- */
489
+
1179
490
  export interface DeleteAgentRequest {
1180
- /**
1181
- * <p>The Amazon Resource Name (ARN) of the agent to delete. Use the <code>ListAgents</code>
1182
- * operation to return a list of agents for your account and Amazon Web Services Region.</p>
1183
- */
491
+
1184
492
  AgentArn: string | undefined;
1185
493
  }
1186
494
  export declare namespace DeleteAgentRequest {
1187
- /**
1188
- * @internal
1189
- */
495
+
1190
496
  const filterSensitiveLog: (obj: DeleteAgentRequest) => any;
1191
497
  }
1192
498
  export interface DeleteAgentResponse {
1193
499
  }
1194
500
  export declare namespace DeleteAgentResponse {
1195
- /**
1196
- * @internal
1197
- */
501
+
1198
502
  const filterSensitiveLog: (obj: DeleteAgentResponse) => any;
1199
503
  }
1200
- /**
1201
- * <p>DeleteLocation</p>
1202
- */
504
+
1203
505
  export interface DeleteLocationRequest {
1204
- /**
1205
- * <p>The Amazon Resource Name (ARN) of the location to delete.</p>
1206
- */
506
+
1207
507
  LocationArn: string | undefined;
1208
508
  }
1209
509
  export declare namespace DeleteLocationRequest {
1210
- /**
1211
- * @internal
1212
- */
510
+
1213
511
  const filterSensitiveLog: (obj: DeleteLocationRequest) => any;
1214
512
  }
1215
513
  export interface DeleteLocationResponse {
1216
514
  }
1217
515
  export declare namespace DeleteLocationResponse {
1218
- /**
1219
- * @internal
1220
- */
516
+
1221
517
  const filterSensitiveLog: (obj: DeleteLocationResponse) => any;
1222
518
  }
1223
- /**
1224
- * <p>DeleteTask</p>
1225
- */
519
+
1226
520
  export interface DeleteTaskRequest {
1227
- /**
1228
- * <p>The Amazon Resource Name (ARN) of the task to delete.</p>
1229
- */
521
+
1230
522
  TaskArn: string | undefined;
1231
523
  }
1232
524
  export declare namespace DeleteTaskRequest {
1233
- /**
1234
- * @internal
1235
- */
525
+
1236
526
  const filterSensitiveLog: (obj: DeleteTaskRequest) => any;
1237
527
  }
1238
528
  export interface DeleteTaskResponse {
1239
529
  }
1240
530
  export declare namespace DeleteTaskResponse {
1241
- /**
1242
- * @internal
1243
- */
531
+
1244
532
  const filterSensitiveLog: (obj: DeleteTaskResponse) => any;
1245
533
  }
1246
- /**
1247
- * <p>DescribeAgent</p>
1248
- */
534
+
1249
535
  export interface DescribeAgentRequest {
1250
- /**
1251
- * <p>The Amazon Resource Name (ARN) of the agent to describe.</p>
1252
- */
536
+
1253
537
  AgentArn: string | undefined;
1254
538
  }
1255
539
  export declare namespace DescribeAgentRequest {
1256
- /**
1257
- * @internal
1258
- */
540
+
1259
541
  const filterSensitiveLog: (obj: DescribeAgentRequest) => any;
1260
542
  }
1261
543
  export declare enum EndpointType {
@@ -1263,412 +545,213 @@ export declare enum EndpointType {
1263
545
  PRIVATE_LINK = "PRIVATE_LINK",
1264
546
  PUBLIC = "PUBLIC"
1265
547
  }
1266
- /**
1267
- * <p>The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in
1268
- * a VPC (Virtual Private Cloud).</p>
1269
- */
548
+
1270
549
  export interface PrivateLinkConfig {
1271
- /**
1272
- * <p>The ID of the VPC endpoint that is configured for an agent. An agent that is configured
1273
- * with a VPC endpoint will not be accessible over the public internet.</p>
1274
- */
550
+
1275
551
  VpcEndpointId?: string;
1276
- /**
1277
- * <p>The private endpoint that is configured for an agent that has access to IP addresses in a
1278
- * <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html">PrivateLink</a>. An agent that is configured with this endpoint will not be accessible
1279
- * over the public internet.</p>
1280
- */
552
+
1281
553
  PrivateLinkEndpoint?: string;
1282
- /**
1283
- * <p>The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated
1284
- * in a VPC or an agent that has access to a VPC endpoint.</p>
1285
- */
554
+
1286
555
  SubnetArns?: string[];
1287
- /**
1288
- * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2
1289
- * resource that hosts an agent activated in a VPC or an agent that has access to a VPC
1290
- * endpoint.</p>
1291
- */
556
+
1292
557
  SecurityGroupArns?: string[];
1293
558
  }
1294
559
  export declare namespace PrivateLinkConfig {
1295
- /**
1296
- * @internal
1297
- */
560
+
1298
561
  const filterSensitiveLog: (obj: PrivateLinkConfig) => any;
1299
562
  }
1300
- /**
1301
- * <p>DescribeAgentResponse</p>
1302
- */
563
+
1303
564
  export interface DescribeAgentResponse {
1304
- /**
1305
- * <p>The Amazon Resource Name (ARN) of the agent.</p>
1306
- */
565
+
1307
566
  AgentArn?: string;
1308
- /**
1309
- * <p>The name of the agent.</p>
1310
- */
567
+
1311
568
  Name?: string;
1312
- /**
1313
- * <p>The status of the agent. If the status is ONLINE, then the agent is configured properly
1314
- * and is available to use. The Running status is the normal running status for an agent. If the
1315
- * status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When
1316
- * the issue that caused the unhealthy state is resolved, the agent returns to ONLINE
1317
- * status.</p>
1318
- */
569
+
1319
570
  Status?: AgentStatus | string;
1320
- /**
1321
- * <p>The time that the agent last connected to DataSync.</p>
1322
- */
571
+
1323
572
  LastConnectionTime?: Date;
1324
- /**
1325
- * <p>The time that the agent was activated (that is, created in your account).</p>
1326
- */
573
+
1327
574
  CreationTime?: Date;
1328
- /**
1329
- * <p>The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint,
1330
- * the agent is not accessible over the public internet. </p>
1331
- */
575
+
1332
576
  EndpointType?: EndpointType | string;
1333
- /**
1334
- * <p>The subnet and the security group that DataSync used to access a VPC endpoint.</p>
1335
- */
577
+
1336
578
  PrivateLinkConfig?: PrivateLinkConfig;
1337
579
  }
1338
580
  export declare namespace DescribeAgentResponse {
1339
- /**
1340
- * @internal
1341
- */
581
+
1342
582
  const filterSensitiveLog: (obj: DescribeAgentResponse) => any;
1343
583
  }
1344
- /**
1345
- * <p>DescribeLocationEfsRequest</p>
1346
- */
584
+
1347
585
  export interface DescribeLocationEfsRequest {
1348
- /**
1349
- * <p>The Amazon Resource Name (ARN) of the EFS location to describe.</p>
1350
- */
586
+
1351
587
  LocationArn: string | undefined;
1352
588
  }
1353
589
  export declare namespace DescribeLocationEfsRequest {
1354
- /**
1355
- * @internal
1356
- */
590
+
1357
591
  const filterSensitiveLog: (obj: DescribeLocationEfsRequest) => any;
1358
592
  }
1359
- /**
1360
- * <p>DescribeLocationEfsResponse</p>
1361
- */
593
+
1362
594
  export interface DescribeLocationEfsResponse {
1363
- /**
1364
- * <p>The Amazon Resource Name (ARN) of the EFS location that was described.</p>
1365
- */
595
+
1366
596
  LocationArn?: string;
1367
- /**
1368
- * <p>The URL of the EFS location that was described.</p>
1369
- */
597
+
1370
598
  LocationUri?: string;
1371
- /**
1372
- * <p>The subnet and the security group that DataSync uses to access target EFS file system.
1373
- * The subnet must have at least one mount target for that file system. The security group that
1374
- * you provide needs to be able to communicate with the security group on the mount target in the
1375
- * subnet specified. </p>
1376
- */
599
+
1377
600
  Ec2Config?: Ec2Config;
1378
- /**
1379
- * <p>The time that the EFS location was created.</p>
1380
- */
601
+
1381
602
  CreationTime?: Date;
1382
603
  }
1383
604
  export declare namespace DescribeLocationEfsResponse {
1384
- /**
1385
- * @internal
1386
- */
605
+
1387
606
  const filterSensitiveLog: (obj: DescribeLocationEfsResponse) => any;
1388
607
  }
1389
608
  export interface DescribeLocationFsxWindowsRequest {
1390
- /**
1391
- * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location to
1392
- * describe.</p>
1393
- */
609
+
1394
610
  LocationArn: string | undefined;
1395
611
  }
1396
612
  export declare namespace DescribeLocationFsxWindowsRequest {
1397
- /**
1398
- * @internal
1399
- */
613
+
1400
614
  const filterSensitiveLog: (obj: DescribeLocationFsxWindowsRequest) => any;
1401
615
  }
1402
616
  export interface DescribeLocationFsxWindowsResponse {
1403
- /**
1404
- * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was
1405
- * described.</p>
1406
- */
617
+
1407
618
  LocationArn?: string;
1408
- /**
1409
- * <p>The URL of the FSx for Windows File Server location that was described.</p>
1410
- */
619
+
1411
620
  LocationUri?: string;
1412
- /**
1413
- * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx
1414
- * for Windows File Server file system.</p>
1415
- */
621
+
1416
622
  SecurityGroupArns?: string[];
1417
- /**
1418
- * <p>The time that the FSx for Windows File Server location was created.</p>
1419
- */
623
+
1420
624
  CreationTime?: Date;
1421
- /**
1422
- * <p>The user who has the permissions to access files and folders in the FSx for Windows File
1423
- * Server file system.</p>
1424
- */
625
+
1425
626
  User?: string;
1426
- /**
1427
- * <p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>
1428
- */
627
+
1429
628
  Domain?: string;
1430
629
  }
1431
630
  export declare namespace DescribeLocationFsxWindowsResponse {
1432
- /**
1433
- * @internal
1434
- */
631
+
1435
632
  const filterSensitiveLog: (obj: DescribeLocationFsxWindowsResponse) => any;
1436
633
  }
1437
- /**
1438
- * <p>DescribeLocationNfsRequest</p>
1439
- */
634
+
1440
635
  export interface DescribeLocationNfsRequest {
1441
- /**
1442
- * <p>The Amazon Resource Name (ARN) of the NFS location to describe.</p>
1443
- */
636
+
1444
637
  LocationArn: string | undefined;
1445
638
  }
1446
639
  export declare namespace DescribeLocationNfsRequest {
1447
- /**
1448
- * @internal
1449
- */
640
+
1450
641
  const filterSensitiveLog: (obj: DescribeLocationNfsRequest) => any;
1451
642
  }
1452
- /**
1453
- * <p>DescribeLocationNfsResponse</p>
1454
- */
643
+
1455
644
  export interface DescribeLocationNfsResponse {
1456
- /**
1457
- * <p>The Amazon Resource Name (ARN) of the NFS location that was described.</p>
1458
- */
645
+
1459
646
  LocationArn?: string;
1460
- /**
1461
- * <p>The URL of the source NFS location that was described.</p>
1462
- */
647
+
1463
648
  LocationUri?: string;
1464
- /**
1465
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
1466
- * location.</p>
1467
- */
649
+
1468
650
  OnPremConfig?: OnPremConfig;
1469
- /**
1470
- * <p>The NFS mount options that DataSync used to mount your NFS share.</p>
1471
- */
651
+
1472
652
  MountOptions?: NfsMountOptions;
1473
- /**
1474
- * <p>The time that the NFS location was created.</p>
1475
- */
653
+
1476
654
  CreationTime?: Date;
1477
655
  }
1478
656
  export declare namespace DescribeLocationNfsResponse {
1479
- /**
1480
- * @internal
1481
- */
657
+
1482
658
  const filterSensitiveLog: (obj: DescribeLocationNfsResponse) => any;
1483
659
  }
1484
- /**
1485
- * <p>DescribeLocationObjectStorageRequest</p>
1486
- */
660
+
1487
661
  export interface DescribeLocationObjectStorageRequest {
1488
- /**
1489
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.</p>
1490
- */
662
+
1491
663
  LocationArn: string | undefined;
1492
664
  }
1493
665
  export declare namespace DescribeLocationObjectStorageRequest {
1494
- /**
1495
- * @internal
1496
- */
666
+
1497
667
  const filterSensitiveLog: (obj: DescribeLocationObjectStorageRequest) => any;
1498
668
  }
1499
- /**
1500
- * <p>DescribeLocationObjectStorageResponse</p>
1501
- */
669
+
1502
670
  export interface DescribeLocationObjectStorageResponse {
1503
- /**
1504
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.</p>
1505
- */
671
+
1506
672
  LocationArn?: string;
1507
- /**
1508
- * <p>The URL of the source self-managed object storage server location that was described.</p>
1509
- */
673
+
1510
674
  LocationUri?: string;
1511
- /**
1512
- * <p>Optional. The access key is used if credentials are required to access the self-managed
1513
- * object storage server. If your object storage requires a user name and password to
1514
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
1515
- * and password, respectively.</p>
1516
- */
675
+
1517
676
  AccessKey?: string;
1518
- /**
1519
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
1520
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).</p>
1521
- */
677
+
1522
678
  ServerPort?: number;
1523
- /**
1524
- * <p>The protocol that the object storage server uses to communicate.
1525
- * Valid values are HTTP or HTTPS.</p>
1526
- */
679
+
1527
680
  ServerProtocol?: ObjectStorageServerProtocol | string;
1528
- /**
1529
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
1530
- * self-managed object storage server location.</p>
1531
- */
681
+
1532
682
  AgentArns?: string[];
1533
- /**
1534
- * <p>The time that the self-managed object storage server agent was created.</p>
1535
- */
683
+
1536
684
  CreationTime?: Date;
1537
685
  }
1538
686
  export declare namespace DescribeLocationObjectStorageResponse {
1539
- /**
1540
- * @internal
1541
- */
687
+
1542
688
  const filterSensitiveLog: (obj: DescribeLocationObjectStorageResponse) => any;
1543
689
  }
1544
- /**
1545
- * <p>DescribeLocationS3Request</p>
1546
- */
690
+
1547
691
  export interface DescribeLocationS3Request {
1548
- /**
1549
- * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.</p>
1550
- */
692
+
1551
693
  LocationArn: string | undefined;
1552
694
  }
1553
695
  export declare namespace DescribeLocationS3Request {
1554
- /**
1555
- * @internal
1556
- */
696
+
1557
697
  const filterSensitiveLog: (obj: DescribeLocationS3Request) => any;
1558
698
  }
1559
- /**
1560
- * <p>DescribeLocationS3Response</p>
1561
- */
699
+
1562
700
  export interface DescribeLocationS3Response {
1563
- /**
1564
- * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.</p>
1565
- */
701
+
1566
702
  LocationArn?: string;
1567
- /**
1568
- * <p>The URL of the Amazon S3 location that was described.</p>
1569
- */
703
+
1570
704
  LocationUri?: string;
1571
- /**
1572
- * <p>The Amazon S3 storage class that you chose to store your files in when this location is
1573
- * used as a task destination. For more information about S3 storage classes, see <a href="http://aws.amazon.com/s3/storage-classes/">Amazon S3 Storage Classes</a>. Some storage
1574
- * classes have behaviors that can affect your S3 storage cost. For detailed information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when
1575
- * working with S3 storage classes in DataSync</a>.</p>
1576
- */
705
+
1577
706
  S3StorageClass?: S3StorageClass | string;
1578
- /**
1579
- * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
1580
- * that is used to access an Amazon S3 bucket.</p>
1581
- *
1582
- * <p>For detailed information about using such a role, see Creating a Location for
1583
- * Amazon S3 in the <i>DataSync User Guide</i>.</p>
1584
- */
707
+
1585
708
  S3Config?: S3Config;
1586
- /**
1587
- * <p>If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2
1588
- * agents deployed on your Outpost. For more information about launching a DataSync agent on an
1589
- * Amazon Web Services Outpost, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent">Deploy your DataSync agent on Outposts</a>.</p>
1590
- */
709
+
1591
710
  AgentArns?: string[];
1592
- /**
1593
- * <p>The time that the Amazon S3 bucket location was created.</p>
1594
- */
711
+
1595
712
  CreationTime?: Date;
1596
713
  }
1597
714
  export declare namespace DescribeLocationS3Response {
1598
- /**
1599
- * @internal
1600
- */
715
+
1601
716
  const filterSensitiveLog: (obj: DescribeLocationS3Response) => any;
1602
717
  }
1603
- /**
1604
- * <p>DescribeLocationSmbRequest</p>
1605
- */
718
+
1606
719
  export interface DescribeLocationSmbRequest {
1607
- /**
1608
- * <p>The Amazon Resource Name (ARN) of the SMB location to describe.</p>
1609
- */
720
+
1610
721
  LocationArn: string | undefined;
1611
722
  }
1612
723
  export declare namespace DescribeLocationSmbRequest {
1613
- /**
1614
- * @internal
1615
- */
724
+
1616
725
  const filterSensitiveLog: (obj: DescribeLocationSmbRequest) => any;
1617
726
  }
1618
- /**
1619
- * <p>DescribeLocationSmbResponse</p>
1620
- */
727
+
1621
728
  export interface DescribeLocationSmbResponse {
1622
- /**
1623
- * <p>The Amazon Resource Name (ARN) of the SMB location that was described.</p>
1624
- */
729
+
1625
730
  LocationArn?: string;
1626
- /**
1627
- * <p>The URL of the source SMB location that was described.</p>
1628
- */
731
+
1629
732
  LocationUri?: string;
1630
- /**
1631
- * <p>The Amazon Resource Name (ARN) of the source SMB file system location that is
1632
- * created.</p>
1633
- */
733
+
1634
734
  AgentArns?: string[];
1635
- /**
1636
- * <p>The user who can mount the share, has the permissions to access files and folders in the
1637
- * SMB share.</p>
1638
- */
735
+
1639
736
  User?: string;
1640
- /**
1641
- * <p>The name of the Windows domain that the SMB server belongs to.</p>
1642
- */
737
+
1643
738
  Domain?: string;
1644
- /**
1645
- * <p>The mount options that are available for DataSync to use to access an SMB location.</p>
1646
- */
739
+
1647
740
  MountOptions?: SmbMountOptions;
1648
- /**
1649
- * <p>The time that the SMB location was created.</p>
1650
- */
741
+
1651
742
  CreationTime?: Date;
1652
743
  }
1653
744
  export declare namespace DescribeLocationSmbResponse {
1654
- /**
1655
- * @internal
1656
- */
745
+
1657
746
  const filterSensitiveLog: (obj: DescribeLocationSmbResponse) => any;
1658
747
  }
1659
- /**
1660
- * <p>DescribeTaskRequest</p>
1661
- */
748
+
1662
749
  export interface DescribeTaskRequest {
1663
- /**
1664
- * <p>The Amazon Resource Name (ARN) of the task to describe.</p>
1665
- */
750
+
1666
751
  TaskArn: string | undefined;
1667
752
  }
1668
753
  export declare namespace DescribeTaskRequest {
1669
- /**
1670
- * @internal
1671
- */
754
+
1672
755
  const filterSensitiveLog: (obj: DescribeTaskRequest) => any;
1673
756
  }
1674
757
  export declare enum TaskStatus {
@@ -1678,120 +761,52 @@ export declare enum TaskStatus {
1678
761
  RUNNING = "RUNNING",
1679
762
  UNAVAILABLE = "UNAVAILABLE"
1680
763
  }
1681
- /**
1682
- * <p>DescribeTaskResponse</p>
1683
- */
764
+
1684
765
  export interface DescribeTaskResponse {
1685
- /**
1686
- * <p>The Amazon Resource Name (ARN) of the task that was described.</p>
1687
- */
766
+
1688
767
  TaskArn?: string;
1689
- /**
1690
- * <p>The status of the task that was described.</p>
1691
- *
1692
- *
1693
- * <p>For detailed information about task execution statuses, see Understanding
1694
- * Task Statuses in the <i>DataSync User Guide</i>.</p>
1695
- */
768
+
1696
769
  Status?: TaskStatus | string;
1697
- /**
1698
- * <p>The name of the task that was described.</p>
1699
- */
770
+
1700
771
  Name?: string;
1701
- /**
1702
- * <p>The Amazon Resource Name (ARN) of the task execution that is syncing files.</p>
1703
- */
772
+
1704
773
  CurrentTaskExecutionArn?: string;
1705
- /**
1706
- * <p>The Amazon Resource Name (ARN) of the source file system's location.</p>
1707
- */
774
+
1708
775
  SourceLocationArn?: string;
1709
- /**
1710
- * <p>The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.</p>
1711
- */
776
+
1712
777
  DestinationLocationArn?: string;
1713
- /**
1714
- * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to
1715
- * monitor and log events in the task.</p>
1716
- *
1717
- *
1718
- * <p>For more information on these groups, see Working with Log Groups and Log
1719
- * Streams in the <i>Amazon CloudWatch User Guide</i>.</p>
1720
- */
778
+
1721
779
  CloudWatchLogGroupArn?: string;
1722
- /**
1723
- * <p>The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was
1724
- * created for your subnet.</p>
1725
- */
780
+
1726
781
  SourceNetworkInterfaceArns?: string[];
1727
- /**
1728
- * <p>The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that
1729
- * was created for your subnet.</p>
1730
- */
782
+
1731
783
  DestinationNetworkInterfaceArns?: string[];
1732
- /**
1733
- * <p>The set of configuration options that control the behavior of a single execution of the
1734
- * task that occurs when you call <code>StartTaskExecution</code>. You can configure these
1735
- * options to preserve metadata such as user ID (UID) and group (GID), file permissions, data
1736
- * integrity verification, and so on.</p>
1737
- * <p>For each individual task execution, you can override these options by specifying the
1738
- * overriding <code>OverrideOptions</code> value to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a> operation. </p>
1739
- */
784
+
1740
785
  Options?: Options;
1741
- /**
1742
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
1743
- * contain a single filter string that consists of the patterns to exclude. The patterns are
1744
- * delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
1745
- * </p>
1746
- * <p>
1747
- * </p>
1748
- */
786
+
1749
787
  Excludes?: FilterRule[];
1750
- /**
1751
- * <p>The schedule used to periodically transfer files from a source to a destination location.</p>
1752
- */
788
+
1753
789
  Schedule?: TaskSchedule;
1754
- /**
1755
- * <p>Errors that DataSync encountered during execution of the task. You can use this
1756
- * error code to help troubleshoot issues.</p>
1757
- */
790
+
1758
791
  ErrorCode?: string;
1759
- /**
1760
- * <p>Detailed description of an error that was encountered during the task execution. You
1761
- * can use this information to help troubleshoot issues. </p>
1762
- */
792
+
1763
793
  ErrorDetail?: string;
1764
- /**
1765
- * <p>The time that the task was created.</p>
1766
- */
794
+
1767
795
  CreationTime?: Date;
1768
- /**
1769
- * <p>A list of filter rules that determines which files to include when running a task. The
1770
- * pattern should contain a single filter string that consists of the patterns to include. The
1771
- * patterns are delimited by "|" (that is, a pipe). For example:
1772
- * <code>"/folder1|/folder2</code>"</p>
1773
- */
796
+
1774
797
  Includes?: FilterRule[];
1775
798
  }
1776
799
  export declare namespace DescribeTaskResponse {
1777
- /**
1778
- * @internal
1779
- */
800
+
1780
801
  const filterSensitiveLog: (obj: DescribeTaskResponse) => any;
1781
802
  }
1782
- /**
1783
- * <p>DescribeTaskExecutionRequest</p>
1784
- */
803
+
1785
804
  export interface DescribeTaskExecutionRequest {
1786
- /**
1787
- * <p>The Amazon Resource Name (ARN) of the task that is being executed.</p>
1788
- */
805
+
1789
806
  TaskExecutionArn: string | undefined;
1790
807
  }
1791
808
  export declare namespace DescribeTaskExecutionRequest {
1792
- /**
1793
- * @internal
1794
- */
809
+
1795
810
  const filterSensitiveLog: (obj: DescribeTaskExecutionRequest) => any;
1796
811
  }
1797
812
  export declare enum PhaseStatus {
@@ -1799,58 +814,29 @@ export declare enum PhaseStatus {
1799
814
  PENDING = "PENDING",
1800
815
  SUCCESS = "SUCCESS"
1801
816
  }
1802
- /**
1803
- * <p>Describes the detailed result of a <code>TaskExecution</code> operation. This result
1804
- * includes the time in milliseconds spent in each phase, the status of the task execution, and
1805
- * the errors encountered.</p>
1806
- */
817
+
1807
818
  export interface TaskExecutionResultDetail {
1808
- /**
1809
- * <p>The total time in milliseconds that DataSync spent in the PREPARING phase.
1810
- * </p>
1811
- */
819
+
1812
820
  PrepareDuration?: number;
1813
- /**
1814
- * <p>The status of the PREPARING phase.</p>
1815
- */
821
+
1816
822
  PrepareStatus?: PhaseStatus | string;
1817
- /**
1818
- * <p>The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.</p>
1819
- */
823
+
1820
824
  TotalDuration?: number;
1821
- /**
1822
- * <p>The total time in milliseconds that DataSync spent in the TRANSFERRING
1823
- * phase.</p>
1824
- */
825
+
1825
826
  TransferDuration?: number;
1826
- /**
1827
- * <p>The status of the TRANSFERRING phase.</p>
1828
- */
827
+
1829
828
  TransferStatus?: PhaseStatus | string;
1830
- /**
1831
- * <p>The total time in milliseconds that DataSync spent in the VERIFYING
1832
- * phase.</p>
1833
- */
829
+
1834
830
  VerifyDuration?: number;
1835
- /**
1836
- * <p>The status of the VERIFYING phase.</p>
1837
- */
831
+
1838
832
  VerifyStatus?: PhaseStatus | string;
1839
- /**
1840
- * <p>Errors that DataSync encountered during execution of the task. You can use this
1841
- * error code to help troubleshoot issues.</p>
1842
- */
833
+
1843
834
  ErrorCode?: string;
1844
- /**
1845
- * <p>Detailed description of an error that was encountered during the task execution. You
1846
- * can use this information to help troubleshoot issues. </p>
1847
- */
835
+
1848
836
  ErrorDetail?: string;
1849
837
  }
1850
838
  export declare namespace TaskExecutionResultDetail {
1851
- /**
1852
- * @internal
1853
- */
839
+
1854
840
  const filterSensitiveLog: (obj: TaskExecutionResultDetail) => any;
1855
841
  }
1856
842
  export declare enum TaskExecutionStatus {
@@ -1862,145 +848,57 @@ export declare enum TaskExecutionStatus {
1862
848
  TRANSFERRING = "TRANSFERRING",
1863
849
  VERIFYING = "VERIFYING"
1864
850
  }
1865
- /**
1866
- * <p>DescribeTaskExecutionResponse</p>
1867
- */
851
+
1868
852
  export interface DescribeTaskExecutionResponse {
1869
- /**
1870
- * <p>The Amazon Resource Name (ARN) of the task execution that was described.
1871
- * <code>TaskExecutionArn</code> is hierarchical and includes <code>TaskArn</code> for the task
1872
- * that was executed. </p>
1873
- * <p>For example, a <code>TaskExecution</code> value with the ARN
1874
- * <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b</code>
1875
- * executed the task with the ARN
1876
- * <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2</code>. </p>
1877
- */
853
+
1878
854
  TaskExecutionArn?: string;
1879
- /**
1880
- * <p>The status of the task execution. </p>
1881
- *
1882
- *
1883
- * <p>For detailed information about task execution statuses, see Understanding
1884
- * Task Statuses in the <i>DataSync User Guide.</i>
1885
- * </p>
1886
- */
855
+
1887
856
  Status?: TaskExecutionStatus | string;
1888
- /**
1889
- * <p>Represents the options that are available to control the behavior of a
1890
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
1891
- * operation. Behavior includes preserving metadata such as user
1892
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
1893
- * data integrity verification, and so on.</p>
1894
- * <p>A task has a set of default options associated with it. If you don't specify an option
1895
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
1896
- * the default value is used. You can override the
1897
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
1898
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
1899
- */
857
+
1900
858
  Options?: Options;
1901
- /**
1902
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
1903
- * contain a single filter string that consists of the patterns to exclude. The patterns are
1904
- * delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
1905
- * </p>
1906
- * <p>
1907
- * </p>
1908
- */
859
+
1909
860
  Excludes?: FilterRule[];
1910
- /**
1911
- * <p>A list of filter rules that determines which files to include when running a task. The
1912
- * list should contain a single filter string that consists of the patterns to include. The
1913
- * patterns are delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
1914
- * </p>
1915
- * <p>
1916
- * </p>
1917
- */
861
+
1918
862
  Includes?: FilterRule[];
1919
- /**
1920
- * <p>The time that the task execution was started.</p>
1921
- */
863
+
1922
864
  StartTime?: Date;
1923
- /**
1924
- * <p>The expected number of files that is to be transferred over the network. This value is
1925
- * calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the
1926
- * expected number of files to be transferred. It's calculated based on comparing the
1927
- * content of the source and destination locations and finding the delta that needs to be
1928
- * transferred. </p>
1929
- */
865
+
1930
866
  EstimatedFilesToTransfer?: number;
1931
- /**
1932
- * <p>The estimated physical number of bytes that is to be transferred over the
1933
- * network.</p>
1934
- */
867
+
1935
868
  EstimatedBytesToTransfer?: number;
1936
- /**
1937
- * <p>The actual number of files that was transferred over the network. This value is
1938
- * calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated
1939
- * periodically when each file is read from the source and sent over the network. </p>
1940
- * <p>If failures occur during a transfer, this value can be less than
1941
- * <code>EstimatedFilesToTransfer</code>. This value can also be greater than
1942
- * <code>EstimatedFilesTransferred</code> in some cases. This element is
1943
- * implementation-specific for some location types, so don't use it as an indicator for a correct
1944
- * file number or to monitor your task execution.</p>
1945
- */
869
+
1946
870
  FilesTransferred?: number;
1947
- /**
1948
- * <p>The number of logical bytes written to the destination Amazon Web Services storage resource.</p>
1949
- */
871
+
1950
872
  BytesWritten?: number;
1951
- /**
1952
- * <p>The physical number of bytes transferred over the network.</p>
1953
- */
873
+
1954
874
  BytesTransferred?: number;
1955
- /**
1956
- * <p>The result of the task execution.</p>
1957
- */
875
+
1958
876
  Result?: TaskExecutionResultDetail;
1959
877
  }
1960
878
  export declare namespace DescribeTaskExecutionResponse {
1961
- /**
1962
- * @internal
1963
- */
879
+
1964
880
  const filterSensitiveLog: (obj: DescribeTaskExecutionResponse) => any;
1965
881
  }
1966
- /**
1967
- * <p>ListAgentsRequest</p>
1968
- */
882
+
1969
883
  export interface ListAgentsRequest {
1970
- /**
1971
- * <p>The maximum number of agents to list.</p>
1972
- */
884
+
1973
885
  MaxResults?: number;
1974
- /**
1975
- * <p>An opaque string that indicates the position at which to begin the next list of
1976
- * agents.</p>
1977
- */
886
+
1978
887
  NextToken?: string;
1979
888
  }
1980
889
  export declare namespace ListAgentsRequest {
1981
- /**
1982
- * @internal
1983
- */
890
+
1984
891
  const filterSensitiveLog: (obj: ListAgentsRequest) => any;
1985
892
  }
1986
- /**
1987
- * <p>ListAgentsResponse</p>
1988
- */
893
+
1989
894
  export interface ListAgentsResponse {
1990
- /**
1991
- * <p>A list of agents in your account.</p>
1992
- */
895
+
1993
896
  Agents?: AgentListEntry[];
1994
- /**
1995
- * <p>An opaque string that indicates the position at which to begin returning the next list
1996
- * of agents.</p>
1997
- */
897
+
1998
898
  NextToken?: string;
1999
899
  }
2000
900
  export declare namespace ListAgentsResponse {
2001
- /**
2002
- * @internal
2003
- */
901
+
2004
902
  const filterSensitiveLog: (obj: ListAgentsResponse) => any;
2005
903
  }
2006
904
  export declare enum LocationFilterName {
@@ -2020,755 +918,354 @@ export declare enum Operator {
2020
918
  NE = "NotEquals",
2021
919
  NOT_CONTAINS = "NotContains"
2022
920
  }
2023
- /**
2024
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>.
2025
- * For example, to retrieve all your Amazon S3 locations, you can use <code>ListLocations</code> with
2026
- * filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
2027
- */
921
+
2028
922
  export interface LocationFilter {
2029
- /**
2030
- * <p>The name of the filter being used. Each API call supports a list of filters that are available
2031
- * for it (for example, <code>LocationType</code> for <code>ListLocations</code>).</p>
2032
- */
923
+
2033
924
  Name: LocationFilterName | string | undefined;
2034
- /**
2035
- * <p>The values that you want to filter for. For example, you might want to display only Amazon S3
2036
- * locations.</p>
2037
- */
925
+
2038
926
  Values: string[] | undefined;
2039
- /**
2040
- * <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
2041
- * <code>Contains</code>). For more about API filtering operators, see
2042
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">API filters for ListTasks and ListLocations</a>.</p>
2043
- */
927
+
2044
928
  Operator: Operator | string | undefined;
2045
929
  }
2046
930
  export declare namespace LocationFilter {
2047
- /**
2048
- * @internal
2049
- */
931
+
2050
932
  const filterSensitiveLog: (obj: LocationFilter) => any;
2051
933
  }
2052
- /**
2053
- * <p>ListLocationsRequest</p>
2054
- */
934
+
2055
935
  export interface ListLocationsRequest {
2056
- /**
2057
- * <p>The maximum number of locations to return.</p>
2058
- */
936
+
2059
937
  MaxResults?: number;
2060
- /**
2061
- * <p>An opaque string that indicates the position at which to begin the next list of
2062
- * locations.</p>
2063
- */
938
+
2064
939
  NextToken?: string;
2065
- /**
2066
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>.
2067
- * For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code>
2068
- * with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
2069
- */
940
+
2070
941
  Filters?: LocationFilter[];
2071
942
  }
2072
943
  export declare namespace ListLocationsRequest {
2073
- /**
2074
- * @internal
2075
- */
944
+
2076
945
  const filterSensitiveLog: (obj: ListLocationsRequest) => any;
2077
946
  }
2078
- /**
2079
- * <p>Represents a single entry in a list of locations. <code>LocationListEntry</code>
2080
- * returns an array that contains a list of locations when the
2081
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html">ListLocations</a>
2082
- * operation is called.</p>
2083
- */
947
+
2084
948
  export interface LocationListEntry {
2085
- /**
2086
- * <p>The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon
2087
- * EFS, the location is the export path. For Amazon S3, the location is the prefix path that you
2088
- * want to mount and use as the root of the location.</p>
2089
- */
949
+
2090
950
  LocationArn?: string;
2091
- /**
2092
- * <p>Represents a list of URLs of a location. <code>LocationUri</code> returns an array that
2093
- * contains a list of locations when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html">ListLocations</a> operation is
2094
- * called.</p>
2095
- * <p>Format: <code>TYPE://GLOBAL_ID/SUBDIR</code>.</p>
2096
- * <p>TYPE designates the type of location. Valid values: NFS | EFS | S3.</p>
2097
- * <p>GLOBAL_ID is the globally unique identifier of the resource that backs the location. An
2098
- * example for EFS is <code>us-east-2.fs-abcd1234</code>. An example for Amazon S3 is the bucket
2099
- * name, such as <code>myBucket</code>. An example for NFS is a valid IPv4 address or a host name
2100
- * compliant with Domain Name Service (DNS).</p>
2101
- * <p>SUBDIR is a valid file system path, delimited by forward slashes as is the *nix
2102
- * convention. For NFS and Amazon EFS, it's the export path to mount the location. For
2103
- * Amazon S3, it's the prefix path that you mount to and treat as the root of the
2104
- * location.</p>
2105
- * <p></p>
2106
- */
951
+
2107
952
  LocationUri?: string;
2108
953
  }
2109
954
  export declare namespace LocationListEntry {
2110
- /**
2111
- * @internal
2112
- */
955
+
2113
956
  const filterSensitiveLog: (obj: LocationListEntry) => any;
2114
957
  }
2115
- /**
2116
- * <p>ListLocationsResponse</p>
2117
- */
958
+
2118
959
  export interface ListLocationsResponse {
2119
- /**
2120
- * <p>An array that contains a list of locations.</p>
2121
- */
960
+
2122
961
  Locations?: LocationListEntry[];
2123
- /**
2124
- * <p>An opaque string that indicates the position at which to begin returning the next list
2125
- * of locations.</p>
2126
- */
962
+
2127
963
  NextToken?: string;
2128
964
  }
2129
965
  export declare namespace ListLocationsResponse {
2130
- /**
2131
- * @internal
2132
- */
966
+
2133
967
  const filterSensitiveLog: (obj: ListLocationsResponse) => any;
2134
968
  }
2135
- /**
2136
- * <p>ListTagsForResourceRequest</p>
2137
- */
969
+
2138
970
  export interface ListTagsForResourceRequest {
2139
- /**
2140
- * <p>The Amazon Resource Name (ARN) of the resource whose tags to list.</p>
2141
- */
971
+
2142
972
  ResourceArn: string | undefined;
2143
- /**
2144
- * <p>The maximum number of locations to return.</p>
2145
- */
973
+
2146
974
  MaxResults?: number;
2147
- /**
2148
- * <p>An opaque string that indicates the position at which to begin the next list of
2149
- * locations.</p>
2150
- */
975
+
2151
976
  NextToken?: string;
2152
977
  }
2153
978
  export declare namespace ListTagsForResourceRequest {
2154
- /**
2155
- * @internal
2156
- */
979
+
2157
980
  const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2158
981
  }
2159
- /**
2160
- * <p>ListTagsForResourceResponse</p>
2161
- */
982
+
2162
983
  export interface ListTagsForResourceResponse {
2163
- /**
2164
- * <p>Array of resource tags.</p>
2165
- */
984
+
2166
985
  Tags?: TagListEntry[];
2167
- /**
2168
- * <p>An opaque string that indicates the position at which to begin returning the next list
2169
- * of resource tags.</p>
2170
- */
986
+
2171
987
  NextToken?: string;
2172
988
  }
2173
989
  export declare namespace ListTagsForResourceResponse {
2174
- /**
2175
- * @internal
2176
- */
990
+
2177
991
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2178
992
  }
2179
- /**
2180
- * <p>ListTaskExecutions</p>
2181
- */
993
+
2182
994
  export interface ListTaskExecutionsRequest {
2183
- /**
2184
- * <p>The Amazon Resource Name (ARN) of the task whose tasks you want to list.</p>
2185
- */
995
+
2186
996
  TaskArn?: string;
2187
- /**
2188
- * <p>The maximum number of executed tasks to list.</p>
2189
- */
997
+
2190
998
  MaxResults?: number;
2191
- /**
2192
- * <p>An opaque string that indicates the position at which to begin the next list of the
2193
- * executed tasks.</p>
2194
- */
999
+
2195
1000
  NextToken?: string;
2196
1001
  }
2197
1002
  export declare namespace ListTaskExecutionsRequest {
2198
- /**
2199
- * @internal
2200
- */
1003
+
2201
1004
  const filterSensitiveLog: (obj: ListTaskExecutionsRequest) => any;
2202
1005
  }
2203
- /**
2204
- * <p>Represents a single entry in a list of task executions.
2205
- * <code>TaskExecutionListEntry</code> returns an array that contains a list of specific
2206
- * invocations of a task when the
2207
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html">ListTaskExecutions</a>
2208
- * operation is called.</p>
2209
- */
1006
+
2210
1007
  export interface TaskExecutionListEntry {
2211
- /**
2212
- * <p>The Amazon Resource Name (ARN) of the task that was executed.</p>
2213
- */
1008
+
2214
1009
  TaskExecutionArn?: string;
2215
- /**
2216
- * <p>The status of a task execution.</p>
2217
- */
1010
+
2218
1011
  Status?: TaskExecutionStatus | string;
2219
1012
  }
2220
1013
  export declare namespace TaskExecutionListEntry {
2221
- /**
2222
- * @internal
2223
- */
1014
+
2224
1015
  const filterSensitiveLog: (obj: TaskExecutionListEntry) => any;
2225
1016
  }
2226
- /**
2227
- * <p>ListTaskExecutionsResponse</p>
2228
- */
1017
+
2229
1018
  export interface ListTaskExecutionsResponse {
2230
- /**
2231
- * <p>A list of executed tasks.</p>
2232
- */
1019
+
2233
1020
  TaskExecutions?: TaskExecutionListEntry[];
2234
- /**
2235
- * <p>An opaque string that indicates the position at which to begin returning the next list
2236
- * of executed tasks.</p>
2237
- */
1021
+
2238
1022
  NextToken?: string;
2239
1023
  }
2240
1024
  export declare namespace ListTaskExecutionsResponse {
2241
- /**
2242
- * @internal
2243
- */
1025
+
2244
1026
  const filterSensitiveLog: (obj: ListTaskExecutionsResponse) => any;
2245
1027
  }
2246
1028
  export declare enum TaskFilterName {
2247
1029
  CreationTime = "CreationTime",
2248
1030
  LocationId = "LocationId"
2249
1031
  }
2250
- /**
2251
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListTasks</code>.
2252
- * For example, to retrieve all tasks on a source location, you can use <code>ListTasks</code>
2253
- * with filter name <code>LocationId</code> and <code>Operator Equals</code> with the ARN for the
2254
- * location.</p>
2255
- */
1032
+
2256
1033
  export interface TaskFilter {
2257
- /**
2258
- * <p>The name of the filter being used. Each API call supports a list of filters that are available
2259
- * for it. For example, <code>LocationId</code> for <code>ListTasks</code>.</p>
2260
- */
1034
+
2261
1035
  Name: TaskFilterName | string | undefined;
2262
- /**
2263
- * <p>The values that you want to filter for. For example, you might want to display only tasks
2264
- * for a specific destination location.</p>
2265
- */
1036
+
2266
1037
  Values: string[] | undefined;
2267
- /**
2268
- * <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
2269
- * <code>Contains</code>). For more about API filtering operators, see
2270
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html">API filters for ListTasks and ListLocations</a>.</p>
2271
- */
1038
+
2272
1039
  Operator: Operator | string | undefined;
2273
1040
  }
2274
1041
  export declare namespace TaskFilter {
2275
- /**
2276
- * @internal
2277
- */
1042
+
2278
1043
  const filterSensitiveLog: (obj: TaskFilter) => any;
2279
1044
  }
2280
- /**
2281
- * <p>ListTasksRequest</p>
2282
- */
1045
+
2283
1046
  export interface ListTasksRequest {
2284
- /**
2285
- * <p>The maximum number of tasks to return.</p>
2286
- */
1047
+
2287
1048
  MaxResults?: number;
2288
- /**
2289
- * <p>An opaque string that indicates the position at which to begin the next list of
2290
- * tasks.</p>
2291
- */
1049
+
2292
1050
  NextToken?: string;
2293
- /**
2294
- * <p>You can use API filters to narrow down the list of resources returned by <code>ListTasks</code>.
2295
- * For example, to retrieve all tasks on a specific source location, you can use <code>ListTasks</code>
2296
- * with filter name <code>LocationId</code> and <code>Operator Equals</code> with the ARN for the
2297
- * location.</p>
2298
- */
1051
+
2299
1052
  Filters?: TaskFilter[];
2300
1053
  }
2301
1054
  export declare namespace ListTasksRequest {
2302
- /**
2303
- * @internal
2304
- */
1055
+
2305
1056
  const filterSensitiveLog: (obj: ListTasksRequest) => any;
2306
1057
  }
2307
- /**
2308
- * <p>Represents a single entry in a list of tasks. <code>TaskListEntry</code> returns an
2309
- * array that contains a list of tasks when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html">ListTasks</a> operation is called.
2310
- * A task includes the source and destination file systems to sync and the options to use for the
2311
- * tasks.</p>
2312
- */
1058
+
2313
1059
  export interface TaskListEntry {
2314
- /**
2315
- * <p>The Amazon Resource Name (ARN) of the task.</p>
2316
- */
1060
+
2317
1061
  TaskArn?: string;
2318
- /**
2319
- * <p>The status of the task.</p>
2320
- */
1062
+
2321
1063
  Status?: TaskStatus | string;
2322
- /**
2323
- * <p>The name of the task.</p>
2324
- */
1064
+
2325
1065
  Name?: string;
2326
1066
  }
2327
1067
  export declare namespace TaskListEntry {
2328
- /**
2329
- * @internal
2330
- */
1068
+
2331
1069
  const filterSensitiveLog: (obj: TaskListEntry) => any;
2332
1070
  }
2333
- /**
2334
- * <p>ListTasksResponse</p>
2335
- */
1071
+
2336
1072
  export interface ListTasksResponse {
2337
- /**
2338
- * <p>A list of all the tasks that are returned.</p>
2339
- */
1073
+
2340
1074
  Tasks?: TaskListEntry[];
2341
- /**
2342
- * <p>An opaque string that indicates the position at which to begin returning the next list
2343
- * of tasks.</p>
2344
- */
1075
+
2345
1076
  NextToken?: string;
2346
1077
  }
2347
1078
  export declare namespace ListTasksResponse {
2348
- /**
2349
- * @internal
2350
- */
1079
+
2351
1080
  const filterSensitiveLog: (obj: ListTasksResponse) => any;
2352
1081
  }
2353
- /**
2354
- * <p>StartTaskExecutionRequest</p>
2355
- */
1082
+
2356
1083
  export interface StartTaskExecutionRequest {
2357
- /**
2358
- * <p>The Amazon Resource Name (ARN) of the task to start.</p>
2359
- */
1084
+
2360
1085
  TaskArn: string | undefined;
2361
- /**
2362
- * <p>Represents the options that are available to control the behavior of a
2363
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
2364
- * operation. Behavior includes preserving metadata such as user
2365
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
2366
- * data integrity verification, and so on.</p>
2367
- * <p>A task has a set of default options associated with it. If you don't specify an option
2368
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
2369
- * the default value is used. You can override the
2370
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
2371
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2372
- */
1086
+
2373
1087
  OverrideOptions?: Options;
2374
- /**
2375
- * <p>A list of filter rules that determines which files to include when running a task. The
2376
- * pattern should contain a single filter string that consists of the patterns to include. The
2377
- * patterns are delimited by "|" (that is, a pipe). For example: <code>"/folder1|/folder2"</code>
2378
- * </p>
2379
- *
2380
- * <p>
2381
- * </p>
2382
- */
1088
+
2383
1089
  Includes?: FilterRule[];
2384
- /**
2385
- * <p>A list of filter rules that determines which files to exclude from a task. The list
2386
- * should contain a single filter string that consists of the patterns to exclude. The
2387
- * patterns are delimited by "|" (that is, a pipe), for example,
2388
- * <code>"/folder1|/folder2"</code>. </p>
2389
- */
1090
+
2390
1091
  Excludes?: FilterRule[];
2391
1092
  }
2392
1093
  export declare namespace StartTaskExecutionRequest {
2393
- /**
2394
- * @internal
2395
- */
1094
+
2396
1095
  const filterSensitiveLog: (obj: StartTaskExecutionRequest) => any;
2397
1096
  }
2398
- /**
2399
- * <p>StartTaskExecutionResponse</p>
2400
- */
1097
+
2401
1098
  export interface StartTaskExecutionResponse {
2402
- /**
2403
- * <p>The Amazon Resource Name (ARN) of the specific task execution that was
2404
- * started.</p>
2405
- */
1099
+
2406
1100
  TaskExecutionArn?: string;
2407
1101
  }
2408
1102
  export declare namespace StartTaskExecutionResponse {
2409
- /**
2410
- * @internal
2411
- */
1103
+
2412
1104
  const filterSensitiveLog: (obj: StartTaskExecutionResponse) => any;
2413
1105
  }
2414
- /**
2415
- * <p>TagResourceRequest</p>
2416
- */
1106
+
2417
1107
  export interface TagResourceRequest {
2418
- /**
2419
- * <p>The Amazon Resource Name (ARN) of the resource to apply the tag to.</p>
2420
- */
1108
+
2421
1109
  ResourceArn: string | undefined;
2422
- /**
2423
- * <p>The tags to apply.</p>
2424
- */
1110
+
2425
1111
  Tags: TagListEntry[] | undefined;
2426
1112
  }
2427
1113
  export declare namespace TagResourceRequest {
2428
- /**
2429
- * @internal
2430
- */
1114
+
2431
1115
  const filterSensitiveLog: (obj: TagResourceRequest) => any;
2432
1116
  }
2433
1117
  export interface TagResourceResponse {
2434
1118
  }
2435
1119
  export declare namespace TagResourceResponse {
2436
- /**
2437
- * @internal
2438
- */
1120
+
2439
1121
  const filterSensitiveLog: (obj: TagResourceResponse) => any;
2440
1122
  }
2441
- /**
2442
- * <p>UntagResourceRequest</p>
2443
- */
1123
+
2444
1124
  export interface UntagResourceRequest {
2445
- /**
2446
- * <p>The Amazon Resource Name (ARN) of the resource to remove the tag from.</p>
2447
- */
1125
+
2448
1126
  ResourceArn: string | undefined;
2449
- /**
2450
- * <p>The keys in the key-value pair in the tag to remove.</p>
2451
- */
1127
+
2452
1128
  Keys: string[] | undefined;
2453
1129
  }
2454
1130
  export declare namespace UntagResourceRequest {
2455
- /**
2456
- * @internal
2457
- */
1131
+
2458
1132
  const filterSensitiveLog: (obj: UntagResourceRequest) => any;
2459
1133
  }
2460
1134
  export interface UntagResourceResponse {
2461
1135
  }
2462
1136
  export declare namespace UntagResourceResponse {
2463
- /**
2464
- * @internal
2465
- */
1137
+
2466
1138
  const filterSensitiveLog: (obj: UntagResourceResponse) => any;
2467
1139
  }
2468
- /**
2469
- * <p>UpdateAgentRequest</p>
2470
- */
1140
+
2471
1141
  export interface UpdateAgentRequest {
2472
- /**
2473
- * <p>The Amazon Resource Name (ARN) of the agent to update.</p>
2474
- */
1142
+
2475
1143
  AgentArn: string | undefined;
2476
- /**
2477
- * <p>The name that you want to use to configure the agent.</p>
2478
- */
1144
+
2479
1145
  Name?: string;
2480
1146
  }
2481
1147
  export declare namespace UpdateAgentRequest {
2482
- /**
2483
- * @internal
2484
- */
1148
+
2485
1149
  const filterSensitiveLog: (obj: UpdateAgentRequest) => any;
2486
1150
  }
2487
1151
  export interface UpdateAgentResponse {
2488
1152
  }
2489
1153
  export declare namespace UpdateAgentResponse {
2490
- /**
2491
- * @internal
2492
- */
1154
+
2493
1155
  const filterSensitiveLog: (obj: UpdateAgentResponse) => any;
2494
1156
  }
2495
1157
  export interface UpdateLocationNfsRequest {
2496
- /**
2497
- * <p>The Amazon Resource Name (ARN) of the NFS location to update.</p>
2498
- */
1158
+
2499
1159
  LocationArn: string | undefined;
2500
- /**
2501
- * <p>The subdirectory in the NFS file system that is used to read data from the NFS source
2502
- * location or write data to the NFS destination. The NFS path should be a path that's
2503
- * exported by the NFS server, or a subdirectory of that path. The path should be such that it
2504
- * can be mounted by other NFS clients in your network.</p>
2505
- *
2506
- * <p>To see all the paths exported by your NFS server, run "<code>showmount -e
2507
- * nfs-server-name</code>" from an NFS client that has access to your server. You can specify
2508
- * any directory that appears in the results, and any subdirectory of that directory. Ensure that
2509
- * the NFS export is accessible without Kerberos authentication. </p>
2510
- * <p>To transfer all the data in the folder that you specified, DataSync must have
2511
- * permissions to read all the data. To ensure this, either configure the NFS export with
2512
- * <code>no_root_squash</code>, or ensure that the files you want DataSync to
2513
- * access have permissions that allow read access for all users. Doing either option enables the
2514
- * agent to read the files. For the agent to access directories, you must additionally enable all
2515
- * execute access.</p>
2516
- * <p>If you are copying data to or from your Snowcone device, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone">NFS Server on Snowcone</a> for more information.</p>
2517
- *
2518
- * <p>For information about NFS export configuration, see 18.7. The /etc/exports
2519
- * Configuration File in the Red Hat Enterprise Linux documentation.</p>
2520
- */
1160
+
2521
1161
  Subdirectory?: string;
2522
- /**
2523
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
2524
- * location.</p>
2525
- */
1162
+
2526
1163
  OnPremConfig?: OnPremConfig;
2527
- /**
2528
- * <p>Represents the mount options that are available for DataSync to access an NFS
2529
- * location.</p>
2530
- */
1164
+
2531
1165
  MountOptions?: NfsMountOptions;
2532
1166
  }
2533
1167
  export declare namespace UpdateLocationNfsRequest {
2534
- /**
2535
- * @internal
2536
- */
1168
+
2537
1169
  const filterSensitiveLog: (obj: UpdateLocationNfsRequest) => any;
2538
1170
  }
2539
1171
  export interface UpdateLocationNfsResponse {
2540
1172
  }
2541
1173
  export declare namespace UpdateLocationNfsResponse {
2542
- /**
2543
- * @internal
2544
- */
1174
+
2545
1175
  const filterSensitiveLog: (obj: UpdateLocationNfsResponse) => any;
2546
1176
  }
2547
1177
  export interface UpdateLocationObjectStorageRequest {
2548
- /**
2549
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.</p>
2550
- */
1178
+
2551
1179
  LocationArn: string | undefined;
2552
- /**
2553
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
2554
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can
2555
- * specify a custom port if your self-managed object storage server requires one.</p>
2556
- */
1180
+
2557
1181
  ServerPort?: number;
2558
- /**
2559
- * <p>The protocol that the object storage server uses to communicate. Valid values are
2560
- * <code>HTTP</code> or <code>HTTPS</code>.</p>
2561
- */
1182
+
2562
1183
  ServerProtocol?: ObjectStorageServerProtocol | string;
2563
- /**
2564
- * <p>The subdirectory in the self-managed object storage server that is used
2565
- * to read data from.</p>
2566
- */
1184
+
2567
1185
  Subdirectory?: string;
2568
- /**
2569
- * <p>Optional. The access key is used if credentials are required to access the self-managed
2570
- * object storage server. If your object storage requires a user name and password to
2571
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
2572
- * and password, respectively.</p>
2573
- */
1186
+
2574
1187
  AccessKey?: string;
2575
- /**
2576
- * <p>Optional. The secret key is used if credentials are required to access the self-managed
2577
- * object storage server. If your object storage requires a user name and password to
2578
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
2579
- * and password, respectively.</p>
2580
- */
1188
+
2581
1189
  SecretKey?: string;
2582
- /**
2583
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
2584
- * self-managed object storage server location.</p>
2585
- */
1190
+
2586
1191
  AgentArns?: string[];
2587
1192
  }
2588
1193
  export declare namespace UpdateLocationObjectStorageRequest {
2589
- /**
2590
- * @internal
2591
- */
1194
+
2592
1195
  const filterSensitiveLog: (obj: UpdateLocationObjectStorageRequest) => any;
2593
1196
  }
2594
1197
  export interface UpdateLocationObjectStorageResponse {
2595
1198
  }
2596
1199
  export declare namespace UpdateLocationObjectStorageResponse {
2597
- /**
2598
- * @internal
2599
- */
1200
+
2600
1201
  const filterSensitiveLog: (obj: UpdateLocationObjectStorageResponse) => any;
2601
1202
  }
2602
1203
  export interface UpdateLocationSmbRequest {
2603
- /**
2604
- * <p>The Amazon Resource Name (ARN) of the SMB location to update.</p>
2605
- */
1204
+
2606
1205
  LocationArn: string | undefined;
2607
- /**
2608
- * <p>The subdirectory in the SMB file system that is used to read data from the SMB source
2609
- * location or write data to the SMB destination. The SMB path should be a path that's
2610
- * exported by the SMB server, or a subdirectory of that path. The path should be such that it
2611
- * can be mounted by other SMB clients in your network.</p>
2612
- * <note>
2613
- * <p>
2614
- * <code>Subdirectory</code> must be specified with forward slashes. For example,
2615
- * <code>/path/to/folder</code>.</p>
2616
- * </note>
2617
- *
2618
- * <p>To transfer all the data in the folder that you specified, DataSync must have
2619
- * permissions to mount the SMB share and to access all the data in that share. To ensure this,
2620
- * do either of the following:</p>
2621
- * <ul>
2622
- * <li>
2623
- * <p>Ensure that the user/password specified belongs to the user who can mount the share
2624
- * and who has the appropriate permissions for all of the files and directories that you want
2625
- * DataSync to access.</p>
2626
- * </li>
2627
- * <li>
2628
- * <p>Use credentials of a member of the Backup Operators group to mount the share. </p>
2629
- * </li>
2630
- * </ul>
2631
- * <p>Doing either of these options enables the agent to access the data. For the agent to
2632
- * access directories, you must also enable all execute access.</p>
2633
- */
1206
+
2634
1207
  Subdirectory?: string;
2635
- /**
2636
- * <p>The user who can mount the share has the permissions to access files and folders in the
2637
- * SMB share.</p>
2638
- */
1208
+
2639
1209
  User?: string;
2640
- /**
2641
- * <p>The name of the Windows domain that the SMB server belongs to.</p>
2642
- */
1210
+
2643
1211
  Domain?: string;
2644
- /**
2645
- * <p>The password of the user who can mount the share has the permissions to access files and
2646
- * folders in the SMB share.</p>
2647
- */
1212
+
2648
1213
  Password?: string;
2649
- /**
2650
- * <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)
2651
- * location.</p>
2652
- */
1214
+
2653
1215
  AgentArns?: string[];
2654
- /**
2655
- * <p>Represents the mount options that are available for DataSync to access an SMB
2656
- * location.</p>
2657
- */
1216
+
2658
1217
  MountOptions?: SmbMountOptions;
2659
1218
  }
2660
1219
  export declare namespace UpdateLocationSmbRequest {
2661
- /**
2662
- * @internal
2663
- */
1220
+
2664
1221
  const filterSensitiveLog: (obj: UpdateLocationSmbRequest) => any;
2665
1222
  }
2666
1223
  export interface UpdateLocationSmbResponse {
2667
1224
  }
2668
1225
  export declare namespace UpdateLocationSmbResponse {
2669
- /**
2670
- * @internal
2671
- */
1226
+
2672
1227
  const filterSensitiveLog: (obj: UpdateLocationSmbResponse) => any;
2673
1228
  }
2674
- /**
2675
- * <p>UpdateTaskResponse</p>
2676
- */
1229
+
2677
1230
  export interface UpdateTaskRequest {
2678
- /**
2679
- * <p>The Amazon Resource Name (ARN) of the resource name of the task to update.</p>
2680
- */
1231
+
2681
1232
  TaskArn: string | undefined;
2682
- /**
2683
- * <p>Represents the options that are available to control the behavior of a
2684
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
2685
- * operation. Behavior includes preserving metadata such as user
2686
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
2687
- * data integrity verification, and so on.</p>
2688
- * <p>A task has a set of default options associated with it. If you don't specify an option
2689
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
2690
- * the default value is used. You can override the
2691
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
2692
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2693
- */
1233
+
2694
1234
  Options?: Options;
2695
- /**
2696
- * <p>A list of filter rules that determines which files to exclude from a task. The list should
2697
- * contain a single filter string that consists of the patterns to exclude. The patterns are
2698
- * delimited by "|" (that is, a pipe), for example: <code>"/folder1|/folder2"</code>
2699
- * </p>
2700
- * <p>
2701
- * </p>
2702
- */
1235
+
2703
1236
  Excludes?: FilterRule[];
2704
- /**
2705
- * <p>Specifies a schedule used to periodically transfer files from a source to a destination
2706
- * location. You can configure your task to execute hourly, daily, weekly or on specific days of
2707
- * the week. You control when in the day or hour you want the task to execute. The time you
2708
- * 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>
2709
- */
1237
+
2710
1238
  Schedule?: TaskSchedule;
2711
- /**
2712
- * <p>The name of the task to update.</p>
2713
- */
1239
+
2714
1240
  Name?: string;
2715
- /**
2716
- * <p>The Amazon Resource Name (ARN) of the resource name of the CloudWatch
2717
- * LogGroup.</p>
2718
- */
1241
+
2719
1242
  CloudWatchLogGroupArn?: string;
2720
- /**
2721
- * <p>A list of filter rules that determines which files to include when running a task. The
2722
- * pattern should contain a single filter string that consists of the patterns to include. The
2723
- * patterns are delimited by "|" (that is, a pipe). For example:
2724
- * <code>"/folder1|/folder2</code>"</p>
2725
- */
1243
+
2726
1244
  Includes?: FilterRule[];
2727
1245
  }
2728
1246
  export declare namespace UpdateTaskRequest {
2729
- /**
2730
- * @internal
2731
- */
1247
+
2732
1248
  const filterSensitiveLog: (obj: UpdateTaskRequest) => any;
2733
1249
  }
2734
1250
  export interface UpdateTaskResponse {
2735
1251
  }
2736
1252
  export declare namespace UpdateTaskResponse {
2737
- /**
2738
- * @internal
2739
- */
1253
+
2740
1254
  const filterSensitiveLog: (obj: UpdateTaskResponse) => any;
2741
1255
  }
2742
1256
  export interface UpdateTaskExecutionRequest {
2743
- /**
2744
- * <p>The Amazon Resource Name (ARN) of the specific task execution that is being updated. </p>
2745
- */
1257
+
2746
1258
  TaskExecutionArn: string | undefined;
2747
- /**
2748
- * <p>Represents the options that are available to control the behavior of a
2749
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>
2750
- * operation. Behavior includes preserving metadata such as user
2751
- * ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,
2752
- * data integrity verification, and so on.</p>
2753
- * <p>A task has a set of default options associated with it. If you don't specify an option
2754
- * in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>,
2755
- * the default value is used. You can override the
2756
- * defaults options on each task execution by specifying an overriding <code>Options</code> value
2757
- * to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p>
2758
- */
1259
+
2759
1260
  Options: Options | undefined;
2760
1261
  }
2761
1262
  export declare namespace UpdateTaskExecutionRequest {
2762
- /**
2763
- * @internal
2764
- */
1263
+
2765
1264
  const filterSensitiveLog: (obj: UpdateTaskExecutionRequest) => any;
2766
1265
  }
2767
1266
  export interface UpdateTaskExecutionResponse {
2768
1267
  }
2769
1268
  export declare namespace UpdateTaskExecutionResponse {
2770
- /**
2771
- * @internal
2772
- */
1269
+
2773
1270
  const filterSensitiveLog: (obj: UpdateTaskExecutionResponse) => any;
2774
1271
  }