@aws-sdk/client-datasync 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,10 +10,12 @@ import { DataSyncServiceException as __BaseException } from "./DataSyncServiceEx
10
10
  */
11
11
  export interface Credentials {
12
12
  /**
13
+ * @public
13
14
  * <p>Specifies the user name for your storage system's management interface.</p>
14
15
  */
15
16
  Username: string | undefined;
16
17
  /**
18
+ * @public
17
19
  * <p>Specifies the password for your storage system's management interface.</p>
18
20
  */
19
21
  Password: string | undefined;
@@ -25,10 +27,12 @@ export interface Credentials {
25
27
  */
26
28
  export interface DiscoveryServerConfiguration {
27
29
  /**
30
+ * @public
28
31
  * <p>The domain name or IP address of your storage system's management interface.</p>
29
32
  */
30
33
  ServerHostname: string | undefined;
31
34
  /**
35
+ * @public
32
36
  * <p>The network port for accessing the storage system's management interface.</p>
33
37
  */
34
38
  ServerPort?: number;
@@ -51,10 +55,12 @@ export type DiscoverySystemType = (typeof DiscoverySystemType)[keyof typeof Disc
51
55
  */
52
56
  export interface TagListEntry {
53
57
  /**
58
+ * @public
54
59
  * <p>The key for an Amazon Web Services resource tag.</p>
55
60
  */
56
61
  Key: string | undefined;
57
62
  /**
63
+ * @public
58
64
  * <p>The value for an Amazon Web Services resource tag.</p>
59
65
  */
60
66
  Value?: string;
@@ -64,11 +70,13 @@ export interface TagListEntry {
64
70
  */
65
71
  export interface AddStorageSystemRequest {
66
72
  /**
73
+ * @public
67
74
  * <p>Specifies the server name and network port required to connect with the management
68
75
  * interface of your on-premises storage system.</p>
69
76
  */
70
77
  ServerConfiguration: DiscoveryServerConfiguration | undefined;
71
78
  /**
79
+ * @public
72
80
  * <p>Specifies the type of on-premises storage system that you want DataSync Discovery to collect
73
81
  * information about.</p>
74
82
  * <note>
@@ -80,33 +88,39 @@ export interface AddStorageSystemRequest {
80
88
  */
81
89
  SystemType: DiscoverySystemType | string | undefined;
82
90
  /**
91
+ * @public
83
92
  * <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to
84
93
  * and reads from your on-premises storage system's management interface. You can only specify
85
94
  * one ARN.</p>
86
95
  */
87
96
  AgentArns: string[] | undefined;
88
97
  /**
98
+ * @public
89
99
  * <p>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging
90
100
  * discovery job events.</p>
91
101
  */
92
102
  CloudWatchLogGroupArn?: string;
93
103
  /**
104
+ * @public
94
105
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
95
106
  * resources. We recommend creating at least a name tag for your on-premises storage
96
107
  * system.</p>
97
108
  */
98
109
  Tags?: TagListEntry[];
99
110
  /**
111
+ * @public
100
112
  * <p>Specifies a familiar name for your on-premises storage system.</p>
101
113
  */
102
114
  Name?: string;
103
115
  /**
116
+ * @public
104
117
  * <p>Specifies a client token to make sure requests with this API operation are idempotent. If
105
118
  * you don't specify a client token, DataSync generates one for you
106
119
  * automatically.</p>
107
120
  */
108
121
  ClientToken?: string;
109
122
  /**
123
+ * @public
110
124
  * <p>Specifies the user name and password for accessing your on-premises storage system's
111
125
  * management interface.</p>
112
126
  */
@@ -117,6 +131,7 @@ export interface AddStorageSystemRequest {
117
131
  */
118
132
  export interface AddStorageSystemResponse {
119
133
  /**
134
+ * @public
120
135
  * <p>The ARN of the on-premises storage system that you can use with DataSync Discovery.</p>
121
136
  */
122
137
  StorageSystemArn: string | undefined;
@@ -168,14 +183,17 @@ export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
168
183
  */
169
184
  export interface AgentListEntry {
170
185
  /**
186
+ * @public
171
187
  * <p>The Amazon Resource Name (ARN) of a DataSync agent.</p>
172
188
  */
173
189
  AgentArn?: string;
174
190
  /**
191
+ * @public
175
192
  * <p>The name of an agent.</p>
176
193
  */
177
194
  Name?: string;
178
195
  /**
196
+ * @public
179
197
  * <p>The status of an agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/understand-agent-statuses.html">DataSync agent
180
198
  * statuses</a>.</p>
181
199
  */
@@ -225,6 +243,7 @@ export type AzureBlobAuthenticationType = (typeof AzureBlobAuthenticationType)[k
225
243
  */
226
244
  export interface AzureBlobSasConfiguration {
227
245
  /**
246
+ * @public
228
247
  * <p>Specifies a SAS token that provides permissions at the Azure storage account, container,
229
248
  * or folder level.</p>
230
249
  * <p>The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:</p>
@@ -251,6 +270,7 @@ export type AzureBlobType = (typeof AzureBlobType)[keyof typeof AzureBlobType];
251
270
  */
252
271
  export interface CancelTaskExecutionRequest {
253
272
  /**
273
+ * @public
254
274
  * <p>The Amazon Resource Name (ARN) of the task execution to stop.</p>
255
275
  */
256
276
  TaskExecutionArn: string | undefined;
@@ -267,18 +287,26 @@ export interface CancelTaskExecutionResponse {
267
287
  */
268
288
  export interface Capacity {
269
289
  /**
290
+ * @public
270
291
  * <p>The amount of space that's being used in a storage system resource.</p>
271
292
  */
272
293
  Used?: number;
273
294
  /**
295
+ * @public
274
296
  * <p>The total amount of space available in a storage system resource.</p>
275
297
  */
276
298
  Provisioned?: number;
277
299
  /**
300
+ * @public
278
301
  * <p>The amount of space that's being used in a storage system resource without accounting for
279
302
  * compression or deduplication.</p>
280
303
  */
281
304
  LogicalUsed?: number;
305
+ /**
306
+ * @public
307
+ * <p>The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).</p>
308
+ */
309
+ ClusterCloudStorageUsed?: number;
282
310
  }
283
311
  /**
284
312
  * @public
@@ -286,21 +314,25 @@ export interface Capacity {
286
314
  */
287
315
  export interface CreateAgentRequest {
288
316
  /**
317
+ * @public
289
318
  * <p>Specifies your DataSync agent's activation key. If you don't have an
290
319
  * activation key, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">Activate your agent</a>.</p>
291
320
  */
292
321
  ActivationKey: string | undefined;
293
322
  /**
323
+ * @public
294
324
  * <p>Specifies a name for your agent. You can see this name in the DataSync
295
325
  * console.</p>
296
326
  */
297
327
  AgentName?: string;
298
328
  /**
329
+ * @public
299
330
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
300
331
  * We recommend creating at least one tag for your agent.</p>
301
332
  */
302
333
  Tags?: TagListEntry[];
303
334
  /**
335
+ * @public
304
336
  * <p>Specifies the ID of the VPC endpoint that you want your agent to connect to. For example,
305
337
  * a VPC endpoint ID looks like <code>vpce-01234d5aff67890e1</code>.</p>
306
338
  * <important>
@@ -310,6 +342,7 @@ export interface CreateAgentRequest {
310
342
  */
311
343
  VpcEndpointId?: string;
312
344
  /**
345
+ * @public
313
346
  * <p>Specifies the ARN of the subnet where you want to run your DataSync task when
314
347
  * using a VPC endpoint. This is the subnet where DataSync creates and manages the
315
348
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network
@@ -317,6 +350,7 @@ export interface CreateAgentRequest {
317
350
  */
318
351
  SubnetArns?: string[];
319
352
  /**
353
+ * @public
320
354
  * <p>Specifies the Amazon Resource Name (ARN) of the security group that protects your task's
321
355
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network
322
356
  * interfaces</a> when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc">using a virtual private cloud (VPC) endpoint</a>. You can only specify one ARN.</p>
@@ -329,6 +363,7 @@ export interface CreateAgentRequest {
329
363
  */
330
364
  export interface CreateAgentResponse {
331
365
  /**
366
+ * @public
332
367
  * <p>The ARN of the agent that you just activated. Use the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html">ListAgents</a> operation to return a
333
368
  * list of agents in your Amazon Web Services account and Amazon Web Services Region.</p>
334
369
  */
@@ -339,39 +374,47 @@ export interface CreateAgentResponse {
339
374
  */
340
375
  export interface CreateLocationAzureBlobRequest {
341
376
  /**
377
+ * @public
342
378
  * <p>Specifies the URL of the Azure Blob Storage container involved in your transfer.</p>
343
379
  */
344
380
  ContainerUrl: string | undefined;
345
381
  /**
382
+ * @public
346
383
  * <p>Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).</p>
347
384
  */
348
385
  AuthenticationType: AzureBlobAuthenticationType | string | undefined;
349
386
  /**
387
+ * @public
350
388
  * <p>Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.</p>
351
389
  */
352
390
  SasConfiguration?: AzureBlobSasConfiguration;
353
391
  /**
392
+ * @public
354
393
  * <p>Specifies the type of blob that you want your objects or files to be when transferring
355
394
  * them into Azure Blob Storage. Currently, DataSync only supports moving data into
356
395
  * Azure Blob Storage as block blobs. For more information on blob types, see the <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs">Azure Blob Storage documentation</a>.</p>
357
396
  */
358
397
  BlobType?: AzureBlobType | string;
359
398
  /**
399
+ * @public
360
400
  * <p>Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">Access tiers</a>.</p>
361
401
  */
362
402
  AccessTier?: AzureAccessTier | string;
363
403
  /**
404
+ * @public
364
405
  * <p>Specifies path segments if you want to limit your transfer to a virtual directory in your
365
406
  * container (for example, <code>/my/images</code>).</p>
366
407
  */
367
408
  Subdirectory?: string;
368
409
  /**
410
+ * @public
369
411
  * <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.</p>
370
412
  * <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html">Using multiple
371
413
  * agents for your transfer</a>.</p>
372
414
  */
373
415
  AgentArns: string[] | undefined;
374
416
  /**
417
+ * @public
375
418
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.</p>
376
419
  */
377
420
  Tags?: TagListEntry[];
@@ -381,6 +424,7 @@ export interface CreateLocationAzureBlobRequest {
381
424
  */
382
425
  export interface CreateLocationAzureBlobResponse {
383
426
  /**
427
+ * @public
384
428
  * <p>The ARN of the Azure Blob Storage transfer location that you created.</p>
385
429
  */
386
430
  LocationArn?: string;
@@ -391,6 +435,7 @@ export interface CreateLocationAzureBlobResponse {
391
435
  */
392
436
  export interface Ec2Config {
393
437
  /**
438
+ * @public
394
439
  * <p>Specifies the ARN of a subnet where DataSync creates the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> for managing traffic during your transfer.</p>
395
440
  * <p>The subnet must be located:</p>
396
441
  * <ul>
@@ -408,6 +453,7 @@ export interface Ec2Config {
408
453
  */
409
454
  SubnetArn: string | undefined;
410
455
  /**
456
+ * @public
411
457
  * <p>Specifies the Amazon Resource Names (ARNs) of the security groups associated with an
412
458
  * Amazon EFS file system's mount target.</p>
413
459
  */
@@ -431,6 +477,7 @@ export type EfsInTransitEncryption = (typeof EfsInTransitEncryption)[keyof typeo
431
477
  */
432
478
  export interface CreateLocationEfsRequest {
433
479
  /**
480
+ * @public
434
481
  * <p>Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location).
435
482
  * By default, DataSync uses the root directory, but you can also include
436
483
  * subdirectories.</p>
@@ -441,30 +488,36 @@ export interface CreateLocationEfsRequest {
441
488
  */
442
489
  Subdirectory?: string;
443
490
  /**
491
+ * @public
444
492
  * <p>Specifies the ARN for the Amazon EFS file system.</p>
445
493
  */
446
494
  EfsFilesystemArn: string | undefined;
447
495
  /**
496
+ * @public
448
497
  * <p>Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.</p>
449
498
  */
450
499
  Ec2Config: Ec2Config | undefined;
451
500
  /**
501
+ * @public
452
502
  * <p>Specifies the key-value pair that represents a tag that you want to add to the
453
503
  * resource. The value can be an empty string. This value helps you manage, filter, and search
454
504
  * for your resources. We recommend that you create a name tag for your location.</p>
455
505
  */
456
506
  Tags?: TagListEntry[];
457
507
  /**
508
+ * @public
458
509
  * <p>Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses
459
510
  * to access the Amazon EFS file system.</p>
460
511
  */
461
512
  AccessPointArn?: string;
462
513
  /**
514
+ * @public
463
515
  * <p>Specifies an Identity and Access Management (IAM) role that DataSync
464
516
  * assumes when mounting the Amazon EFS file system.</p>
465
517
  */
466
518
  FileSystemAccessRoleArn?: string;
467
519
  /**
520
+ * @public
468
521
  * <p>Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2
469
522
  * encryption when it copies data to or from the Amazon EFS file system.</p>
470
523
  * <p>If you specify an access point using <code>AccessPointArn</code> or an IAM
@@ -479,6 +532,7 @@ export interface CreateLocationEfsRequest {
479
532
  */
480
533
  export interface CreateLocationEfsResponse {
481
534
  /**
535
+ * @public
482
536
  * <p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that you
483
537
  * create.</p>
484
538
  */
@@ -489,21 +543,25 @@ export interface CreateLocationEfsResponse {
489
543
  */
490
544
  export interface CreateLocationFsxLustreRequest {
491
545
  /**
546
+ * @public
492
547
  * <p>The Amazon Resource Name (ARN) for the FSx for Lustre file system.</p>
493
548
  */
494
549
  FsxFilesystemArn: string | undefined;
495
550
  /**
551
+ * @public
496
552
  * <p>The Amazon Resource Names (ARNs) of the security groups that are used to configure the
497
553
  * FSx for Lustre file system.</p>
498
554
  */
499
555
  SecurityGroupArns: string[] | undefined;
500
556
  /**
557
+ * @public
501
558
  * <p>A subdirectory in the location's path. This subdirectory in the FSx for Lustre
502
559
  * file system is used to read data from the FSx for Lustre source location or write
503
560
  * data to the FSx for Lustre destination.</p>
504
561
  */
505
562
  Subdirectory?: string;
506
563
  /**
564
+ * @public
507
565
  * <p>The key-value pair that represents a tag that you want to add to the resource. The value
508
566
  * can be an empty string. This value helps you manage, filter, and search for your resources. We
509
567
  * recommend that you create a name tag for your location.</p>
@@ -515,6 +573,7 @@ export interface CreateLocationFsxLustreRequest {
515
573
  */
516
574
  export interface CreateLocationFsxLustreResponse {
517
575
  /**
576
+ * @public
518
577
  * <p>The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's
519
578
  * created. </p>
520
579
  */
@@ -540,6 +599,7 @@ export type NfsVersion = (typeof NfsVersion)[keyof typeof NfsVersion];
540
599
  */
541
600
  export interface NfsMountOptions {
542
601
  /**
602
+ * @public
543
603
  * <p>Specifies the NFS version that you want DataSync to use when mounting your NFS
544
604
  * share. If the server refuses to use the version specified, the task fails.</p>
545
605
  * <p>You can specify the following options:</p>
@@ -579,6 +639,7 @@ export interface NfsMountOptions {
579
639
  */
580
640
  export interface FsxProtocolNfs {
581
641
  /**
642
+ * @public
582
643
  * <p>Specifies how DataSync can access a location using the NFS protocol.</p>
583
644
  */
584
645
  MountOptions?: NfsMountOptions;
@@ -604,6 +665,7 @@ export type SmbVersion = (typeof SmbVersion)[keyof typeof SmbVersion];
604
665
  */
605
666
  export interface SmbMountOptions {
606
667
  /**
668
+ * @public
607
669
  * <p>By default, DataSync automatically chooses an SMB protocol version based on
608
670
  * negotiation with your SMB file server. You also can configure DataSync to use a
609
671
  * specific SMB version, but we recommend doing this only if DataSync has trouble
@@ -650,19 +712,23 @@ export interface SmbMountOptions {
650
712
  */
651
713
  export interface FsxProtocolSmb {
652
714
  /**
715
+ * @public
653
716
  * <p>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that
654
717
  * your storage virtual machine (SVM) belongs to.</p>
655
718
  */
656
719
  Domain?: string;
657
720
  /**
721
+ * @public
658
722
  * <p>Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.</p>
659
723
  */
660
724
  MountOptions?: SmbMountOptions;
661
725
  /**
726
+ * @public
662
727
  * <p>Specifies the password of a user who has permission to access your SVM.</p>
663
728
  */
664
729
  Password: string | undefined;
665
730
  /**
731
+ * @public
666
732
  * <p>Specifies a user name that can mount the location and access the files, folders, and
667
733
  * metadata that you need in the SVM.</p>
668
734
  * <p>If you provide a user in your Active Directory, note the following:</p>
@@ -702,12 +768,14 @@ export interface FsxProtocolSmb {
702
768
  */
703
769
  export interface FsxProtocol {
704
770
  /**
771
+ * @public
705
772
  * <p>Specifies the Network File System (NFS) protocol configuration that DataSync
706
773
  * uses to access your FSx for OpenZFS file system or FSx for ONTAP file
707
774
  * system's storage virtual machine (SVM).</p>
708
775
  */
709
776
  NFS?: FsxProtocolNfs;
710
777
  /**
778
+ * @public
711
779
  * <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync
712
780
  * uses to access your FSx for ONTAP file system's SVM.</p>
713
781
  */
@@ -718,11 +786,13 @@ export interface FsxProtocol {
718
786
  */
719
787
  export interface CreateLocationFsxOntapRequest {
720
788
  /**
789
+ * @public
721
790
  * <p>Specifies the data transfer protocol that DataSync uses to access your
722
791
  * Amazon FSx file system.</p>
723
792
  */
724
793
  Protocol: FsxProtocol | undefined;
725
794
  /**
795
+ * @public
726
796
  * <p>Specifies the Amazon EC2 security groups that provide access to your file system's
727
797
  * preferred subnet.</p>
728
798
  * <p>The security groups must allow outbound traffic on the following ports (depending on the
@@ -743,11 +813,13 @@ export interface CreateLocationFsxOntapRequest {
743
813
  */
744
814
  SecurityGroupArns: string[] | undefined;
745
815
  /**
816
+ * @public
746
817
  * <p>Specifies the ARN of the storage virtual machine (SVM) in your file system where you want
747
818
  * to copy data to or from.</p>
748
819
  */
749
820
  StorageVirtualMachineArn: string | undefined;
750
821
  /**
822
+ * @public
751
823
  * <p>Specifies a path to the file share in the SVM where you'll copy your data.</p>
752
824
  * <p>You can specify a junction path (also known as a mount point), qtree path (for NFS file
753
825
  * shares), or share name (for SMB file shares). For example, your mount path might be
@@ -758,6 +830,7 @@ export interface CreateLocationFsxOntapRequest {
758
830
  */
759
831
  Subdirectory?: string;
760
832
  /**
833
+ * @public
761
834
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
762
835
  * resources. We recommend creating at least a name tag for your location.</p>
763
836
  */
@@ -768,6 +841,7 @@ export interface CreateLocationFsxOntapRequest {
768
841
  */
769
842
  export interface CreateLocationFsxOntapResponse {
770
843
  /**
844
+ * @public
771
845
  * <p>Specifies the ARN of the FSx for ONTAP file system location that you
772
846
  * create.</p>
773
847
  */
@@ -778,24 +852,29 @@ export interface CreateLocationFsxOntapResponse {
778
852
  */
779
853
  export interface CreateLocationFsxOpenZfsRequest {
780
854
  /**
855
+ * @public
781
856
  * <p>The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.</p>
782
857
  */
783
858
  FsxFilesystemArn: string | undefined;
784
859
  /**
860
+ * @public
785
861
  * <p>The type of protocol that DataSync uses to access your file system.</p>
786
862
  */
787
863
  Protocol: FsxProtocol | undefined;
788
864
  /**
865
+ * @public
789
866
  * <p>The ARNs of the security groups that are used to configure the FSx for OpenZFS file
790
867
  * system.</p>
791
868
  */
792
869
  SecurityGroupArns: string[] | undefined;
793
870
  /**
871
+ * @public
794
872
  * <p>A subdirectory in the location's path that must begin with <code>/fsx</code>. DataSync uses this subdirectory to read or write data (depending on whether the file
795
873
  * system is a source or destination location).</p>
796
874
  */
797
875
  Subdirectory?: string;
798
876
  /**
877
+ * @public
799
878
  * <p>The key-value pair that represents a tag that you want to add to the resource. The value
800
879
  * can be an empty string. This value helps you manage, filter, and search for your resources. We
801
880
  * recommend that you create a name tag for your location.</p>
@@ -807,6 +886,7 @@ export interface CreateLocationFsxOpenZfsRequest {
807
886
  */
808
887
  export interface CreateLocationFsxOpenZfsResponse {
809
888
  /**
889
+ * @public
810
890
  * <p>The ARN of the FSx for OpenZFS file system location that you created.</p>
811
891
  */
812
892
  LocationArn?: string;
@@ -816,16 +896,19 @@ export interface CreateLocationFsxOpenZfsResponse {
816
896
  */
817
897
  export interface CreateLocationFsxWindowsRequest {
818
898
  /**
899
+ * @public
819
900
  * <p>Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination
820
901
  * location).</p>
821
902
  */
822
903
  Subdirectory?: string;
823
904
  /**
905
+ * @public
824
906
  * <p>Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file
825
907
  * system.</p>
826
908
  */
827
909
  FsxFilesystemArn: string | undefined;
828
910
  /**
911
+ * @public
829
912
  * <p>Specifies the ARNs of the security groups that provide access to your file system's
830
913
  * preferred subnet.</p>
831
914
  * <note>
@@ -844,22 +927,26 @@ export interface CreateLocationFsxWindowsRequest {
844
927
  */
845
928
  SecurityGroupArns: string[] | undefined;
846
929
  /**
930
+ * @public
847
931
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
848
932
  * resources. We recommend creating at least a name tag for your location.</p>
849
933
  */
850
934
  Tags?: TagListEntry[];
851
935
  /**
936
+ * @public
852
937
  * <p>Specifies the user who has the permissions to access files, folders, and metadata in your
853
938
  * file system.</p>
854
939
  * <p>For information about choosing a user with sufficient permissions, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions">Required permissions</a>.</p>
855
940
  */
856
941
  User: string | undefined;
857
942
  /**
943
+ * @public
858
944
  * <p>Specifies the name of the Windows domain that the FSx for Windows File Server belongs
859
945
  * to.</p>
860
946
  */
861
947
  Domain?: string;
862
948
  /**
949
+ * @public
863
950
  * <p>Specifies the password of the user who has the permissions to access files and folders in
864
951
  * the file system.</p>
865
952
  */
@@ -870,6 +957,7 @@ export interface CreateLocationFsxWindowsRequest {
870
957
  */
871
958
  export interface CreateLocationFsxWindowsResponse {
872
959
  /**
960
+ * @public
873
961
  * <p>The ARN of the FSx for Windows File Server file system location you created.</p>
874
962
  */
875
963
  LocationArn?: string;
@@ -895,12 +983,14 @@ export type HdfsAuthenticationType = (typeof HdfsAuthenticationType)[keyof typeo
895
983
  */
896
984
  export interface HdfsNameNode {
897
985
  /**
986
+ * @public
898
987
  * <p>The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain
899
988
  * Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this
900
989
  * hostname to communicate with the NameNode in the network.</p>
901
990
  */
902
991
  Hostname: string | undefined;
903
992
  /**
993
+ * @public
904
994
  * <p>The port that the NameNode uses to listen to client requests.</p>
905
995
  */
906
996
  Port: number | undefined;
@@ -941,12 +1031,14 @@ export type HdfsRpcProtection = (typeof HdfsRpcProtection)[keyof typeof HdfsRpcP
941
1031
  */
942
1032
  export interface QopConfiguration {
943
1033
  /**
1034
+ * @public
944
1035
  * <p>The RPC protection setting configured on the HDFS cluster. This setting corresponds to
945
1036
  * your <code>hadoop.rpc.protection</code> setting in your <code>core-site.xml</code> file on
946
1037
  * your Hadoop cluster.</p>
947
1038
  */
948
1039
  RpcProtection?: HdfsRpcProtection | string;
949
1040
  /**
1041
+ * @public
950
1042
  * <p>The data transfer protection setting configured on the HDFS cluster. This setting
951
1043
  * corresponds to your <code>dfs.data.transfer.protection</code> setting in the
952
1044
  * <code>hdfs-site.xml</code> file on your Hadoop cluster.</p>
@@ -958,32 +1050,38 @@ export interface QopConfiguration {
958
1050
  */
959
1051
  export interface CreateLocationHdfsRequest {
960
1052
  /**
1053
+ * @public
961
1054
  * <p>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write
962
1055
  * data to the HDFS cluster. If the subdirectory isn't specified, it will default to
963
1056
  * <code>/</code>.</p>
964
1057
  */
965
1058
  Subdirectory?: string;
966
1059
  /**
1060
+ * @public
967
1061
  * <p>The NameNode that manages the HDFS namespace. The NameNode performs operations such as
968
1062
  * opening, closing, and renaming files and directories. The NameNode contains the information to
969
1063
  * map blocks of data to the DataNodes. You can use only one NameNode.</p>
970
1064
  */
971
1065
  NameNodes: HdfsNameNode[] | undefined;
972
1066
  /**
1067
+ * @public
973
1068
  * <p>The size of data blocks to write into the HDFS cluster. The block size must be a multiple
974
1069
  * of 512 bytes. The default block size is 128 mebibytes (MiB).</p>
975
1070
  */
976
1071
  BlockSize?: number;
977
1072
  /**
1073
+ * @public
978
1074
  * <p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. By
979
1075
  * default, data is replicated to three DataNodes.</p>
980
1076
  */
981
1077
  ReplicationFactor?: number;
982
1078
  /**
1079
+ * @public
983
1080
  * <p>The URI of the HDFS cluster's Key Management Server (KMS). </p>
984
1081
  */
985
1082
  KmsKeyProviderUri?: string;
986
1083
  /**
1084
+ * @public
987
1085
  * <p>The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)
988
1086
  * and data transfer protection settings configured on the Hadoop Distributed File System (HDFS)
989
1087
  * cluster. If <code>QopConfiguration</code> isn't specified, <code>RpcProtection</code> and
@@ -993,10 +1091,12 @@ export interface CreateLocationHdfsRequest {
993
1091
  */
994
1092
  QopConfiguration?: QopConfiguration;
995
1093
  /**
1094
+ * @public
996
1095
  * <p>The type of authentication used to determine the identity of the user. </p>
997
1096
  */
998
1097
  AuthenticationType: HdfsAuthenticationType | string | undefined;
999
1098
  /**
1099
+ * @public
1000
1100
  * <p>The user name used to identify the client on the host operating system. </p>
1001
1101
  * <note>
1002
1102
  * <p>If <code>SIMPLE</code> is specified for <code>AuthenticationType</code>, this parameter
@@ -1005,6 +1105,7 @@ export interface CreateLocationHdfsRequest {
1005
1105
  */
1006
1106
  SimpleUser?: string;
1007
1107
  /**
1108
+ * @public
1008
1109
  * <p>The Kerberos principal with access to the files and folders on the HDFS cluster. </p>
1009
1110
  * <note>
1010
1111
  * <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this
@@ -1013,6 +1114,7 @@ export interface CreateLocationHdfsRequest {
1013
1114
  */
1014
1115
  KerberosPrincipal?: string;
1015
1116
  /**
1117
+ * @public
1016
1118
  * <p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos
1017
1119
  * principal and the encrypted keys. You can load the keytab from a file by providing the file's
1018
1120
  * address. If you're using the CLI, it performs base64 encoding for you.
@@ -1024,6 +1126,7 @@ export interface CreateLocationHdfsRequest {
1024
1126
  */
1025
1127
  KerberosKeytab?: Uint8Array;
1026
1128
  /**
1129
+ * @public
1027
1130
  * <p>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You
1028
1131
  * can load the <code>krb5.conf</code> file by providing the file's address. If you're using the
1029
1132
  * CLI, it performs the base64 encoding for you. Otherwise, provide the
@@ -1035,11 +1138,13 @@ export interface CreateLocationHdfsRequest {
1035
1138
  */
1036
1139
  KerberosKrb5Conf?: Uint8Array;
1037
1140
  /**
1141
+ * @public
1038
1142
  * <p>The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS
1039
1143
  * cluster.</p>
1040
1144
  */
1041
1145
  AgentArns: string[] | undefined;
1042
1146
  /**
1147
+ * @public
1043
1148
  * <p>The key-value pair that represents the tag that you want to add to the location. The value
1044
1149
  * can be an empty string. We recommend using tags to name your resources. </p>
1045
1150
  */
@@ -1050,18 +1155,21 @@ export interface CreateLocationHdfsRequest {
1050
1155
  */
1051
1156
  export interface CreateLocationHdfsResponse {
1052
1157
  /**
1158
+ * @public
1053
1159
  * <p>The ARN of the source HDFS cluster location that's created. </p>
1054
1160
  */
1055
1161
  LocationArn?: string;
1056
1162
  }
1057
1163
  /**
1058
1164
  * @public
1059
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
1165
+ * <p>The DataSync agents that are connecting to a Network File System (NFS)
1060
1166
  * location.</p>
1061
1167
  */
1062
1168
  export interface OnPremConfig {
1063
1169
  /**
1064
- * <p>ARNs of the agents to use for an NFS location.</p>
1170
+ * @public
1171
+ * <p>The Amazon Resource Names (ARNs) of the agents connecting to a transfer
1172
+ * location.</p>
1065
1173
  */
1066
1174
  AgentArns: string[] | undefined;
1067
1175
  }
@@ -1071,48 +1179,35 @@ export interface OnPremConfig {
1071
1179
  */
1072
1180
  export interface CreateLocationNfsRequest {
1073
1181
  /**
1074
- * <p>Specifies the subdirectory in the NFS file server that DataSync transfers to
1075
- * or from. The NFS path should be a path that's exported by the NFS server, or a
1076
- * subdirectory of that path. The path should be such that it can be mounted by other NFS clients
1077
- * in your network. </p>
1078
- * <p>To see all the paths exported by your NFS server, run "<code>showmount -e
1079
- * nfs-server-name</code>" from an NFS client that has access to your server. You can specify
1080
- * any directory that appears in the results, and any subdirectory of that directory. Ensure that
1081
- * the NFS export is accessible without Kerberos authentication. </p>
1082
- * <p>To transfer all the data in the folder you specified, DataSync needs to have
1083
- * permissions to read all the data. To ensure this, either configure the NFS export with
1084
- * <code>no_root_squash,</code> or ensure that the permissions for all of the files that you
1085
- * want DataSync allow read access for all users. Doing either enables the agent to
1086
- * read the files. For the agent to access directories, you must additionally enable all execute
1087
- * access.</p>
1088
- * <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
1089
- * Snowcone</a> for more information.</p>
1182
+ * @public
1183
+ * <p>Specifies the export path in your NFS file server that you want DataSync to
1184
+ * mount.</p>
1185
+ * <p>This path (or a subdirectory of the path) is where DataSync transfers data to
1186
+ * or from. For information on configuring an export for DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs">Accessing NFS file servers</a>.</p>
1090
1187
  */
1091
1188
  Subdirectory: string | undefined;
1092
1189
  /**
1093
- * <p>Specifies the IP address or domain name of your NFS file server. An agent that is
1094
- * installed on-premises uses this hostname to mount the NFS server in a network. </p>
1095
- * <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
1096
- * Snowcone</a> for more information.</p>
1097
- * <note>
1098
- * <p>You must specify be an IP version 4 address or Domain Name System (DNS)-compliant
1099
- * name.</p>
1100
- * </note>
1190
+ * @public
1191
+ * <p>Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file
1192
+ * server that your DataSync agent connects to.</p>
1101
1193
  */
1102
1194
  ServerHostname: string | undefined;
1103
1195
  /**
1104
- * <p>Specifies the Amazon Resource Names (ARNs) of agents that DataSync uses to
1105
- * connect to your NFS file server. </p>
1106
- * <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
1107
- * Snowcone</a> for more information.</p>
1196
+ * @public
1197
+ * <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to
1198
+ * connect to your NFS file server.</p>
1199
+ * <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html">Using multiple
1200
+ * agents for transfers</a>.</p>
1108
1201
  */
1109
1202
  OnPremConfig: OnPremConfig | undefined;
1110
1203
  /**
1111
- * <p>Specifies the mount options that DataSync can use to mount your NFS
1112
- * share.</p>
1204
+ * @public
1205
+ * <p>Specifies the options that DataSync can use to mount your NFS file
1206
+ * server.</p>
1113
1207
  */
1114
1208
  MountOptions?: NfsMountOptions;
1115
1209
  /**
1210
+ * @public
1116
1211
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
1117
1212
  * We recommend creating at least a name tag for your location.</p>
1118
1213
  */
@@ -1124,6 +1219,7 @@ export interface CreateLocationNfsRequest {
1124
1219
  */
1125
1220
  export interface CreateLocationNfsResponse {
1126
1221
  /**
1222
+ * @public
1127
1223
  * <p>The ARN of the transfer location that you created for your NFS file server.</p>
1128
1224
  */
1129
1225
  LocationArn?: string;
@@ -1146,51 +1242,61 @@ export type ObjectStorageServerProtocol = (typeof ObjectStorageServerProtocol)[k
1146
1242
  */
1147
1243
  export interface CreateLocationObjectStorageRequest {
1148
1244
  /**
1245
+ * @public
1149
1246
  * <p>Specifies the domain name or IP address of the object storage server. A DataSync
1150
1247
  * agent uses this hostname to mount the object storage server in a network.</p>
1151
1248
  */
1152
1249
  ServerHostname: string | undefined;
1153
1250
  /**
1251
+ * @public
1154
1252
  * <p>Specifies the port that your object storage server accepts inbound network traffic on (for
1155
1253
  * example, port 443).</p>
1156
1254
  */
1157
1255
  ServerPort?: number;
1158
1256
  /**
1257
+ * @public
1159
1258
  * <p>Specifies the protocol that your object storage server uses to communicate.</p>
1160
1259
  */
1161
1260
  ServerProtocol?: ObjectStorageServerProtocol | string;
1162
1261
  /**
1262
+ * @public
1163
1263
  * <p>Specifies the object prefix for your object storage server. If this is a source location,
1164
1264
  * DataSync only copies objects with this prefix. If this is a destination location,
1165
1265
  * DataSync writes all objects with this prefix. </p>
1166
1266
  */
1167
1267
  Subdirectory?: string;
1168
1268
  /**
1269
+ * @public
1169
1270
  * <p>Specifies the name of the object storage bucket involved in the transfer.</p>
1170
1271
  */
1171
1272
  BucketName: string | undefined;
1172
1273
  /**
1274
+ * @public
1173
1275
  * <p>Specifies the access key (for example, a user name) if credentials are required to
1174
1276
  * authenticate with the object storage server.</p>
1175
1277
  */
1176
1278
  AccessKey?: string;
1177
1279
  /**
1280
+ * @public
1178
1281
  * <p>Specifies the secret key (for example, a password) if credentials are required to
1179
1282
  * authenticate with the object storage server.</p>
1180
1283
  */
1181
1284
  SecretKey?: string;
1182
1285
  /**
1286
+ * @public
1183
1287
  * <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
1184
1288
  * securely connect with your location.</p>
1185
1289
  */
1186
1290
  AgentArns: string[] | undefined;
1187
1291
  /**
1292
+ * @public
1188
1293
  * <p>Specifies the key-value pair that represents a tag that you want to add to the resource.
1189
1294
  * Tags can help you manage, filter, and search for your resources. We recommend creating a name
1190
1295
  * tag for your location.</p>
1191
1296
  */
1192
1297
  Tags?: TagListEntry[];
1193
1298
  /**
1299
+ * @public
1194
1300
  * <p>Specifies a file with the certificates that are used to sign the object storage server's
1195
1301
  * certificate (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>).
1196
1302
  * The file you specify must include the following:</p>
@@ -1219,6 +1325,7 @@ export interface CreateLocationObjectStorageRequest {
1219
1325
  */
1220
1326
  export interface CreateLocationObjectStorageResponse {
1221
1327
  /**
1328
+ * @public
1222
1329
  * <p>Specifies the ARN of the object storage system location that you create.</p>
1223
1330
  */
1224
1331
  LocationArn?: string;
@@ -1232,6 +1339,7 @@ export interface CreateLocationObjectStorageResponse {
1232
1339
  */
1233
1340
  export interface S3Config {
1234
1341
  /**
1342
+ * @public
1235
1343
  * <p>The ARN of the IAM role for accessing the S3 bucket. </p>
1236
1344
  */
1237
1345
  BucketAccessRoleArn: string | undefined;
@@ -1260,16 +1368,19 @@ export type S3StorageClass = (typeof S3StorageClass)[keyof typeof S3StorageClass
1260
1368
  */
1261
1369
  export interface CreateLocationS3Request {
1262
1370
  /**
1371
+ * @public
1263
1372
  * <p>A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read
1264
1373
  * data from the S3 source location or write data to the S3 destination.</p>
1265
1374
  */
1266
1375
  Subdirectory?: string;
1267
1376
  /**
1377
+ * @public
1268
1378
  * <p>The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost,
1269
1379
  * this must be an access point ARN.</p>
1270
1380
  */
1271
1381
  S3BucketArn: string | undefined;
1272
1382
  /**
1383
+ * @public
1273
1384
  * <p>The Amazon S3 storage class that you want to store your files in when this location is
1274
1385
  * used as a task destination. For buckets in Amazon Web Services Regions, the storage class
1275
1386
  * defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.</p>
@@ -1279,6 +1390,7 @@ export interface CreateLocationS3Request {
1279
1390
  */
1280
1391
  S3StorageClass?: S3StorageClass | string;
1281
1392
  /**
1393
+ * @public
1282
1394
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access
1283
1395
  * an Amazon S3 bucket.</p>
1284
1396
  * <p>For detailed information about using such a role, see Creating a Location for
@@ -1286,6 +1398,7 @@ export interface CreateLocationS3Request {
1286
1398
  */
1287
1399
  S3Config: S3Config | undefined;
1288
1400
  /**
1401
+ * @public
1289
1402
  * <p>If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource
1290
1403
  * Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about
1291
1404
  * launching a DataSync 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
@@ -1293,6 +1406,7 @@ export interface CreateLocationS3Request {
1293
1406
  */
1294
1407
  AgentArns?: string[];
1295
1408
  /**
1409
+ * @public
1296
1410
  * <p>The key-value pair that represents the tag that you want to add to the location. The
1297
1411
  * value can be an empty string. We recommend using tags to name your resources.</p>
1298
1412
  */
@@ -1304,6 +1418,7 @@ export interface CreateLocationS3Request {
1304
1418
  */
1305
1419
  export interface CreateLocationS3Response {
1306
1420
  /**
1421
+ * @public
1307
1422
  * <p>The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is
1308
1423
  * created.</p>
1309
1424
  */
@@ -1315,6 +1430,7 @@ export interface CreateLocationS3Response {
1315
1430
  */
1316
1431
  export interface CreateLocationSmbRequest {
1317
1432
  /**
1433
+ * @public
1318
1434
  * <p>Specifies the name of the share exported by your SMB file server where DataSync
1319
1435
  * will read or write data. You can include a subdirectory in the share path (for example,
1320
1436
  * <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can
@@ -1324,6 +1440,7 @@ export interface CreateLocationSmbRequest {
1324
1440
  */
1325
1441
  Subdirectory: string | undefined;
1326
1442
  /**
1443
+ * @public
1327
1444
  * <p>Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that
1328
1445
  * your DataSync agent will mount.</p>
1329
1446
  * <note>
@@ -1332,6 +1449,7 @@ export interface CreateLocationSmbRequest {
1332
1449
  */
1333
1450
  ServerHostname: string | undefined;
1334
1451
  /**
1452
+ * @public
1335
1453
  * <p>Specifies the user name that can mount your SMB file server and has permission to access
1336
1454
  * the files and folders involved in your transfer.</p>
1337
1455
  * <p>For information about choosing a user with the right level of access for your transfer,
@@ -1339,27 +1457,32 @@ export interface CreateLocationSmbRequest {
1339
1457
  */
1340
1458
  User: string | undefined;
1341
1459
  /**
1460
+ * @public
1342
1461
  * <p>Specifies the Windows domain name that your SMB file server belongs to. </p>
1343
1462
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
1344
1463
  */
1345
1464
  Domain?: string;
1346
1465
  /**
1466
+ * @public
1347
1467
  * <p>Specifies the password of the user who can mount your SMB file server and has permission
1348
1468
  * to access the files and folders involved in your transfer.</p>
1349
1469
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions">required permissions</a> for SMB locations.</p>
1350
1470
  */
1351
1471
  Password: string | undefined;
1352
1472
  /**
1473
+ * @public
1353
1474
  * <p>Specifies the DataSync agent (or agents) which you want to connect to your SMB
1354
1475
  * file server. You specify an agent by using its Amazon Resource Name (ARN).</p>
1355
1476
  */
1356
1477
  AgentArns: string[] | undefined;
1357
1478
  /**
1479
+ * @public
1358
1480
  * <p>Specifies the version of the SMB protocol that DataSync uses to access your SMB
1359
1481
  * file server.</p>
1360
1482
  */
1361
1483
  MountOptions?: SmbMountOptions;
1362
1484
  /**
1485
+ * @public
1363
1486
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
1364
1487
  * resources. We recommend creating at least a name tag for your location.</p>
1365
1488
  */
@@ -1371,6 +1494,7 @@ export interface CreateLocationSmbRequest {
1371
1494
  */
1372
1495
  export interface CreateLocationSmbResponse {
1373
1496
  /**
1497
+ * @public
1374
1498
  * <p>The ARN of the SMB location that you created.</p>
1375
1499
  */
1376
1500
  LocationArn?: string;
@@ -1393,11 +1517,13 @@ export type FilterType = (typeof FilterType)[keyof typeof FilterType];
1393
1517
  */
1394
1518
  export interface FilterRule {
1395
1519
  /**
1520
+ * @public
1396
1521
  * <p>The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN
1397
1522
  * rule type.</p>
1398
1523
  */
1399
1524
  FilterType?: FilterType | string;
1400
1525
  /**
1526
+ * @public
1401
1527
  * <p>A single filter string that consists of the patterns to include or exclude. The patterns
1402
1528
  * are delimited by "|" (that is, a pipe), for example: <code>/folder1|/folder2</code>
1403
1529
  * </p>
@@ -1578,6 +1704,7 @@ export type VerifyMode = (typeof VerifyMode)[keyof typeof VerifyMode];
1578
1704
  */
1579
1705
  export interface Options {
1580
1706
  /**
1707
+ * @public
1581
1708
  * <p>Specifies how and when DataSync checks the integrity of your data during a
1582
1709
  * transfer. </p>
1583
1710
  * <p>Default value: <code>POINT_IN_TIME_CONSISTENT</code>
@@ -1606,6 +1733,7 @@ export interface Options {
1606
1733
  */
1607
1734
  VerifyMode?: VerifyMode | string;
1608
1735
  /**
1736
+ * @public
1609
1737
  * <p>Specifies whether data at the destination location should be overwritten or preserved. If
1610
1738
  * set to <code>NEVER</code>, a destination file for example will not be replaced by a source
1611
1739
  * file (even if the destination file differs from the source file). If you modify files in the
@@ -1617,6 +1745,7 @@ export interface Options {
1617
1745
  */
1618
1746
  OverwriteMode?: OverwriteMode | string;
1619
1747
  /**
1748
+ * @public
1620
1749
  * <p>Specifies whether to preserve metadata indicating the last time a file was read or
1621
1750
  * written to. If you set <code>Atime</code> to <code>BEST_EFFORT</code>, DataSync
1622
1751
  * attempts to preserve the original <code>Atime</code> attribute on all source files (that is,
@@ -1640,6 +1769,7 @@ export interface Options {
1640
1769
  */
1641
1770
  Atime?: Atime | string;
1642
1771
  /**
1772
+ * @public
1643
1773
  * <p>Specifies whether to preserve metadata indicating the last time that a file was written
1644
1774
  * to before the <code>PREPARING</code> phase of your task execution. This option is required
1645
1775
  * when you need to run the a task more than once.</p>
@@ -1658,6 +1788,7 @@ export interface Options {
1658
1788
  */
1659
1789
  Mtime?: Mtime | string;
1660
1790
  /**
1791
+ * @public
1661
1792
  * <p>Specifies the POSIX user ID (UID) of the file's owner.</p>
1662
1793
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
1663
1794
  * <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
@@ -1669,6 +1800,7 @@ export interface Options {
1669
1800
  */
1670
1801
  Uid?: Uid | string;
1671
1802
  /**
1803
+ * @public
1672
1804
  * <p>Specifies the POSIX group ID (GID) of the file's owners.</p>
1673
1805
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
1674
1806
  * <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
@@ -1680,6 +1812,7 @@ export interface Options {
1680
1812
  */
1681
1813
  Gid?: Gid | string;
1682
1814
  /**
1815
+ * @public
1683
1816
  * <p>Specifies whether files in the destination location that don't exist in the source
1684
1817
  * should be preserved. This option can affect your Amazon S3 storage cost. If your task
1685
1818
  * deletes objects, you might incur minimum storage duration charges for certain storage classes.
@@ -1699,6 +1832,7 @@ export interface Options {
1699
1832
  */
1700
1833
  PreserveDeletedFiles?: PreserveDeletedFiles | string;
1701
1834
  /**
1835
+ * @public
1702
1836
  * <p>Specifies whether DataSync should preserve the metadata of block and
1703
1837
  * character devices in the source location and recreate the files with that device name and
1704
1838
  * metadata on the destination. DataSync copies only the name and metadata of such
@@ -1717,6 +1851,7 @@ export interface Options {
1717
1851
  */
1718
1852
  PreserveDevices?: PreserveDevices | string;
1719
1853
  /**
1854
+ * @public
1720
1855
  * <p>Specifies which users or groups can access a file for a specific purpose such as reading,
1721
1856
  * writing, or execution of the file.</p>
1722
1857
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
@@ -1732,18 +1867,21 @@ export interface Options {
1732
1867
  */
1733
1868
  PosixPermissions?: PosixPermissions | string;
1734
1869
  /**
1870
+ * @public
1735
1871
  * <p>Limits the bandwidth used by a DataSync task. For example, if you want
1736
1872
  * DataSync to use a maximum of 1 MB, set this value to <code>1048576</code>
1737
1873
  * (<code>=1024*1024</code>).</p>
1738
1874
  */
1739
1875
  BytesPerSecond?: number;
1740
1876
  /**
1877
+ * @public
1741
1878
  * <p>Specifies whether your transfer tasks should be put into a queue during certain scenarios
1742
1879
  * when <a href="https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks">running multiple
1743
1880
  * tasks</a>. This is <code>ENABLED</code> by default.</p>
1744
1881
  */
1745
1882
  TaskQueueing?: TaskQueueing | string;
1746
1883
  /**
1884
+ * @public
1747
1885
  * <p>Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs
1748
1886
  * log group. To specify the log group, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn">CloudWatchLogGroupArn</a>.</p>
1749
1887
  * <p>If you set <code>LogLevel</code> to <code>OFF</code>, no logs are published.
@@ -1753,6 +1891,7 @@ export interface Options {
1753
1891
  */
1754
1892
  LogLevel?: LogLevel | string;
1755
1893
  /**
1894
+ * @public
1756
1895
  * <p>Determines whether DataSync transfers only the data and metadata that differ
1757
1896
  * between the source and the destination location or transfers all the content from the source
1758
1897
  * (without comparing what's in the destination).</p>
@@ -1765,6 +1904,7 @@ export interface Options {
1765
1904
  */
1766
1905
  TransferMode?: TransferMode | string;
1767
1906
  /**
1907
+ * @public
1768
1908
  * <p>Specifies which components of the SMB security descriptor are copied from source to
1769
1909
  * destination objects. </p>
1770
1910
  * <p>This value is only used for transfers between SMB and Amazon FSx for Windows File Server
@@ -1811,6 +1951,7 @@ export interface Options {
1811
1951
  */
1812
1952
  SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags | string;
1813
1953
  /**
1954
+ * @public
1814
1955
  * <p>Specifies whether object tags are preserved when transferring between object storage
1815
1956
  * systems. If you want your DataSync task to ignore object tags, specify the
1816
1957
  * <code>NONE</code> value.</p>
@@ -1827,6 +1968,7 @@ export interface Options {
1827
1968
  */
1828
1969
  export interface TaskSchedule {
1829
1970
  /**
1971
+ * @public
1830
1972
  * <p>A cron expression that specifies when DataSync initiates a scheduled
1831
1973
  * transfer from a source to a destination location. </p>
1832
1974
  */
@@ -1838,25 +1980,30 @@ export interface TaskSchedule {
1838
1980
  */
1839
1981
  export interface CreateTaskRequest {
1840
1982
  /**
1983
+ * @public
1841
1984
  * <p>The Amazon Resource Name (ARN) of the source location for the task.</p>
1842
1985
  */
1843
1986
  SourceLocationArn: string | undefined;
1844
1987
  /**
1988
+ * @public
1845
1989
  * <p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
1846
1990
  * </p>
1847
1991
  */
1848
1992
  DestinationLocationArn: string | undefined;
1849
1993
  /**
1994
+ * @public
1850
1995
  * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to
1851
1996
  * monitor and log events in the task. </p>
1852
1997
  */
1853
1998
  CloudWatchLogGroupArn?: string;
1854
1999
  /**
2000
+ * @public
1855
2001
  * <p>The name of a task. This value is a text reference that is used to identify the task in
1856
2002
  * the console. </p>
1857
2003
  */
1858
2004
  Name?: string;
1859
2005
  /**
2006
+ * @public
1860
2007
  * <p>Specifies the configuration options for a task. Some options include preserving file or
1861
2008
  * object metadata and verifying data integrity.</p>
1862
2009
  * <p>You can also override these options before starting an individual run of a task (also
@@ -1864,17 +2011,20 @@ export interface CreateTaskRequest {
1864
2011
  */
1865
2012
  Options?: Options;
1866
2013
  /**
2014
+ * @public
1867
2015
  * <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
1868
2016
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
1869
2017
  */
1870
2018
  Excludes?: FilterRule[];
1871
2019
  /**
2020
+ * @public
1872
2021
  * <p>Specifies a schedule used to periodically transfer files from a source to a destination
1873
2022
  * 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
1874
2023
  * task</a>.</p>
1875
2024
  */
1876
2025
  Schedule?: TaskSchedule;
1877
2026
  /**
2027
+ * @public
1878
2028
  * <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN)
1879
2029
  * representing the task.</p>
1880
2030
  * <p>
@@ -1883,6 +2033,7 @@ export interface CreateTaskRequest {
1883
2033
  */
1884
2034
  Tags?: TagListEntry[];
1885
2035
  /**
2036
+ * @public
1886
2037
  * <p>Specifies a list of filter rules that include specific data during your transfer. For more
1887
2038
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
1888
2039
  */
@@ -1894,6 +2045,7 @@ export interface CreateTaskRequest {
1894
2045
  */
1895
2046
  export interface CreateTaskResponse {
1896
2047
  /**
2048
+ * @public
1897
2049
  * <p>The Amazon Resource Name (ARN) of the task.</p>
1898
2050
  */
1899
2051
  TaskArn?: string;
@@ -1904,6 +2056,7 @@ export interface CreateTaskResponse {
1904
2056
  */
1905
2057
  export interface DeleteAgentRequest {
1906
2058
  /**
2059
+ * @public
1907
2060
  * <p>The Amazon Resource Name (ARN) of the agent to delete. Use the <code>ListAgents</code>
1908
2061
  * operation to return a list of agents for your account and Amazon Web Services Region.</p>
1909
2062
  */
@@ -1920,6 +2073,7 @@ export interface DeleteAgentResponse {
1920
2073
  */
1921
2074
  export interface DeleteLocationRequest {
1922
2075
  /**
2076
+ * @public
1923
2077
  * <p>The Amazon Resource Name (ARN) of the location to delete.</p>
1924
2078
  */
1925
2079
  LocationArn: string | undefined;
@@ -1935,6 +2089,7 @@ export interface DeleteLocationResponse {
1935
2089
  */
1936
2090
  export interface DeleteTaskRequest {
1937
2091
  /**
2092
+ * @public
1938
2093
  * <p>Specifies the Amazon Resource Name (ARN) of the task that you want to delete.</p>
1939
2094
  */
1940
2095
  TaskArn: string | undefined;
@@ -1950,6 +2105,7 @@ export interface DeleteTaskResponse {
1950
2105
  */
1951
2106
  export interface DescribeAgentRequest {
1952
2107
  /**
2108
+ * @public
1953
2109
  * <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent to
1954
2110
  * describe.</p>
1955
2111
  */
@@ -1976,20 +2132,24 @@ export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
1976
2132
  */
1977
2133
  export interface PrivateLinkConfig {
1978
2134
  /**
2135
+ * @public
1979
2136
  * <p>Specifies the ID of the VPC endpoint that your agent connects to.</p>
1980
2137
  */
1981
2138
  VpcEndpointId?: string;
1982
2139
  /**
2140
+ * @public
1983
2141
  * <p>Specifies the VPC endpoint provided by <a href="https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html">Amazon Web Services PrivateLink</a> that
1984
2142
  * your agent connects to.</p>
1985
2143
  */
1986
2144
  PrivateLinkEndpoint?: string;
1987
2145
  /**
2146
+ * @public
1988
2147
  * <p>Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify
1989
2148
  * one ARN.</p>
1990
2149
  */
1991
2150
  SubnetArns?: string[];
1992
2151
  /**
2152
+ * @public
1993
2153
  * <p>Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.</p>
1994
2154
  */
1995
2155
  SecurityGroupArns?: string[];
@@ -2000,14 +2160,17 @@ export interface PrivateLinkConfig {
2000
2160
  */
2001
2161
  export interface DescribeAgentResponse {
2002
2162
  /**
2163
+ * @public
2003
2164
  * <p>The ARN of the agent.</p>
2004
2165
  */
2005
2166
  AgentArn?: string;
2006
2167
  /**
2168
+ * @public
2007
2169
  * <p>The name of the agent.</p>
2008
2170
  */
2009
2171
  Name?: string;
2010
2172
  /**
2173
+ * @public
2011
2174
  * <p>The status of the agent. If the status is ONLINE, then the agent is configured properly
2012
2175
  * and is available to use. The Running status is the normal running status for an agent. If the
2013
2176
  * status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When
@@ -2016,19 +2179,23 @@ export interface DescribeAgentResponse {
2016
2179
  */
2017
2180
  Status?: AgentStatus | string;
2018
2181
  /**
2182
+ * @public
2019
2183
  * <p>The time that the agent last connected to DataSync.</p>
2020
2184
  */
2021
2185
  LastConnectionTime?: Date;
2022
2186
  /**
2187
+ * @public
2023
2188
  * <p>The time that the agent was activated (that is, created in your account).</p>
2024
2189
  */
2025
2190
  CreationTime?: Date;
2026
2191
  /**
2192
+ * @public
2027
2193
  * <p>The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint,
2028
2194
  * the agent is not accessible over the public internet. </p>
2029
2195
  */
2030
2196
  EndpointType?: EndpointType | string;
2031
2197
  /**
2198
+ * @public
2032
2199
  * <p>The subnet and the security group that DataSync used to access a VPC endpoint.</p>
2033
2200
  */
2034
2201
  PrivateLinkConfig?: PrivateLinkConfig;
@@ -2038,6 +2205,7 @@ export interface DescribeAgentResponse {
2038
2205
  */
2039
2206
  export interface DescribeDiscoveryJobRequest {
2040
2207
  /**
2208
+ * @public
2041
2209
  * <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want information
2042
2210
  * about.</p>
2043
2211
  */
@@ -2065,26 +2233,32 @@ export type DiscoveryJobStatus = (typeof DiscoveryJobStatus)[keyof typeof Discov
2065
2233
  */
2066
2234
  export interface DescribeDiscoveryJobResponse {
2067
2235
  /**
2236
+ * @public
2068
2237
  * <p>The ARN of the on-premises storage system you're running the discovery job on.</p>
2069
2238
  */
2070
2239
  StorageSystemArn?: string;
2071
2240
  /**
2241
+ * @public
2072
2242
  * <p>The ARN of the discovery job.</p>
2073
2243
  */
2074
2244
  DiscoveryJobArn?: string;
2075
2245
  /**
2246
+ * @public
2076
2247
  * <p>The number of minutes that the discovery job runs.</p>
2077
2248
  */
2078
2249
  CollectionDurationMinutes?: number;
2079
2250
  /**
2251
+ * @public
2080
2252
  * <p>Indicates the status of a discovery job. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">Discovery job statuses</a>.</p>
2081
2253
  */
2082
2254
  Status?: DiscoveryJobStatus | string;
2083
2255
  /**
2256
+ * @public
2084
2257
  * <p>The time when the discovery job started.</p>
2085
2258
  */
2086
2259
  JobStartTime?: Date;
2087
2260
  /**
2261
+ * @public
2088
2262
  * <p>The time when the discovery job ended.</p>
2089
2263
  */
2090
2264
  JobEndTime?: Date;
@@ -2094,6 +2268,7 @@ export interface DescribeDiscoveryJobResponse {
2094
2268
  */
2095
2269
  export interface DescribeLocationAzureBlobRequest {
2096
2270
  /**
2271
+ * @public
2097
2272
  * <p>Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer location.</p>
2098
2273
  */
2099
2274
  LocationArn: string | undefined;
@@ -2103,32 +2278,39 @@ export interface DescribeLocationAzureBlobRequest {
2103
2278
  */
2104
2279
  export interface DescribeLocationAzureBlobResponse {
2105
2280
  /**
2281
+ * @public
2106
2282
  * <p>The ARN of your Azure Blob Storage transfer location.</p>
2107
2283
  */
2108
2284
  LocationArn?: string;
2109
2285
  /**
2286
+ * @public
2110
2287
  * <p>The URL of the Azure Blob Storage container involved in your transfer.</p>
2111
2288
  */
2112
2289
  LocationUri?: string;
2113
2290
  /**
2291
+ * @public
2114
2292
  * <p>The authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).</p>
2115
2293
  */
2116
2294
  AuthenticationType?: AzureBlobAuthenticationType | string;
2117
2295
  /**
2296
+ * @public
2118
2297
  * <p>The type of blob that you want your objects or files to be when transferring them into
2119
2298
  * Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob
2120
2299
  * Storage as block blobs. For more information on blob types, see the <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs">Azure Blob Storage documentation</a>.</p>
2121
2300
  */
2122
2301
  BlobType?: AzureBlobType | string;
2123
2302
  /**
2303
+ * @public
2124
2304
  * <p>The access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">Access tiers</a>.</p>
2125
2305
  */
2126
2306
  AccessTier?: AzureAccessTier | string;
2127
2307
  /**
2308
+ * @public
2128
2309
  * <p>The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.</p>
2129
2310
  */
2130
2311
  AgentArns?: string[];
2131
2312
  /**
2313
+ * @public
2132
2314
  * <p>The time that your Azure Blob Storage transfer location was created.</p>
2133
2315
  */
2134
2316
  CreationTime?: Date;
@@ -2139,6 +2321,7 @@ export interface DescribeLocationAzureBlobResponse {
2139
2321
  */
2140
2322
  export interface DescribeLocationEfsRequest {
2141
2323
  /**
2324
+ * @public
2142
2325
  * <p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that you
2143
2326
  * want information about.</p>
2144
2327
  */
@@ -2150,32 +2333,39 @@ export interface DescribeLocationEfsRequest {
2150
2333
  */
2151
2334
  export interface DescribeLocationEfsResponse {
2152
2335
  /**
2336
+ * @public
2153
2337
  * <p>The ARN of the Amazon EFS file system location.</p>
2154
2338
  */
2155
2339
  LocationArn?: string;
2156
2340
  /**
2341
+ * @public
2157
2342
  * <p>The URL of the Amazon EFS file system location.</p>
2158
2343
  */
2159
2344
  LocationUri?: string;
2160
2345
  /**
2346
+ * @public
2161
2347
  * <p>The subnet and security groups that DataSync uses to access your Amazon EFS file system.</p>
2162
2348
  */
2163
2349
  Ec2Config?: Ec2Config;
2164
2350
  /**
2351
+ * @public
2165
2352
  * <p>The time that the location was created.</p>
2166
2353
  */
2167
2354
  CreationTime?: Date;
2168
2355
  /**
2356
+ * @public
2169
2357
  * <p>The ARN of the access point that DataSync uses to access the Amazon EFS
2170
2358
  * file system.</p>
2171
2359
  */
2172
2360
  AccessPointArn?: string;
2173
2361
  /**
2362
+ * @public
2174
2363
  * <p>The Identity and Access Management (IAM) role that DataSync assumes when
2175
2364
  * mounting the Amazon EFS file system.</p>
2176
2365
  */
2177
2366
  FileSystemAccessRoleArn?: string;
2178
2367
  /**
2368
+ * @public
2179
2369
  * <p>Describes whether DataSync uses Transport Layer Security (TLS) encryption when
2180
2370
  * copying data to or from the Amazon EFS file system.</p>
2181
2371
  */
@@ -2186,6 +2376,7 @@ export interface DescribeLocationEfsResponse {
2186
2376
  */
2187
2377
  export interface DescribeLocationFsxLustreRequest {
2188
2378
  /**
2379
+ * @public
2189
2380
  * <p>The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
2190
2381
  * </p>
2191
2382
  */
@@ -2196,20 +2387,24 @@ export interface DescribeLocationFsxLustreRequest {
2196
2387
  */
2197
2388
  export interface DescribeLocationFsxLustreResponse {
2198
2389
  /**
2390
+ * @public
2199
2391
  * <p>The Amazon Resource Name (ARN) of the FSx for Lustre location that was
2200
2392
  * described.</p>
2201
2393
  */
2202
2394
  LocationArn?: string;
2203
2395
  /**
2396
+ * @public
2204
2397
  * <p>The URI of the FSx for Lustre location that was described.</p>
2205
2398
  */
2206
2399
  LocationUri?: string;
2207
2400
  /**
2401
+ * @public
2208
2402
  * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the
2209
2403
  * FSx for Lustre file system.</p>
2210
2404
  */
2211
2405
  SecurityGroupArns?: string[];
2212
2406
  /**
2407
+ * @public
2213
2408
  * <p>The time that the FSx for Lustre location was created.</p>
2214
2409
  */
2215
2410
  CreationTime?: Date;
@@ -2219,6 +2414,7 @@ export interface DescribeLocationFsxLustreResponse {
2219
2414
  */
2220
2415
  export interface DescribeLocationFsxOntapRequest {
2221
2416
  /**
2417
+ * @public
2222
2418
  * <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system
2223
2419
  * location that you want information about.</p>
2224
2420
  */
@@ -2229,34 +2425,41 @@ export interface DescribeLocationFsxOntapRequest {
2229
2425
  */
2230
2426
  export interface DescribeLocationFsxOntapResponse {
2231
2427
  /**
2428
+ * @public
2232
2429
  * <p>The time that the location was created.</p>
2233
2430
  */
2234
2431
  CreationTime?: Date;
2235
2432
  /**
2433
+ * @public
2236
2434
  * <p>The ARN of the FSx for ONTAP file system location.</p>
2237
2435
  */
2238
2436
  LocationArn?: string;
2239
2437
  /**
2438
+ * @public
2240
2439
  * <p>The uniform resource identifier (URI) of the FSx for ONTAP file system
2241
2440
  * location.</p>
2242
2441
  */
2243
2442
  LocationUri?: string;
2244
2443
  /**
2444
+ * @public
2245
2445
  * <p>Specifies the data transfer protocol that DataSync uses to access your
2246
2446
  * Amazon FSx file system.</p>
2247
2447
  */
2248
2448
  Protocol?: FsxProtocol;
2249
2449
  /**
2450
+ * @public
2250
2451
  * <p>The security groups that DataSync uses to access your FSx for ONTAP
2251
2452
  * file system.</p>
2252
2453
  */
2253
2454
  SecurityGroupArns?: string[];
2254
2455
  /**
2456
+ * @public
2255
2457
  * <p>The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system
2256
2458
  * where you're copying data to or from.</p>
2257
2459
  */
2258
2460
  StorageVirtualMachineArn?: string;
2259
2461
  /**
2462
+ * @public
2260
2463
  * <p>The ARN of the FSx for ONTAP file system.</p>
2261
2464
  */
2262
2465
  FsxFilesystemArn?: string;
@@ -2266,6 +2469,7 @@ export interface DescribeLocationFsxOntapResponse {
2266
2469
  */
2267
2470
  export interface DescribeLocationFsxOpenZfsRequest {
2268
2471
  /**
2472
+ * @public
2269
2473
  * <p>The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.</p>
2270
2474
  */
2271
2475
  LocationArn: string | undefined;
@@ -2275,10 +2479,12 @@ export interface DescribeLocationFsxOpenZfsRequest {
2275
2479
  */
2276
2480
  export interface DescribeLocationFsxOpenZfsResponse {
2277
2481
  /**
2482
+ * @public
2278
2483
  * <p>The ARN of the FSx for OpenZFS location that was described.</p>
2279
2484
  */
2280
2485
  LocationArn?: string;
2281
2486
  /**
2487
+ * @public
2282
2488
  * <p>The uniform resource identifier (URI) of the FSx for OpenZFS location that was
2283
2489
  * described.</p>
2284
2490
  * <p>Example: <code>fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder</code>
@@ -2286,15 +2492,18 @@ export interface DescribeLocationFsxOpenZfsResponse {
2286
2492
  */
2287
2493
  LocationUri?: string;
2288
2494
  /**
2495
+ * @public
2289
2496
  * <p>The ARNs of the security groups that are configured for the FSx for OpenZFS file
2290
2497
  * system.</p>
2291
2498
  */
2292
2499
  SecurityGroupArns?: string[];
2293
2500
  /**
2501
+ * @public
2294
2502
  * <p>The type of protocol that DataSync uses to access your file system.</p>
2295
2503
  */
2296
2504
  Protocol?: FsxProtocol;
2297
2505
  /**
2506
+ * @public
2298
2507
  * <p>The time that the FSx for OpenZFS location was created.</p>
2299
2508
  */
2300
2509
  CreationTime?: Date;
@@ -2304,6 +2513,7 @@ export interface DescribeLocationFsxOpenZfsResponse {
2304
2513
  */
2305
2514
  export interface DescribeLocationFsxWindowsRequest {
2306
2515
  /**
2516
+ * @public
2307
2517
  * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location to
2308
2518
  * describe.</p>
2309
2519
  */
@@ -2314,29 +2524,35 @@ export interface DescribeLocationFsxWindowsRequest {
2314
2524
  */
2315
2525
  export interface DescribeLocationFsxWindowsResponse {
2316
2526
  /**
2527
+ * @public
2317
2528
  * <p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was
2318
2529
  * described.</p>
2319
2530
  */
2320
2531
  LocationArn?: string;
2321
2532
  /**
2533
+ * @public
2322
2534
  * <p>The URL of the FSx for Windows File Server location that was described.</p>
2323
2535
  */
2324
2536
  LocationUri?: string;
2325
2537
  /**
2538
+ * @public
2326
2539
  * <p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx
2327
2540
  * for Windows File Server file system.</p>
2328
2541
  */
2329
2542
  SecurityGroupArns?: string[];
2330
2543
  /**
2544
+ * @public
2331
2545
  * <p>The time that the FSx for Windows File Server location was created.</p>
2332
2546
  */
2333
2547
  CreationTime?: Date;
2334
2548
  /**
2549
+ * @public
2335
2550
  * <p>The user who has the permissions to access files and folders in the FSx for Windows File
2336
2551
  * Server file system.</p>
2337
2552
  */
2338
2553
  User?: string;
2339
2554
  /**
2555
+ * @public
2340
2556
  * <p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>
2341
2557
  */
2342
2558
  Domain?: string;
@@ -2346,6 +2562,7 @@ export interface DescribeLocationFsxWindowsResponse {
2346
2562
  */
2347
2563
  export interface DescribeLocationHdfsRequest {
2348
2564
  /**
2565
+ * @public
2349
2566
  * <p>The Amazon Resource Name (ARN) of the HDFS cluster location to describe.</p>
2350
2567
  */
2351
2568
  LocationArn: string | undefined;
@@ -2355,55 +2572,67 @@ export interface DescribeLocationHdfsRequest {
2355
2572
  */
2356
2573
  export interface DescribeLocationHdfsResponse {
2357
2574
  /**
2575
+ * @public
2358
2576
  * <p>The ARN of the HDFS cluster location.</p>
2359
2577
  */
2360
2578
  LocationArn?: string;
2361
2579
  /**
2580
+ * @public
2362
2581
  * <p>The URI of the HDFS cluster location.</p>
2363
2582
  */
2364
2583
  LocationUri?: string;
2365
2584
  /**
2585
+ * @public
2366
2586
  * <p>The NameNode that manage the HDFS namespace. </p>
2367
2587
  */
2368
2588
  NameNodes?: HdfsNameNode[];
2369
2589
  /**
2590
+ * @public
2370
2591
  * <p>The size of the data blocks to write into the HDFS cluster. </p>
2371
2592
  */
2372
2593
  BlockSize?: number;
2373
2594
  /**
2595
+ * @public
2374
2596
  * <p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. </p>
2375
2597
  */
2376
2598
  ReplicationFactor?: number;
2377
2599
  /**
2600
+ * @public
2378
2601
  * <p> The URI of the HDFS cluster's Key Management Server (KMS). </p>
2379
2602
  */
2380
2603
  KmsKeyProviderUri?: string;
2381
2604
  /**
2605
+ * @public
2382
2606
  * <p>The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)
2383
2607
  * and data transfer protection settings configured on the Hadoop Distributed File System (HDFS)
2384
2608
  * cluster. </p>
2385
2609
  */
2386
2610
  QopConfiguration?: QopConfiguration;
2387
2611
  /**
2612
+ * @public
2388
2613
  * <p>The type of authentication used to determine the identity of the user. </p>
2389
2614
  */
2390
2615
  AuthenticationType?: HdfsAuthenticationType | string;
2391
2616
  /**
2617
+ * @public
2392
2618
  * <p>The user name used to identify the client on the host operating system. This parameter is
2393
2619
  * used if the <code>AuthenticationType</code> is defined as <code>SIMPLE</code>.</p>
2394
2620
  */
2395
2621
  SimpleUser?: string;
2396
2622
  /**
2623
+ * @public
2397
2624
  * <p>The Kerberos principal with access to the files and folders on the HDFS cluster. This
2398
2625
  * parameter is used if the <code>AuthenticationType</code> is defined as
2399
2626
  * <code>KERBEROS</code>.</p>
2400
2627
  */
2401
2628
  KerberosPrincipal?: string;
2402
2629
  /**
2630
+ * @public
2403
2631
  * <p>The ARNs of the agents that are used to connect to the HDFS cluster. </p>
2404
2632
  */
2405
2633
  AgentArns?: string[];
2406
2634
  /**
2635
+ * @public
2407
2636
  * <p>The time that the HDFS location was created.</p>
2408
2637
  */
2409
2638
  CreationTime?: Date;
@@ -2414,7 +2643,9 @@ export interface DescribeLocationHdfsResponse {
2414
2643
  */
2415
2644
  export interface DescribeLocationNfsRequest {
2416
2645
  /**
2417
- * <p>The Amazon Resource Name (ARN) of the NFS location to describe.</p>
2646
+ * @public
2647
+ * <p>Specifies the Amazon Resource Name (ARN) of the NFS location that you want information
2648
+ * about.</p>
2418
2649
  */
2419
2650
  LocationArn: string | undefined;
2420
2651
  }
@@ -2424,24 +2655,29 @@ export interface DescribeLocationNfsRequest {
2424
2655
  */
2425
2656
  export interface DescribeLocationNfsResponse {
2426
2657
  /**
2427
- * <p>The Amazon Resource Name (ARN) of the NFS location that was described.</p>
2658
+ * @public
2659
+ * <p>The ARN of the NFS location.</p>
2428
2660
  */
2429
2661
  LocationArn?: string;
2430
2662
  /**
2431
- * <p>The URL of the source NFS location that was described.</p>
2663
+ * @public
2664
+ * <p>The URL of the NFS location.</p>
2432
2665
  */
2433
2666
  LocationUri?: string;
2434
2667
  /**
2435
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
2668
+ * @public
2669
+ * <p>The DataSync agents that are connecting to a Network File System (NFS)
2436
2670
  * location.</p>
2437
2671
  */
2438
2672
  OnPremConfig?: OnPremConfig;
2439
2673
  /**
2440
- * <p>The mount options that DataSync uses to mount your NFS share.</p>
2674
+ * @public
2675
+ * <p>The mount options that DataSync uses to mount your NFS file server.</p>
2441
2676
  */
2442
2677
  MountOptions?: NfsMountOptions;
2443
2678
  /**
2444
- * <p>The time that the NFS location was created.</p>
2679
+ * @public
2680
+ * <p>The time when the NFS location was created.</p>
2445
2681
  */
2446
2682
  CreationTime?: Date;
2447
2683
  }
@@ -2451,6 +2687,7 @@ export interface DescribeLocationNfsResponse {
2451
2687
  */
2452
2688
  export interface DescribeLocationObjectStorageRequest {
2453
2689
  /**
2690
+ * @public
2454
2691
  * <p>The Amazon Resource Name (ARN) of the object storage system location that you want
2455
2692
  * information about.</p>
2456
2693
  */
@@ -2462,37 +2699,45 @@ export interface DescribeLocationObjectStorageRequest {
2462
2699
  */
2463
2700
  export interface DescribeLocationObjectStorageResponse {
2464
2701
  /**
2702
+ * @public
2465
2703
  * <p>The ARN of the object storage system location.</p>
2466
2704
  */
2467
2705
  LocationArn?: string;
2468
2706
  /**
2707
+ * @public
2469
2708
  * <p>The URL of the object storage system location.</p>
2470
2709
  */
2471
2710
  LocationUri?: string;
2472
2711
  /**
2712
+ * @public
2473
2713
  * <p>The access key (for example, a user name) required to authenticate with the object storage
2474
2714
  * system.</p>
2475
2715
  */
2476
2716
  AccessKey?: string;
2477
2717
  /**
2718
+ * @public
2478
2719
  * <p>The port that your object storage server accepts inbound network traffic on (for example,
2479
2720
  * port 443).</p>
2480
2721
  */
2481
2722
  ServerPort?: number;
2482
2723
  /**
2724
+ * @public
2483
2725
  * <p>The protocol that your object storage system uses to communicate.</p>
2484
2726
  */
2485
2727
  ServerProtocol?: ObjectStorageServerProtocol | string;
2486
2728
  /**
2729
+ * @public
2487
2730
  * <p>The ARNs of the DataSync agents that can securely connect with your
2488
2731
  * location.</p>
2489
2732
  */
2490
2733
  AgentArns?: string[];
2491
2734
  /**
2735
+ * @public
2492
2736
  * <p>The time that the location was created.</p>
2493
2737
  */
2494
2738
  CreationTime?: Date;
2495
2739
  /**
2740
+ * @public
2496
2741
  * <p>The self-signed certificate that DataSync uses to securely authenticate with
2497
2742
  * your object storage system.</p>
2498
2743
  */
@@ -2504,6 +2749,7 @@ export interface DescribeLocationObjectStorageResponse {
2504
2749
  */
2505
2750
  export interface DescribeLocationS3Request {
2506
2751
  /**
2752
+ * @public
2507
2753
  * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.</p>
2508
2754
  */
2509
2755
  LocationArn: string | undefined;
@@ -2514,14 +2760,17 @@ export interface DescribeLocationS3Request {
2514
2760
  */
2515
2761
  export interface DescribeLocationS3Response {
2516
2762
  /**
2763
+ * @public
2517
2764
  * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.</p>
2518
2765
  */
2519
2766
  LocationArn?: string;
2520
2767
  /**
2768
+ * @public
2521
2769
  * <p>The URL of the Amazon S3 location that was described.</p>
2522
2770
  */
2523
2771
  LocationUri?: string;
2524
2772
  /**
2773
+ * @public
2525
2774
  * <p>The Amazon S3 storage class that you chose to store your files in when this location is
2526
2775
  * 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
2527
2776
  * classes have behaviors that can affect your S3 storage cost. For detailed information, see
@@ -2530,6 +2779,7 @@ export interface DescribeLocationS3Response {
2530
2779
  */
2531
2780
  S3StorageClass?: S3StorageClass | string;
2532
2781
  /**
2782
+ * @public
2533
2783
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access
2534
2784
  * an Amazon S3 bucket.</p>
2535
2785
  * <p>For detailed information about using such a role, see Creating a Location for
@@ -2537,6 +2787,7 @@ export interface DescribeLocationS3Response {
2537
2787
  */
2538
2788
  S3Config?: S3Config;
2539
2789
  /**
2790
+ * @public
2540
2791
  * <p>If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name
2541
2792
  * (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a
2542
2793
  * DataSync 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
@@ -2544,6 +2795,7 @@ export interface DescribeLocationS3Response {
2544
2795
  */
2545
2796
  AgentArns?: string[];
2546
2797
  /**
2798
+ * @public
2547
2799
  * <p>The time that the Amazon S3 bucket location was created.</p>
2548
2800
  */
2549
2801
  CreationTime?: Date;
@@ -2554,6 +2806,7 @@ export interface DescribeLocationS3Response {
2554
2806
  */
2555
2807
  export interface DescribeLocationSmbRequest {
2556
2808
  /**
2809
+ * @public
2557
2810
  * <p>The Amazon Resource Name (ARN) of the SMB location to describe.</p>
2558
2811
  */
2559
2812
  LocationArn: string | undefined;
@@ -2564,32 +2817,39 @@ export interface DescribeLocationSmbRequest {
2564
2817
  */
2565
2818
  export interface DescribeLocationSmbResponse {
2566
2819
  /**
2820
+ * @public
2567
2821
  * <p>The Amazon Resource Name (ARN) of the SMB location that was described.</p>
2568
2822
  */
2569
2823
  LocationArn?: string;
2570
2824
  /**
2825
+ * @public
2571
2826
  * <p>The URL of the source SMB location that was described.</p>
2572
2827
  */
2573
2828
  LocationUri?: string;
2574
2829
  /**
2830
+ * @public
2575
2831
  * <p>The Amazon Resource Name (ARN) of the source SMB file system location that is
2576
2832
  * created.</p>
2577
2833
  */
2578
2834
  AgentArns?: string[];
2579
2835
  /**
2836
+ * @public
2580
2837
  * <p>The user who can mount the share, has the permissions to access files and folders in the
2581
2838
  * SMB share.</p>
2582
2839
  */
2583
2840
  User?: string;
2584
2841
  /**
2842
+ * @public
2585
2843
  * <p>The name of the Windows domain that the SMB server belongs to.</p>
2586
2844
  */
2587
2845
  Domain?: string;
2588
2846
  /**
2847
+ * @public
2589
2848
  * <p>The mount options that are available for DataSync to use to access an SMB location.</p>
2590
2849
  */
2591
2850
  MountOptions?: SmbMountOptions;
2592
2851
  /**
2852
+ * @public
2593
2853
  * <p>The time that the SMB location was created.</p>
2594
2854
  */
2595
2855
  CreationTime?: Date;
@@ -2599,6 +2859,7 @@ export interface DescribeLocationSmbResponse {
2599
2859
  */
2600
2860
  export interface DescribeStorageSystemRequest {
2601
2861
  /**
2862
+ * @public
2602
2863
  * <p>Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're
2603
2864
  * using with DataSync Discovery.</p>
2604
2865
  */
@@ -2622,15 +2883,18 @@ export type StorageSystemConnectivityStatus = (typeof StorageSystemConnectivityS
2622
2883
  */
2623
2884
  export interface DescribeStorageSystemResponse {
2624
2885
  /**
2886
+ * @public
2625
2887
  * <p>The ARN of the on-premises storage system that the discovery job looked at.</p>
2626
2888
  */
2627
2889
  StorageSystemArn?: string;
2628
2890
  /**
2891
+ * @public
2629
2892
  * <p>The server name and network port required to connect with your on-premises storage
2630
2893
  * system's management interface.</p>
2631
2894
  */
2632
2895
  ServerConfiguration?: DiscoveryServerConfiguration;
2633
2896
  /**
2897
+ * @public
2634
2898
  * <p>The type of on-premises storage system.</p>
2635
2899
  * <note>
2636
2900
  * <p>DataSync Discovery currently only supports NetApp
@@ -2641,33 +2905,40 @@ export interface DescribeStorageSystemResponse {
2641
2905
  */
2642
2906
  SystemType?: DiscoverySystemType | string;
2643
2907
  /**
2908
+ * @public
2644
2909
  * <p>The ARN of the DataSync agent that connects to and reads from your on-premises storage
2645
2910
  * system.</p>
2646
2911
  */
2647
2912
  AgentArns?: string[];
2648
2913
  /**
2914
+ * @public
2649
2915
  * <p>The name that you gave your on-premises storage system when adding it to DataSync Discovery.</p>
2650
2916
  */
2651
2917
  Name?: string;
2652
2918
  /**
2919
+ * @public
2653
2920
  * <p>Describes the connectivity error that the DataSync agent is encountering with your
2654
2921
  * on-premises storage system.</p>
2655
2922
  */
2656
2923
  ErrorMessage?: string;
2657
2924
  /**
2925
+ * @public
2658
2926
  * <p>Indicates whether your DataSync agent can connect to your on-premises storage system.</p>
2659
2927
  */
2660
2928
  ConnectivityStatus?: StorageSystemConnectivityStatus | string;
2661
2929
  /**
2930
+ * @public
2662
2931
  * <p>The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery
2663
2932
  * job events.</p>
2664
2933
  */
2665
2934
  CloudWatchLogGroupArn?: string;
2666
2935
  /**
2936
+ * @public
2667
2937
  * <p>The time when you added the on-premises storage system to DataSync Discovery.</p>
2668
2938
  */
2669
2939
  CreationTime?: Date;
2670
2940
  /**
2941
+ * @public
2671
2942
  * <p>The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery
2672
2943
  * stores these credentials in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage">Secrets Manager</a>.</p>
2673
2944
  */
@@ -2691,34 +2962,41 @@ export type DiscoveryResourceType = (typeof DiscoveryResourceType)[keyof typeof
2691
2962
  */
2692
2963
  export interface DescribeStorageSystemResourceMetricsRequest {
2693
2964
  /**
2965
+ * @public
2694
2966
  * <p>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information
2695
2967
  * about your on-premises storage system.</p>
2696
2968
  */
2697
2969
  DiscoveryJobArn: string | undefined;
2698
2970
  /**
2971
+ * @public
2699
2972
  * <p>Specifies the kind of storage system resource that you want information about.</p>
2700
2973
  */
2701
2974
  ResourceType: DiscoveryResourceType | string | undefined;
2702
2975
  /**
2976
+ * @public
2703
2977
  * <p>Specifies the universally unique identifier (UUID) of the storage system resource that you
2704
2978
  * want information about.</p>
2705
2979
  */
2706
2980
  ResourceId: string | undefined;
2707
2981
  /**
2982
+ * @public
2708
2983
  * <p>Specifies a time within the total duration that the discovery job ran. To see information
2709
2984
  * gathered during a certain time frame, use this parameter with <code>EndTime</code>.</p>
2710
2985
  */
2711
2986
  StartTime?: Date;
2712
2987
  /**
2988
+ * @public
2713
2989
  * <p>Specifies a time within the total duration that the discovery job ran. To see information
2714
2990
  * gathered during a certain time frame, use this parameter with <code>StartTime</code>.</p>
2715
2991
  */
2716
2992
  EndTime?: Date;
2717
2993
  /**
2994
+ * @public
2718
2995
  * <p>Specifies how many results that you want in the response.</p>
2719
2996
  */
2720
2997
  MaxResults?: number;
2721
2998
  /**
2999
+ * @public
2722
3000
  * <p>Specifies an opaque string that indicates the position to begin the next list of results
2723
3001
  * in the response.</p>
2724
3002
  */
@@ -2732,18 +3010,22 @@ export interface DescribeStorageSystemResourceMetricsRequest {
2732
3010
  */
2733
3011
  export interface IOPS {
2734
3012
  /**
3013
+ * @public
2735
3014
  * <p>Peak IOPS related to read operations.</p>
2736
3015
  */
2737
3016
  Read?: number;
2738
3017
  /**
3018
+ * @public
2739
3019
  * <p>Peak IOPS related to write operations.</p>
2740
3020
  */
2741
3021
  Write?: number;
2742
3022
  /**
3023
+ * @public
2743
3024
  * <p>Peak IOPS unrelated to read and write operations.</p>
2744
3025
  */
2745
3026
  Other?: number;
2746
3027
  /**
3028
+ * @public
2747
3029
  * <p>Peak total IOPS on your on-premises storage system resource.</p>
2748
3030
  */
2749
3031
  Total?: number;
@@ -2756,14 +3038,17 @@ export interface IOPS {
2756
3038
  */
2757
3039
  export interface Latency {
2758
3040
  /**
3041
+ * @public
2759
3042
  * <p>Peak latency for read operations.</p>
2760
3043
  */
2761
3044
  Read?: number;
2762
3045
  /**
3046
+ * @public
2763
3047
  * <p>Peak latency for write operations.</p>
2764
3048
  */
2765
3049
  Write?: number;
2766
3050
  /**
3051
+ * @public
2767
3052
  * <p>Peak latency for operations unrelated to read and write operations.</p>
2768
3053
  */
2769
3054
  Other?: number;
@@ -2775,18 +3060,22 @@ export interface Latency {
2775
3060
  */
2776
3061
  export interface Throughput {
2777
3062
  /**
3063
+ * @public
2778
3064
  * <p>Peak throughput related to read operations.</p>
2779
3065
  */
2780
3066
  Read?: number;
2781
3067
  /**
3068
+ * @public
2782
3069
  * <p>Peak throughput related to write operations.</p>
2783
3070
  */
2784
3071
  Write?: number;
2785
3072
  /**
3073
+ * @public
2786
3074
  * <p>Peak throughput unrelated to read and write operations.</p>
2787
3075
  */
2788
3076
  Other?: number;
2789
3077
  /**
3078
+ * @public
2790
3079
  * <p>Peak total throughput on your on-premises storage system resource.</p>
2791
3080
  */
2792
3081
  Total?: number;
@@ -2798,16 +3087,19 @@ export interface Throughput {
2798
3087
  */
2799
3088
  export interface P95Metrics {
2800
3089
  /**
3090
+ * @public
2801
3091
  * <p>The IOPS peaks for an on-premises storage system resource. Each data point represents the
2802
3092
  * 95th percentile peak value during a 1-hour interval.</p>
2803
3093
  */
2804
3094
  IOPS?: IOPS;
2805
3095
  /**
3096
+ * @public
2806
3097
  * <p>The throughput peaks for an on-premises storage system resource. Each data point
2807
3098
  * represents the 95th percentile peak value during a 1-hour interval.</p>
2808
3099
  */
2809
3100
  Throughput?: Throughput;
2810
3101
  /**
3102
+ * @public
2811
3103
  * <p>The latency peaks for an on-premises storage system resource. Each data point represents
2812
3104
  * the 95th percentile peak value during a 1-hour interval.</p>
2813
3105
  */
@@ -2820,25 +3112,30 @@ export interface P95Metrics {
2820
3112
  */
2821
3113
  export interface ResourceMetrics {
2822
3114
  /**
3115
+ * @public
2823
3116
  * <p>The time when DataSync Discovery collected this information from the
2824
3117
  * resource.</p>
2825
3118
  */
2826
3119
  Timestamp?: Date;
2827
3120
  /**
3121
+ * @public
2828
3122
  * <p>The types of performance data that DataSync Discovery collects about the on-premises storage system
2829
3123
  * resource.</p>
2830
3124
  */
2831
3125
  P95Metrics?: P95Metrics;
2832
3126
  /**
3127
+ * @public
2833
3128
  * <p>The storage capacity of the on-premises storage system resource.</p>
2834
3129
  */
2835
3130
  Capacity?: Capacity;
2836
3131
  /**
3132
+ * @public
2837
3133
  * <p>The universally unique identifier (UUID) of the on-premises storage system
2838
3134
  * resource.</p>
2839
3135
  */
2840
3136
  ResourceId?: string;
2841
3137
  /**
3138
+ * @public
2842
3139
  * <p>The type of on-premises storage system resource.</p>
2843
3140
  */
2844
3141
  ResourceType?: DiscoveryResourceType | string;
@@ -2848,10 +3145,12 @@ export interface ResourceMetrics {
2848
3145
  */
2849
3146
  export interface DescribeStorageSystemResourceMetricsResponse {
2850
3147
  /**
3148
+ * @public
2851
3149
  * <p>The details that your discovery job collected about your storage system resource.</p>
2852
3150
  */
2853
3151
  Metrics?: ResourceMetrics[];
2854
3152
  /**
3153
+ * @public
2855
3154
  * <p>The opaque string that indicates the position to begin the next list of results in the
2856
3155
  * response.</p>
2857
3156
  */
@@ -2873,31 +3172,37 @@ export type DiscoveryResourceFilter = (typeof DiscoveryResourceFilter)[keyof typ
2873
3172
  */
2874
3173
  export interface DescribeStorageSystemResourcesRequest {
2875
3174
  /**
3175
+ * @public
2876
3176
  * <p>Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from
2877
3177
  * your on-premises storage system.</p>
2878
3178
  */
2879
3179
  DiscoveryJobArn: string | undefined;
2880
3180
  /**
3181
+ * @public
2881
3182
  * <p>Specifies what kind of storage system resources that you want information about.</p>
2882
3183
  */
2883
3184
  ResourceType: DiscoveryResourceType | string | undefined;
2884
3185
  /**
3186
+ * @public
2885
3187
  * <p>Specifies the universally unique identifiers (UUIDs) of the storage system resources that
2886
3188
  * you want information about. You can't use this parameter in combination with the
2887
3189
  * <code>Filter</code> parameter.</p>
2888
3190
  */
2889
3191
  ResourceIds?: string[];
2890
3192
  /**
3193
+ * @public
2891
3194
  * <p>Filters the storage system resources that you want returned. For example, this might be
2892
3195
  * volumes associated with a specific storage virtual machine (SVM).</p>
2893
3196
  */
2894
3197
  Filter?: Record<string, string[]>;
2895
3198
  /**
3199
+ * @public
2896
3200
  * <p>Specifies the maximum number of storage system resources that you want to list in a
2897
3201
  * response.</p>
2898
3202
  */
2899
3203
  MaxResults?: number;
2900
3204
  /**
3205
+ * @public
2901
3206
  * <p>Specifies an opaque string that indicates the position to begin the next list of results
2902
3207
  * in the response.</p>
2903
3208
  */
@@ -2910,46 +3215,57 @@ export interface DescribeStorageSystemResourcesRequest {
2910
3215
  */
2911
3216
  export interface MaxP95Performance {
2912
3217
  /**
3218
+ * @public
2913
3219
  * <p>Peak IOPS related to read operations.</p>
2914
3220
  */
2915
3221
  IopsRead?: number;
2916
3222
  /**
3223
+ * @public
2917
3224
  * <p>Peak IOPS related to write operations.</p>
2918
3225
  */
2919
3226
  IopsWrite?: number;
2920
3227
  /**
3228
+ * @public
2921
3229
  * <p>Peak IOPS unrelated to read and write operations.</p>
2922
3230
  */
2923
3231
  IopsOther?: number;
2924
3232
  /**
3233
+ * @public
2925
3234
  * <p>Peak total IOPS on your on-premises storage system resource.</p>
2926
3235
  */
2927
3236
  IopsTotal?: number;
2928
3237
  /**
3238
+ * @public
2929
3239
  * <p>Peak throughput related to read operations.</p>
2930
3240
  */
2931
3241
  ThroughputRead?: number;
2932
3242
  /**
3243
+ * @public
2933
3244
  * <p>Peak throughput related to write operations.</p>
2934
3245
  */
2935
3246
  ThroughputWrite?: number;
2936
3247
  /**
3248
+ * @public
2937
3249
  * <p>Peak throughput unrelated to read and write operations.</p>
2938
3250
  */
2939
3251
  ThroughputOther?: number;
2940
3252
  /**
3253
+ * @public
2941
3254
  * <p>Peak total throughput on your on-premises storage system resource.</p>
2942
3255
  */
2943
3256
  ThroughputTotal?: number;
2944
3257
  /**
3258
+ * @public
2945
3259
  * <p>Peak latency for read operations.</p>
2946
3260
  */
2947
3261
  LatencyRead?: number;
2948
3262
  /**
3263
+ * @public
2949
3264
  * <p>Peak latency for write operations.</p>
2950
3265
  */
2951
3266
  LatencyWrite?: number;
2952
3267
  /**
3268
+ * @public
2953
3269
  * <p>Peak latency for operations unrelated to read and write operations.</p>
2954
3270
  */
2955
3271
  LatencyOther?: number;
@@ -2963,16 +3279,19 @@ export interface MaxP95Performance {
2963
3279
  */
2964
3280
  export interface Recommendation {
2965
3281
  /**
3282
+ * @public
2966
3283
  * <p>A recommended Amazon Web Services storage service that you can migrate data to based on
2967
3284
  * information that DataSync Discovery collects about your on-premises storage system.</p>
2968
3285
  */
2969
3286
  StorageType?: string;
2970
3287
  /**
3288
+ * @public
2971
3289
  * <p>Information about how you can set up a recommended Amazon Web Services storage
2972
3290
  * service.</p>
2973
3291
  */
2974
3292
  StorageConfiguration?: Record<string, string>;
2975
3293
  /**
3294
+ * @public
2976
3295
  * <p>The estimated monthly cost of the recommended Amazon Web Services storage service.</p>
2977
3296
  */
2978
3297
  EstimatedMonthlyStorageCost?: string;
@@ -2998,54 +3317,70 @@ export type RecommendationStatus = (typeof RecommendationStatus)[keyof typeof Re
2998
3317
  */
2999
3318
  export interface NetAppONTAPCluster {
3000
3319
  /**
3320
+ * @public
3001
3321
  * <p>The number of CIFS shares in the cluster.</p>
3002
3322
  */
3003
3323
  CifsShareCount?: number;
3004
3324
  /**
3325
+ * @public
3005
3326
  * <p>The number of NFS volumes in the cluster.</p>
3006
3327
  */
3007
3328
  NfsExportedVolumes?: number;
3008
3329
  /**
3330
+ * @public
3009
3331
  * <p>The universally unique identifier (UUID) of the cluster.</p>
3010
3332
  */
3011
3333
  ResourceId?: string;
3012
3334
  /**
3335
+ * @public
3013
3336
  * <p>The name of the cluster.</p>
3014
3337
  */
3015
3338
  ClusterName?: string;
3016
3339
  /**
3340
+ * @public
3017
3341
  * <p>The performance data that DataSync Discovery collects about the cluster.</p>
3018
3342
  */
3019
3343
  MaxP95Performance?: MaxP95Performance;
3020
3344
  /**
3345
+ * @public
3021
3346
  * <p>The total storage space that's available in the cluster.</p>
3022
3347
  */
3023
3348
  ClusterBlockStorageSize?: number;
3024
3349
  /**
3350
+ * @public
3025
3351
  * <p>The storage space that's being used in a cluster.</p>
3026
3352
  */
3027
3353
  ClusterBlockStorageUsed?: number;
3028
3354
  /**
3355
+ * @public
3029
3356
  * <p>The storage space that's being used in the cluster without accounting for compression or
3030
3357
  * deduplication.</p>
3031
3358
  */
3032
3359
  ClusterBlockStorageLogicalUsed?: number;
3033
3360
  /**
3361
+ * @public
3034
3362
  * <p>The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For
3035
3363
  * more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
3036
3364
  * provided by DataSync Discovery</a>.</p>
3037
3365
  */
3038
3366
  Recommendations?: Recommendation[];
3039
3367
  /**
3368
+ * @public
3040
3369
  * <p>Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete,
3041
3370
  * or can't be determined.</p>
3042
3371
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
3043
3372
  */
3044
3373
  RecommendationStatus?: RecommendationStatus | string;
3045
3374
  /**
3375
+ * @public
3046
3376
  * <p>The number of LUNs (logical unit numbers) in the cluster.</p>
3047
3377
  */
3048
3378
  LunCount?: number;
3379
+ /**
3380
+ * @public
3381
+ * <p>The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).</p>
3382
+ */
3383
+ ClusterCloudStorageUsed?: number;
3049
3384
  }
3050
3385
  /**
3051
3386
  * @public
@@ -3054,63 +3389,77 @@ export interface NetAppONTAPCluster {
3054
3389
  */
3055
3390
  export interface NetAppONTAPSVM {
3056
3391
  /**
3392
+ * @public
3057
3393
  * <p>The universally unique identifier (UUID) of the cluster associated with the SVM.</p>
3058
3394
  */
3059
3395
  ClusterUuid?: string;
3060
3396
  /**
3397
+ * @public
3061
3398
  * <p>The UUID of the SVM.</p>
3062
3399
  */
3063
3400
  ResourceId?: string;
3064
3401
  /**
3402
+ * @public
3065
3403
  * <p>The name of the SVM</p>
3066
3404
  */
3067
3405
  SvmName?: string;
3068
3406
  /**
3407
+ * @public
3069
3408
  * <p>The number of CIFS shares in the SVM.</p>
3070
3409
  */
3071
3410
  CifsShareCount?: number;
3072
3411
  /**
3412
+ * @public
3073
3413
  * <p>The data transfer protocols (such as NFS) configured for the SVM.</p>
3074
3414
  */
3075
3415
  EnabledProtocols?: string[];
3076
3416
  /**
3417
+ * @public
3077
3418
  * <p>The storage space that's being used in the SVM.</p>
3078
3419
  */
3079
3420
  TotalCapacityUsed?: number;
3080
3421
  /**
3422
+ * @public
3081
3423
  * <p>The total storage space that's available in the SVM.</p>
3082
3424
  */
3083
3425
  TotalCapacityProvisioned?: number;
3084
3426
  /**
3427
+ * @public
3085
3428
  * <p>The storage space that's being used in the SVM without accounting for compression or
3086
3429
  * deduplication.</p>
3087
3430
  */
3088
3431
  TotalLogicalCapacityUsed?: number;
3089
3432
  /**
3433
+ * @public
3090
3434
  * <p>The performance data that DataSync Discovery collects about the SVM.</p>
3091
3435
  */
3092
3436
  MaxP95Performance?: MaxP95Performance;
3093
3437
  /**
3438
+ * @public
3094
3439
  * <p>The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more
3095
3440
  * information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
3096
3441
  * provided by DataSync Discovery</a>.</p>
3097
3442
  */
3098
3443
  Recommendations?: Recommendation[];
3099
3444
  /**
3445
+ * @public
3100
3446
  * <p>The number of NFS volumes in the SVM.</p>
3101
3447
  */
3102
3448
  NfsExportedVolumes?: number;
3103
3449
  /**
3450
+ * @public
3104
3451
  * <p>Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or
3105
3452
  * can't be determined.</p>
3106
3453
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
3107
3454
  */
3108
3455
  RecommendationStatus?: RecommendationStatus | string;
3109
3456
  /**
3457
+ * @public
3110
3458
  * <p>The amount of storage in the SVM that's being used for snapshots.</p>
3111
3459
  */
3112
3460
  TotalSnapshotCapacityUsed?: number;
3113
3461
  /**
3462
+ * @public
3114
3463
  * <p>The number of LUNs (logical unit numbers) in the SVM.</p>
3115
3464
  */
3116
3465
  LunCount?: number;
@@ -3122,67 +3471,82 @@ export interface NetAppONTAPSVM {
3122
3471
  */
3123
3472
  export interface NetAppONTAPVolume {
3124
3473
  /**
3474
+ * @public
3125
3475
  * <p>The name of the volume.</p>
3126
3476
  */
3127
3477
  VolumeName?: string;
3128
3478
  /**
3479
+ * @public
3129
3480
  * <p>The universally unique identifier (UUID) of the volume.</p>
3130
3481
  */
3131
3482
  ResourceId?: string;
3132
3483
  /**
3484
+ * @public
3133
3485
  * <p>The number of CIFS shares in the volume.</p>
3134
3486
  */
3135
3487
  CifsShareCount?: number;
3136
3488
  /**
3489
+ * @public
3137
3490
  * <p>The volume's security style (such as Unix or NTFS).</p>
3138
3491
  */
3139
3492
  SecurityStyle?: string;
3140
3493
  /**
3494
+ * @public
3141
3495
  * <p>The UUID of the storage virtual machine (SVM) associated with the volume.</p>
3142
3496
  */
3143
3497
  SvmUuid?: string;
3144
3498
  /**
3499
+ * @public
3145
3500
  * <p>The name of the SVM associated with the volume.</p>
3146
3501
  */
3147
3502
  SvmName?: string;
3148
3503
  /**
3504
+ * @public
3149
3505
  * <p>The storage space that's being used in the volume.</p>
3150
3506
  */
3151
3507
  CapacityUsed?: number;
3152
3508
  /**
3509
+ * @public
3153
3510
  * <p>The total storage space that's available in the volume.</p>
3154
3511
  */
3155
3512
  CapacityProvisioned?: number;
3156
3513
  /**
3514
+ * @public
3157
3515
  * <p>The storage space that's being used in the volume without accounting for compression or
3158
3516
  * deduplication.</p>
3159
3517
  */
3160
3518
  LogicalCapacityUsed?: number;
3161
3519
  /**
3520
+ * @public
3162
3521
  * <p>The number of NFS volumes in the volume.</p>
3163
3522
  */
3164
3523
  NfsExported?: boolean;
3165
3524
  /**
3525
+ * @public
3166
3526
  * <p>The amount of storage in the volume that's being used for snapshots.</p>
3167
3527
  */
3168
3528
  SnapshotCapacityUsed?: number;
3169
3529
  /**
3530
+ * @public
3170
3531
  * <p>The performance data that DataSync Discovery collects about the volume.</p>
3171
3532
  */
3172
3533
  MaxP95Performance?: MaxP95Performance;
3173
3534
  /**
3535
+ * @public
3174
3536
  * <p>The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more
3175
3537
  * information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations
3176
3538
  * provided by DataSync Discovery</a>.</p>
3177
3539
  */
3178
3540
  Recommendations?: Recommendation[];
3179
3541
  /**
3542
+ * @public
3180
3543
  * <p>Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete,
3181
3544
  * or can't be determined.</p>
3182
3545
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table">Recommendation statuses</a>.</p>
3183
3546
  */
3184
3547
  RecommendationStatus?: RecommendationStatus | string;
3185
3548
  /**
3549
+ * @public
3186
3550
  * <p>The number of LUNs (logical unit numbers) in the volume.</p>
3187
3551
  */
3188
3552
  LunCount?: number;
@@ -3194,16 +3558,19 @@ export interface NetAppONTAPVolume {
3194
3558
  */
3195
3559
  export interface ResourceDetails {
3196
3560
  /**
3561
+ * @public
3197
3562
  * <p>The information that DataSync Discovery collects about storage virtual machines (SVMs) in your
3198
3563
  * on-premises storage system.</p>
3199
3564
  */
3200
3565
  NetAppONTAPSVMs?: NetAppONTAPSVM[];
3201
3566
  /**
3567
+ * @public
3202
3568
  * <p>The information that DataSync Discovery collects about volumes in your on-premises storage
3203
3569
  * system.</p>
3204
3570
  */
3205
3571
  NetAppONTAPVolumes?: NetAppONTAPVolume[];
3206
3572
  /**
3573
+ * @public
3207
3574
  * <p>The information that DataSync Discovery collects about the
3208
3575
  * cluster
3209
3576
  * in your on-premises storage system.</p>
@@ -3215,6 +3582,7 @@ export interface ResourceDetails {
3215
3582
  */
3216
3583
  export interface DescribeStorageSystemResourcesResponse {
3217
3584
  /**
3585
+ * @public
3218
3586
  * <p>The information collected about your storage system's resources. A response can also
3219
3587
  * include Amazon Web Services storage service recommendations.</p>
3220
3588
  * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html">storage resource
@@ -3222,6 +3590,7 @@ export interface DescribeStorageSystemResourcesResponse {
3222
3590
  */
3223
3591
  ResourceDetails?: ResourceDetails;
3224
3592
  /**
3593
+ * @public
3225
3594
  * <p>The opaque string that indicates the position to begin the next list of results in the
3226
3595
  * response.</p>
3227
3596
  */
@@ -3233,6 +3602,7 @@ export interface DescribeStorageSystemResourcesResponse {
3233
3602
  */
3234
3603
  export interface DescribeTaskRequest {
3235
3604
  /**
3605
+ * @public
3236
3606
  * <p>Specifies the Amazon Resource Name (ARN) of the transfer task.</p>
3237
3607
  */
3238
3608
  TaskArn: string | undefined;
@@ -3258,34 +3628,41 @@ export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
3258
3628
  */
3259
3629
  export interface DescribeTaskResponse {
3260
3630
  /**
3631
+ * @public
3261
3632
  * <p>The Amazon Resource Name (ARN) of the task that was described.</p>
3262
3633
  */
3263
3634
  TaskArn?: string;
3264
3635
  /**
3636
+ * @public
3265
3637
  * <p>The status of the task that was described.</p>
3266
3638
  * <p>For detailed information about task execution statuses, see Understanding
3267
3639
  * Task Statuses in the <i>DataSync User Guide</i>.</p>
3268
3640
  */
3269
3641
  Status?: TaskStatus | string;
3270
3642
  /**
3643
+ * @public
3271
3644
  * <p>The name of the task that was described.</p>
3272
3645
  */
3273
3646
  Name?: string;
3274
3647
  /**
3648
+ * @public
3275
3649
  * <p>The Amazon Resource Name (ARN) of the task execution that is transferring
3276
3650
  * files.</p>
3277
3651
  */
3278
3652
  CurrentTaskExecutionArn?: string;
3279
3653
  /**
3654
+ * @public
3280
3655
  * <p>The Amazon Resource Name (ARN) of the source file system's location.</p>
3281
3656
  */
3282
3657
  SourceLocationArn?: string;
3283
3658
  /**
3659
+ * @public
3284
3660
  * <p>The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's
3285
3661
  * location.</p>
3286
3662
  */
3287
3663
  DestinationLocationArn?: string;
3288
3664
  /**
3665
+ * @public
3289
3666
  * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to
3290
3667
  * monitor and log events in the task.</p>
3291
3668
  * <p>For more information on these groups, see Working with Log Groups and Log
@@ -3293,18 +3670,21 @@ export interface DescribeTaskResponse {
3293
3670
  */
3294
3671
  CloudWatchLogGroupArn?: string;
3295
3672
  /**
3673
+ * @public
3296
3674
  * <p>The Amazon Resource Names (ARNs) of the network interfaces created for your source
3297
3675
  * location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network
3298
3676
  * interface requirements</a>.</p>
3299
3677
  */
3300
3678
  SourceNetworkInterfaceArns?: string[];
3301
3679
  /**
3680
+ * @public
3302
3681
  * <p>The Amazon Resource Names (ARNs) of the network interfaces created for your destination
3303
3682
  * location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">Network
3304
3683
  * interface requirements</a>.</p>
3305
3684
  */
3306
3685
  DestinationNetworkInterfaceArns?: string[];
3307
3686
  /**
3687
+ * @public
3308
3688
  * <p>The configuration options that control the behavior of the
3309
3689
  * <code>StartTaskExecution</code> operation. Some options include preserving file or object
3310
3690
  * metadata and verifying data integrity.</p>
@@ -3313,30 +3693,36 @@ export interface DescribeTaskResponse {
3313
3693
  */
3314
3694
  Options?: Options;
3315
3695
  /**
3696
+ * @public
3316
3697
  * <p>A list of filter rules that exclude specific data during your transfer. For more
3317
3698
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
3318
3699
  */
3319
3700
  Excludes?: FilterRule[];
3320
3701
  /**
3702
+ * @public
3321
3703
  * <p>The schedule used to periodically transfer files from a source to a destination
3322
3704
  * location.</p>
3323
3705
  */
3324
3706
  Schedule?: TaskSchedule;
3325
3707
  /**
3708
+ * @public
3326
3709
  * <p>Errors that DataSync encountered during execution of the task. You can
3327
3710
  * use this error code to help troubleshoot issues.</p>
3328
3711
  */
3329
3712
  ErrorCode?: string;
3330
3713
  /**
3714
+ * @public
3331
3715
  * <p>Detailed description of an error that was encountered during the task execution. You
3332
3716
  * can use this information to help troubleshoot issues. </p>
3333
3717
  */
3334
3718
  ErrorDetail?: string;
3335
3719
  /**
3720
+ * @public
3336
3721
  * <p>The time that the task was created.</p>
3337
3722
  */
3338
3723
  CreationTime?: Date;
3339
3724
  /**
3725
+ * @public
3340
3726
  * <p>A list of filter rules that include specific data during your transfer. For more
3341
3727
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
3342
3728
  */
@@ -3348,6 +3734,7 @@ export interface DescribeTaskResponse {
3348
3734
  */
3349
3735
  export interface DescribeTaskExecutionRequest {
3350
3736
  /**
3737
+ * @public
3351
3738
  * <p>Specifies the Amazon Resource Name (ARN) of the transfer task that's running.</p>
3352
3739
  */
3353
3740
  TaskExecutionArn: string | undefined;
@@ -3373,43 +3760,52 @@ export type PhaseStatus = (typeof PhaseStatus)[keyof typeof PhaseStatus];
3373
3760
  */
3374
3761
  export interface TaskExecutionResultDetail {
3375
3762
  /**
3763
+ * @public
3376
3764
  * <p>The total time in milliseconds that DataSync spent in the PREPARING
3377
3765
  * phase. </p>
3378
3766
  */
3379
3767
  PrepareDuration?: number;
3380
3768
  /**
3769
+ * @public
3381
3770
  * <p>The status of the PREPARING phase.</p>
3382
3771
  */
3383
3772
  PrepareStatus?: PhaseStatus | string;
3384
3773
  /**
3774
+ * @public
3385
3775
  * <p>The total time in milliseconds that DataSync took to transfer the file from
3386
3776
  * the source to the destination location.</p>
3387
3777
  */
3388
3778
  TotalDuration?: number;
3389
3779
  /**
3780
+ * @public
3390
3781
  * <p>The total time in milliseconds that DataSync spent in the TRANSFERRING
3391
3782
  * phase.</p>
3392
3783
  */
3393
3784
  TransferDuration?: number;
3394
3785
  /**
3786
+ * @public
3395
3787
  * <p>The status of the TRANSFERRING phase.</p>
3396
3788
  */
3397
3789
  TransferStatus?: PhaseStatus | string;
3398
3790
  /**
3791
+ * @public
3399
3792
  * <p>The total time in milliseconds that DataSync spent in the VERIFYING
3400
3793
  * phase.</p>
3401
3794
  */
3402
3795
  VerifyDuration?: number;
3403
3796
  /**
3797
+ * @public
3404
3798
  * <p>The status of the VERIFYING phase.</p>
3405
3799
  */
3406
3800
  VerifyStatus?: PhaseStatus | string;
3407
3801
  /**
3802
+ * @public
3408
3803
  * <p>Errors that DataSync encountered during execution of the task. You can
3409
3804
  * use this error code to help troubleshoot issues.</p>
3410
3805
  */
3411
3806
  ErrorCode?: string;
3412
3807
  /**
3808
+ * @public
3413
3809
  * <p>Detailed description of an error that was encountered during the task execution. You
3414
3810
  * can use this information to help troubleshoot issues. </p>
3415
3811
  */
@@ -3438,6 +3834,7 @@ export type TaskExecutionStatus = (typeof TaskExecutionStatus)[keyof typeof Task
3438
3834
  */
3439
3835
  export interface DescribeTaskExecutionResponse {
3440
3836
  /**
3837
+ * @public
3441
3838
  * <p>The Amazon Resource Name (ARN) of the task execution that was described.
3442
3839
  * <code>TaskExecutionArn</code> is hierarchical and includes <code>TaskArn</code> for the task
3443
3840
  * that was executed. </p>
@@ -3448,6 +3845,7 @@ export interface DescribeTaskExecutionResponse {
3448
3845
  */
3449
3846
  TaskExecutionArn?: string;
3450
3847
  /**
3848
+ * @public
3451
3849
  * <p>The status of the task execution. </p>
3452
3850
  * <p>For detailed information about task execution statuses, see Understanding
3453
3851
  * Task Statuses in the <i>DataSync User Guide.</i>
@@ -3455,6 +3853,7 @@ export interface DescribeTaskExecutionResponse {
3455
3853
  */
3456
3854
  Status?: TaskExecutionStatus | string;
3457
3855
  /**
3856
+ * @public
3458
3857
  * <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
3459
3858
  * DataSync verifies data integrity, set bandwidth limits for your task, among other
3460
3859
  * options.</p>
@@ -3463,20 +3862,24 @@ export interface DescribeTaskExecutionResponse {
3463
3862
  */
3464
3863
  Options?: Options;
3465
3864
  /**
3865
+ * @public
3466
3866
  * <p>A list of filter rules that exclude specific data during your transfer. For more
3467
3867
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
3468
3868
  */
3469
3869
  Excludes?: FilterRule[];
3470
3870
  /**
3871
+ * @public
3471
3872
  * <p>A list of filter rules that include specific data during your transfer. For more
3472
3873
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
3473
3874
  */
3474
3875
  Includes?: FilterRule[];
3475
3876
  /**
3877
+ * @public
3476
3878
  * <p>The time that the task execution was started.</p>
3477
3879
  */
3478
3880
  StartTime?: Date;
3479
3881
  /**
3882
+ * @public
3480
3883
  * <p>The expected number of files that is to be transferred over the network. This value is
3481
3884
  * calculated during the <code>PREPARING</code> phase before the <code>TRANSFERRING</code> phase
3482
3885
  * of the task execution. This value is the expected number of files to be transferred. It's
@@ -3485,11 +3888,13 @@ export interface DescribeTaskExecutionResponse {
3485
3888
  */
3486
3889
  EstimatedFilesToTransfer?: number;
3487
3890
  /**
3891
+ * @public
3488
3892
  * <p>The estimated physical number of bytes that is to be transferred over the
3489
3893
  * network.</p>
3490
3894
  */
3491
3895
  EstimatedBytesToTransfer?: number;
3492
3896
  /**
3897
+ * @public
3493
3898
  * <p>The actual number of files that was transferred over the network. This value is
3494
3899
  * calculated and updated on an ongoing basis during the <code>TRANSFERRING</code> phase of the
3495
3900
  * task execution. It's updated periodically when each file is read from the source and sent over
@@ -3502,20 +3907,24 @@ export interface DescribeTaskExecutionResponse {
3502
3907
  */
3503
3908
  FilesTransferred?: number;
3504
3909
  /**
3910
+ * @public
3505
3911
  * <p>The number of logical bytes written to the destination Amazon Web Services storage
3506
3912
  * resource.</p>
3507
3913
  */
3508
3914
  BytesWritten?: number;
3509
3915
  /**
3916
+ * @public
3510
3917
  * <p>The total number of bytes that are involved in the transfer. For the number of bytes
3511
3918
  * sent over the network, see <code>BytesCompressed</code>. </p>
3512
3919
  */
3513
3920
  BytesTransferred?: number;
3514
3921
  /**
3922
+ * @public
3515
3923
  * <p>The result of the task execution.</p>
3516
3924
  */
3517
3925
  Result?: TaskExecutionResultDetail;
3518
3926
  /**
3927
+ * @public
3519
3928
  * <p>The physical number of bytes transferred over the network after compression was applied.
3520
3929
  * In most cases, this number is less than <code>BytesTransferred</code> unless the data isn't
3521
3930
  * compressible.</p>
@@ -3528,10 +3937,12 @@ export interface DescribeTaskExecutionResponse {
3528
3937
  */
3529
3938
  export interface DiscoveryJobListEntry {
3530
3939
  /**
3940
+ * @public
3531
3941
  * <p>The Amazon Resource Name (ARN) of a discovery job.</p>
3532
3942
  */
3533
3943
  DiscoveryJobArn?: string;
3534
3944
  /**
3945
+ * @public
3535
3946
  * <p>The status of a discovery job. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table">Discovery job statuses</a>.</p>
3536
3947
  */
3537
3948
  Status?: DiscoveryJobStatus | string;
@@ -3541,16 +3952,19 @@ export interface DiscoveryJobListEntry {
3541
3952
  */
3542
3953
  export interface GenerateRecommendationsRequest {
3543
3954
  /**
3955
+ * @public
3544
3956
  * <p>Specifies the Amazon Resource Name (ARN) of the discovery job that collects information
3545
3957
  * about your on-premises storage system.</p>
3546
3958
  */
3547
3959
  DiscoveryJobArn: string | undefined;
3548
3960
  /**
3961
+ * @public
3549
3962
  * <p>Specifies the universally unique identifiers (UUIDs) of the resources in your storage
3550
3963
  * system that you want recommendations on.</p>
3551
3964
  */
3552
3965
  ResourceIds: string[] | undefined;
3553
3966
  /**
3967
+ * @public
3554
3968
  * <p>Specifies the type of resource in your storage system that you want recommendations
3555
3969
  * on.</p>
3556
3970
  */
@@ -3567,11 +3981,13 @@ export interface GenerateRecommendationsResponse {
3567
3981
  */
3568
3982
  export interface ListAgentsRequest {
3569
3983
  /**
3984
+ * @public
3570
3985
  * <p>Specifies the maximum number of DataSync agents to list in a response. By
3571
3986
  * default, a response shows a maximum of 100 agents.</p>
3572
3987
  */
3573
3988
  MaxResults?: number;
3574
3989
  /**
3990
+ * @public
3575
3991
  * <p>Specifies an opaque string that indicates the position to begin the next list of
3576
3992
  * results in the response.</p>
3577
3993
  */
@@ -3583,11 +3999,13 @@ export interface ListAgentsRequest {
3583
3999
  */
3584
4000
  export interface ListAgentsResponse {
3585
4001
  /**
4002
+ * @public
3586
4003
  * <p>A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents' Amazon
3587
4004
  * Resource Names (ARNs).</p>
3588
4005
  */
3589
4006
  Agents?: AgentListEntry[];
3590
4007
  /**
4008
+ * @public
3591
4009
  * <p>The opaque string that indicates the position to begin the next list of results in the
3592
4010
  * response.</p>
3593
4011
  */
@@ -3598,16 +4016,19 @@ export interface ListAgentsResponse {
3598
4016
  */
3599
4017
  export interface ListDiscoveryJobsRequest {
3600
4018
  /**
4019
+ * @public
3601
4020
  * <p>Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this
3602
4021
  * parameter if you only want to list the discovery jobs that are associated with a specific
3603
4022
  * storage system.</p>
3604
4023
  */
3605
4024
  StorageSystemArn?: string;
3606
4025
  /**
4026
+ * @public
3607
4027
  * <p>Specifies how many results you want in the response.</p>
3608
4028
  */
3609
4029
  MaxResults?: number;
3610
4030
  /**
4031
+ * @public
3611
4032
  * <p>Specifies an opaque string that indicates the position to begin the next list of results
3612
4033
  * in the response.</p>
3613
4034
  */
@@ -3618,10 +4039,12 @@ export interface ListDiscoveryJobsRequest {
3618
4039
  */
3619
4040
  export interface ListDiscoveryJobsResponse {
3620
4041
  /**
4042
+ * @public
3621
4043
  * <p>The discovery jobs that you've run.</p>
3622
4044
  */
3623
4045
  DiscoveryJobs?: DiscoveryJobListEntry[];
3624
4046
  /**
4047
+ * @public
3625
4048
  * <p>The opaque string that indicates the position to begin the next list of results in the
3626
4049
  * response.</p>
3627
4050
  */
@@ -3670,17 +4093,20 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
3670
4093
  */
3671
4094
  export interface LocationFilter {
3672
4095
  /**
4096
+ * @public
3673
4097
  * <p>The name of the filter being used. Each API call supports a list of filters that are
3674
4098
  * available for it (for example, <code>LocationType</code> for
3675
4099
  * <code>ListLocations</code>).</p>
3676
4100
  */
3677
4101
  Name: LocationFilterName | string | undefined;
3678
4102
  /**
4103
+ * @public
3679
4104
  * <p>The values that you want to filter for. For example, you might want to display only Amazon
3680
4105
  * S3 locations.</p>
3681
4106
  */
3682
4107
  Values: string[] | undefined;
3683
4108
  /**
4109
+ * @public
3684
4110
  * <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
3685
4111
  * <code>Contains</code>).</p>
3686
4112
  */
@@ -3692,15 +4118,18 @@ export interface LocationFilter {
3692
4118
  */
3693
4119
  export interface ListLocationsRequest {
3694
4120
  /**
4121
+ * @public
3695
4122
  * <p>The maximum number of locations to return.</p>
3696
4123
  */
3697
4124
  MaxResults?: number;
3698
4125
  /**
4126
+ * @public
3699
4127
  * <p>An opaque string that indicates the position at which to begin the next list of
3700
4128
  * locations.</p>
3701
4129
  */
3702
4130
  NextToken?: string;
3703
4131
  /**
4132
+ * @public
3704
4133
  * <p>You can use API filters to narrow down the list of resources returned by
3705
4134
  * <code>ListLocations</code>. For example, to retrieve all tasks on a specific source
3706
4135
  * location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code>
@@ -3716,12 +4145,14 @@ export interface ListLocationsRequest {
3716
4145
  */
3717
4146
  export interface LocationListEntry {
3718
4147
  /**
4148
+ * @public
3719
4149
  * <p>The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon
3720
4150
  * EFS, the location is the export path. For Amazon S3, the location is the prefix path that you
3721
4151
  * want to mount and use as the root of the location.</p>
3722
4152
  */
3723
4153
  LocationArn?: string;
3724
4154
  /**
4155
+ * @public
3725
4156
  * <p>Represents a list of URIs of a location. <code>LocationUri</code> returns an array that
3726
4157
  * contains a list of locations when the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html">ListLocations</a> operation is
3727
4158
  * called.</p>
@@ -3746,10 +4177,12 @@ export interface LocationListEntry {
3746
4177
  */
3747
4178
  export interface ListLocationsResponse {
3748
4179
  /**
4180
+ * @public
3749
4181
  * <p>An array that contains a list of locations.</p>
3750
4182
  */
3751
4183
  Locations?: LocationListEntry[];
3752
4184
  /**
4185
+ * @public
3753
4186
  * <p>An opaque string that indicates the position at which to begin returning the next list
3754
4187
  * of locations.</p>
3755
4188
  */
@@ -3760,10 +4193,12 @@ export interface ListLocationsResponse {
3760
4193
  */
3761
4194
  export interface ListStorageSystemsRequest {
3762
4195
  /**
4196
+ * @public
3763
4197
  * <p>Specifies how many results you want in the response.</p>
3764
4198
  */
3765
4199
  MaxResults?: number;
3766
4200
  /**
4201
+ * @public
3767
4202
  * <p>Specifies an opaque string that indicates the position to begin the next list of results
3768
4203
  * in the response. </p>
3769
4204
  */
@@ -3776,11 +4211,13 @@ export interface ListStorageSystemsRequest {
3776
4211
  */
3777
4212
  export interface StorageSystemListEntry {
3778
4213
  /**
4214
+ * @public
3779
4215
  * <p>The Amazon Resource Names (ARN) of an on-premises storage system that you added to
3780
4216
  * DataSync Discovery.</p>
3781
4217
  */
3782
4218
  StorageSystemArn?: string;
3783
4219
  /**
4220
+ * @public
3784
4221
  * <p>The name of an on-premises storage system that you added to DataSync Discovery.</p>
3785
4222
  */
3786
4223
  Name?: string;
@@ -3790,11 +4227,13 @@ export interface StorageSystemListEntry {
3790
4227
  */
3791
4228
  export interface ListStorageSystemsResponse {
3792
4229
  /**
4230
+ * @public
3793
4231
  * <p>The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with
3794
4232
  * DataSync Discovery.</p>
3795
4233
  */
3796
4234
  StorageSystems?: StorageSystemListEntry[];
3797
4235
  /**
4236
+ * @public
3798
4237
  * <p>The opaque string that indicates the position to begin the next list of results in the
3799
4238
  * response.</p>
3800
4239
  */
@@ -3806,15 +4245,18 @@ export interface ListStorageSystemsResponse {
3806
4245
  */
3807
4246
  export interface ListTagsForResourceRequest {
3808
4247
  /**
4248
+ * @public
3809
4249
  * <p>Specifies the Amazon Resource Name (ARN) of the resource that you want tag information
3810
4250
  * on.</p>
3811
4251
  */
3812
4252
  ResourceArn: string | undefined;
3813
4253
  /**
4254
+ * @public
3814
4255
  * <p>Specifies how many results that you want in the response.</p>
3815
4256
  */
3816
4257
  MaxResults?: number;
3817
4258
  /**
4259
+ * @public
3818
4260
  * <p>Specifies an opaque string that indicates the position to begin the next list of
3819
4261
  * results in the response.</p>
3820
4262
  */
@@ -3826,10 +4268,12 @@ export interface ListTagsForResourceRequest {
3826
4268
  */
3827
4269
  export interface ListTagsForResourceResponse {
3828
4270
  /**
4271
+ * @public
3829
4272
  * <p>An array of tags applied to the specified resource.</p>
3830
4273
  */
3831
4274
  Tags?: TagListEntry[];
3832
4275
  /**
4276
+ * @public
3833
4277
  * <p>The opaque string that indicates the position to begin the next list of results in the
3834
4278
  * response.</p>
3835
4279
  */
@@ -3841,14 +4285,17 @@ export interface ListTagsForResourceResponse {
3841
4285
  */
3842
4286
  export interface ListTaskExecutionsRequest {
3843
4287
  /**
4288
+ * @public
3844
4289
  * <p>The Amazon Resource Name (ARN) of the task whose tasks you want to list.</p>
3845
4290
  */
3846
4291
  TaskArn?: string;
3847
4292
  /**
4293
+ * @public
3848
4294
  * <p>The maximum number of executed tasks to list.</p>
3849
4295
  */
3850
4296
  MaxResults?: number;
3851
4297
  /**
4298
+ * @public
3852
4299
  * <p>An opaque string that indicates the position at which to begin the next list of the
3853
4300
  * executed tasks.</p>
3854
4301
  */
@@ -3863,10 +4310,12 @@ export interface ListTaskExecutionsRequest {
3863
4310
  */
3864
4311
  export interface TaskExecutionListEntry {
3865
4312
  /**
4313
+ * @public
3866
4314
  * <p>The Amazon Resource Name (ARN) of the task that was executed.</p>
3867
4315
  */
3868
4316
  TaskExecutionArn?: string;
3869
4317
  /**
4318
+ * @public
3870
4319
  * <p>The status of a task execution.</p>
3871
4320
  */
3872
4321
  Status?: TaskExecutionStatus | string;
@@ -3877,10 +4326,12 @@ export interface TaskExecutionListEntry {
3877
4326
  */
3878
4327
  export interface ListTaskExecutionsResponse {
3879
4328
  /**
4329
+ * @public
3880
4330
  * <p>A list of executed tasks.</p>
3881
4331
  */
3882
4332
  TaskExecutions?: TaskExecutionListEntry[];
3883
4333
  /**
4334
+ * @public
3884
4335
  * <p>An opaque string that indicates the position at which to begin returning the next list
3885
4336
  * of executed tasks.</p>
3886
4337
  */
@@ -3909,16 +4360,19 @@ export type TaskFilterName = (typeof TaskFilterName)[keyof typeof TaskFilterName
3909
4360
  */
3910
4361
  export interface TaskFilter {
3911
4362
  /**
4363
+ * @public
3912
4364
  * <p>The name of the filter being used. Each API call supports a list of filters that are
3913
4365
  * available for it. For example, <code>LocationId</code> for <code>ListTasks</code>.</p>
3914
4366
  */
3915
4367
  Name: TaskFilterName | string | undefined;
3916
4368
  /**
4369
+ * @public
3917
4370
  * <p>The values that you want to filter for. For example, you might want to display only tasks
3918
4371
  * for a specific destination location.</p>
3919
4372
  */
3920
4373
  Values: string[] | undefined;
3921
4374
  /**
4375
+ * @public
3922
4376
  * <p>The operator that is used to compare filter values (for example, <code>Equals</code> or
3923
4377
  * <code>Contains</code>).</p>
3924
4378
  */
@@ -3930,15 +4384,18 @@ export interface TaskFilter {
3930
4384
  */
3931
4385
  export interface ListTasksRequest {
3932
4386
  /**
4387
+ * @public
3933
4388
  * <p>The maximum number of tasks to return.</p>
3934
4389
  */
3935
4390
  MaxResults?: number;
3936
4391
  /**
4392
+ * @public
3937
4393
  * <p>An opaque string that indicates the position at which to begin the next list of
3938
4394
  * tasks.</p>
3939
4395
  */
3940
4396
  NextToken?: string;
3941
4397
  /**
4398
+ * @public
3942
4399
  * <p>You can use API filters to narrow down the list of resources returned by
3943
4400
  * <code>ListTasks</code>. For example, to retrieve all tasks on a specific source location,
3944
4401
  * you can use <code>ListTasks</code> with filter name <code>LocationId</code> and <code>Operator
@@ -3955,14 +4412,17 @@ export interface ListTasksRequest {
3955
4412
  */
3956
4413
  export interface TaskListEntry {
3957
4414
  /**
4415
+ * @public
3958
4416
  * <p>The Amazon Resource Name (ARN) of the task.</p>
3959
4417
  */
3960
4418
  TaskArn?: string;
3961
4419
  /**
4420
+ * @public
3962
4421
  * <p>The status of the task.</p>
3963
4422
  */
3964
4423
  Status?: TaskStatus | string;
3965
4424
  /**
4425
+ * @public
3966
4426
  * <p>The name of the task.</p>
3967
4427
  */
3968
4428
  Name?: string;
@@ -3973,10 +4433,12 @@ export interface TaskListEntry {
3973
4433
  */
3974
4434
  export interface ListTasksResponse {
3975
4435
  /**
4436
+ * @public
3976
4437
  * <p>A list of all the tasks that are returned.</p>
3977
4438
  */
3978
4439
  Tasks?: TaskListEntry[];
3979
4440
  /**
4441
+ * @public
3980
4442
  * <p>An opaque string that indicates the position at which to begin returning the next list
3981
4443
  * of tasks.</p>
3982
4444
  */
@@ -3987,6 +4449,7 @@ export interface ListTasksResponse {
3987
4449
  */
3988
4450
  export interface RemoveStorageSystemRequest {
3989
4451
  /**
4452
+ * @public
3990
4453
  * <p>Specifies the Amazon Resource Name (ARN) of the storage system that you want to
3991
4454
  * permanently remove from DataSync Discovery.</p>
3992
4455
  */
@@ -4002,11 +4465,13 @@ export interface RemoveStorageSystemResponse {
4002
4465
  */
4003
4466
  export interface StartDiscoveryJobRequest {
4004
4467
  /**
4468
+ * @public
4005
4469
  * <p>Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want
4006
4470
  * to run the discovery job on.</p>
4007
4471
  */
4008
4472
  StorageSystemArn: string | undefined;
4009
4473
  /**
4474
+ * @public
4010
4475
  * <p>Specifies in minutes how long you want the discovery job to run.</p>
4011
4476
  * <note>
4012
4477
  * <p>For more accurate recommendations, we recommend a duration of at least 14 days. Longer
@@ -4016,11 +4481,13 @@ export interface StartDiscoveryJobRequest {
4016
4481
  */
4017
4482
  CollectionDurationMinutes: number | undefined;
4018
4483
  /**
4484
+ * @public
4019
4485
  * <p>Specifies a client token to make sure requests with this API operation are idempotent. If
4020
4486
  * you don't specify a client token, DataSync generates one for you automatically.</p>
4021
4487
  */
4022
4488
  ClientToken?: string;
4023
4489
  /**
4490
+ * @public
4024
4491
  * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services
4025
4492
  * resources.</p>
4026
4493
  */
@@ -4031,6 +4498,7 @@ export interface StartDiscoveryJobRequest {
4031
4498
  */
4032
4499
  export interface StartDiscoveryJobResponse {
4033
4500
  /**
4501
+ * @public
4034
4502
  * <p>The ARN of the discovery job that you started.</p>
4035
4503
  */
4036
4504
  DiscoveryJobArn?: string;
@@ -4041,10 +4509,12 @@ export interface StartDiscoveryJobResponse {
4041
4509
  */
4042
4510
  export interface StartTaskExecutionRequest {
4043
4511
  /**
4512
+ * @public
4044
4513
  * <p>Specifies the Amazon Resource Name (ARN) of the task that you want to start.</p>
4045
4514
  */
4046
4515
  TaskArn: string | undefined;
4047
4516
  /**
4517
+ * @public
4048
4518
  * <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
4049
4519
  * DataSync verifies data integrity, set bandwidth limits for your task, among other
4050
4520
  * options.</p>
@@ -4053,6 +4523,7 @@ export interface StartTaskExecutionRequest {
4053
4523
  */
4054
4524
  OverrideOptions?: Options;
4055
4525
  /**
4526
+ * @public
4056
4527
  * <p>Specifies a list of filter rules that determines which files to include when running a
4057
4528
  * task. The pattern should contain a single filter string that consists of the patterns to
4058
4529
  * include. The patterns are delimited by "|" (that is, a pipe), for example,
@@ -4060,12 +4531,14 @@ export interface StartTaskExecutionRequest {
4060
4531
  */
4061
4532
  Includes?: FilterRule[];
4062
4533
  /**
4534
+ * @public
4063
4535
  * <p>Specifies a list of filter rules that determines which files to exclude from a task. The
4064
4536
  * list contains a single filter string that consists of the patterns to exclude. The patterns
4065
4537
  * are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>. </p>
4066
4538
  */
4067
4539
  Excludes?: FilterRule[];
4068
4540
  /**
4541
+ * @public
4069
4542
  * <p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing
4070
4543
  * the task execution.</p>
4071
4544
  * <p>
@@ -4080,6 +4553,7 @@ export interface StartTaskExecutionRequest {
4080
4553
  */
4081
4554
  export interface StartTaskExecutionResponse {
4082
4555
  /**
4556
+ * @public
4083
4557
  * <p>The ARN of the running task execution.</p>
4084
4558
  */
4085
4559
  TaskExecutionArn?: string;
@@ -4089,6 +4563,7 @@ export interface StartTaskExecutionResponse {
4089
4563
  */
4090
4564
  export interface StopDiscoveryJobRequest {
4091
4565
  /**
4566
+ * @public
4092
4567
  * <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
4093
4568
  * </p>
4094
4569
  */
@@ -4105,10 +4580,12 @@ export interface StopDiscoveryJobResponse {
4105
4580
  */
4106
4581
  export interface TagResourceRequest {
4107
4582
  /**
4583
+ * @public
4108
4584
  * <p>Specifies the Amazon Resource Name (ARN) of the resource to apply the tag to.</p>
4109
4585
  */
4110
4586
  ResourceArn: string | undefined;
4111
4587
  /**
4588
+ * @public
4112
4589
  * <p>Specifies the tags that you want to apply to the resource.</p>
4113
4590
  */
4114
4591
  Tags: TagListEntry[] | undefined;
@@ -4124,11 +4601,13 @@ export interface TagResourceResponse {
4124
4601
  */
4125
4602
  export interface UntagResourceRequest {
4126
4603
  /**
4604
+ * @public
4127
4605
  * <p>Specifies the Amazon Resource Name (ARN) of the resource to remove the tags
4128
4606
  * from.</p>
4129
4607
  */
4130
4608
  ResourceArn: string | undefined;
4131
4609
  /**
4610
+ * @public
4132
4611
  * <p>Specifies the keys in the tags that you want to remove.</p>
4133
4612
  */
4134
4613
  Keys: string[] | undefined;
@@ -4144,10 +4623,12 @@ export interface UntagResourceResponse {
4144
4623
  */
4145
4624
  export interface UpdateAgentRequest {
4146
4625
  /**
4626
+ * @public
4147
4627
  * <p>The Amazon Resource Name (ARN) of the agent to update.</p>
4148
4628
  */
4149
4629
  AgentArn: string | undefined;
4150
4630
  /**
4631
+ * @public
4151
4632
  * <p>The name that you want to use to configure the agent.</p>
4152
4633
  */
4153
4634
  Name?: string;
@@ -4162,11 +4643,13 @@ export interface UpdateAgentResponse {
4162
4643
  */
4163
4644
  export interface UpdateDiscoveryJobRequest {
4164
4645
  /**
4646
+ * @public
4165
4647
  * <p>Specifies the Amazon Resource Name (ARN) of the discovery job that you want to
4166
4648
  * update.</p>
4167
4649
  */
4168
4650
  DiscoveryJobArn: string | undefined;
4169
4651
  /**
4652
+ * @public
4170
4653
  * <p>Specifies in minutes how long that you want the discovery job to run. (You can't set this
4171
4654
  * parameter to less than the number of minutes that the job has already run for.)</p>
4172
4655
  */
@@ -4182,33 +4665,40 @@ export interface UpdateDiscoveryJobResponse {
4182
4665
  */
4183
4666
  export interface UpdateLocationAzureBlobRequest {
4184
4667
  /**
4668
+ * @public
4185
4669
  * <p>Specifies the ARN of the Azure Blob Storage transfer location that you're updating.</p>
4186
4670
  */
4187
4671
  LocationArn: string | undefined;
4188
4672
  /**
4673
+ * @public
4189
4674
  * <p>Specifies path segments if you want to limit your transfer to a virtual directory in your
4190
4675
  * container (for example, <code>/my/images</code>).</p>
4191
4676
  */
4192
4677
  Subdirectory?: string;
4193
4678
  /**
4679
+ * @public
4194
4680
  * <p>Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).</p>
4195
4681
  */
4196
4682
  AuthenticationType?: AzureBlobAuthenticationType | string;
4197
4683
  /**
4684
+ * @public
4198
4685
  * <p>Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.</p>
4199
4686
  */
4200
4687
  SasConfiguration?: AzureBlobSasConfiguration;
4201
4688
  /**
4689
+ * @public
4202
4690
  * <p>Specifies the type of blob that you want your objects or files to be when transferring
4203
4691
  * them into Azure Blob Storage. Currently, DataSync only supports moving data into
4204
4692
  * Azure Blob Storage as block blobs. For more information on blob types, see the <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs">Azure Blob Storage documentation</a>.</p>
4205
4693
  */
4206
4694
  BlobType?: AzureBlobType | string;
4207
4695
  /**
4696
+ * @public
4208
4697
  * <p>Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">Access tiers</a>.</p>
4209
4698
  */
4210
4699
  AccessTier?: AzureAccessTier | string;
4211
4700
  /**
4701
+ * @public
4212
4702
  * <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.</p>
4213
4703
  * <p>You can specify more than one agent. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html">Using multiple
4214
4704
  * agents for your transfer</a>.</p>
@@ -4225,51 +4715,62 @@ export interface UpdateLocationAzureBlobResponse {
4225
4715
  */
4226
4716
  export interface UpdateLocationHdfsRequest {
4227
4717
  /**
4718
+ * @public
4228
4719
  * <p>The Amazon Resource Name (ARN) of the source HDFS cluster location.</p>
4229
4720
  */
4230
4721
  LocationArn: string | undefined;
4231
4722
  /**
4723
+ * @public
4232
4724
  * <p>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write
4233
4725
  * data to the HDFS cluster.</p>
4234
4726
  */
4235
4727
  Subdirectory?: string;
4236
4728
  /**
4729
+ * @public
4237
4730
  * <p>The NameNode that manages the HDFS namespace. The NameNode performs operations such as
4238
4731
  * opening, closing, and renaming files and directories. The NameNode contains the information to
4239
4732
  * map blocks of data to the DataNodes. You can use only one NameNode.</p>
4240
4733
  */
4241
4734
  NameNodes?: HdfsNameNode[];
4242
4735
  /**
4736
+ * @public
4243
4737
  * <p>The size of the data blocks to write into the HDFS cluster. </p>
4244
4738
  */
4245
4739
  BlockSize?: number;
4246
4740
  /**
4741
+ * @public
4247
4742
  * <p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. </p>
4248
4743
  */
4249
4744
  ReplicationFactor?: number;
4250
4745
  /**
4746
+ * @public
4251
4747
  * <p>The URI of the HDFS cluster's Key Management Server (KMS). </p>
4252
4748
  */
4253
4749
  KmsKeyProviderUri?: string;
4254
4750
  /**
4751
+ * @public
4255
4752
  * <p>The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)
4256
4753
  * and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS)
4257
4754
  * cluster. </p>
4258
4755
  */
4259
4756
  QopConfiguration?: QopConfiguration;
4260
4757
  /**
4758
+ * @public
4261
4759
  * <p>The type of authentication used to determine the identity of the user. </p>
4262
4760
  */
4263
4761
  AuthenticationType?: HdfsAuthenticationType | string;
4264
4762
  /**
4763
+ * @public
4265
4764
  * <p>The user name used to identify the client on the host operating system.</p>
4266
4765
  */
4267
4766
  SimpleUser?: string;
4268
4767
  /**
4768
+ * @public
4269
4769
  * <p>The Kerberos principal with access to the files and folders on the HDFS cluster. </p>
4270
4770
  */
4271
4771
  KerberosPrincipal?: string;
4272
4772
  /**
4773
+ * @public
4273
4774
  * <p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos
4274
4775
  * principal and the encrypted keys. You can load the keytab from a file by providing the file's
4275
4776
  * address. If you use the CLI, it performs base64 encoding for you. Otherwise,
@@ -4277,6 +4778,7 @@ export interface UpdateLocationHdfsRequest {
4277
4778
  */
4278
4779
  KerberosKeytab?: Uint8Array;
4279
4780
  /**
4781
+ * @public
4280
4782
  * <p>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You
4281
4783
  * can load the <code>krb5.conf</code> file by providing the file's address. If you're using the
4282
4784
  * CLI, it performs the base64 encoding for you. Otherwise, provide the
@@ -4284,6 +4786,7 @@ export interface UpdateLocationHdfsRequest {
4284
4786
  */
4285
4787
  KerberosKrb5Conf?: Uint8Array;
4286
4788
  /**
4789
+ * @public
4287
4790
  * <p>The ARNs of the agents that are used to connect to the HDFS cluster. </p>
4288
4791
  */
4289
4792
  AgentArns?: string[];
@@ -4298,35 +4801,27 @@ export interface UpdateLocationHdfsResponse {
4298
4801
  */
4299
4802
  export interface UpdateLocationNfsRequest {
4300
4803
  /**
4301
- * <p>Specifies the Amazon Resource Name (ARN) of the NFS location that you want to
4804
+ * @public
4805
+ * <p>Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to
4302
4806
  * update.</p>
4303
4807
  */
4304
4808
  LocationArn: string | undefined;
4305
4809
  /**
4306
- * <p>Specifies the subdirectory in your NFS file system that DataSync uses to read
4307
- * from or write to during a transfer. The NFS path should be exported by the NFS server, or a
4308
- * subdirectory of that path. The path should be such that it can be mounted by other NFS clients
4309
- * in your network.</p>
4310
- * <p>To see all the paths exported by your NFS server, run "<code>showmount -e
4311
- * nfs-server-name</code>" from an NFS client that has access to your server. You can specify
4312
- * any directory that appears in the results, and any subdirectory of that directory. Ensure that
4313
- * the NFS export is accessible without Kerberos authentication. </p>
4314
- * <p>To transfer all the data in the folder that you specified, DataSync must have
4315
- * permissions to read all the data. To ensure this, either configure the NFS export with
4316
- * <code>no_root_squash</code>, or ensure that the files you want DataSync to access
4317
- * have permissions that allow read access for all users. Doing either option enables the agent
4318
- * to read the files. For the agent to access directories, you must additionally enable all
4319
- * execute access.</p>
4320
- * <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
4321
- * Snowcone</a> for more information.</p>
4810
+ * @public
4811
+ * <p>Specifies the export path in your NFS file server that you want DataSync to
4812
+ * mount.</p>
4813
+ * <p>This path (or a subdirectory of the path) is where DataSync transfers data to
4814
+ * or from. For information on configuring an export for DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs">Accessing NFS file servers</a>.</p>
4322
4815
  */
4323
4816
  Subdirectory?: string;
4324
4817
  /**
4325
- * <p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)
4818
+ * @public
4819
+ * <p>The DataSync agents that are connecting to a Network File System (NFS)
4326
4820
  * location.</p>
4327
4821
  */
4328
4822
  OnPremConfig?: OnPremConfig;
4329
4823
  /**
4824
+ * @public
4330
4825
  * <p>Specifies how DataSync can access a location using the NFS protocol.</p>
4331
4826
  */
4332
4827
  MountOptions?: NfsMountOptions;
@@ -4341,40 +4836,48 @@ export interface UpdateLocationNfsResponse {
4341
4836
  */
4342
4837
  export interface UpdateLocationObjectStorageRequest {
4343
4838
  /**
4839
+ * @public
4344
4840
  * <p>Specifies the ARN of the object storage system location that you're updating.</p>
4345
4841
  */
4346
4842
  LocationArn: string | undefined;
4347
4843
  /**
4844
+ * @public
4348
4845
  * <p>Specifies the port that your object storage server accepts inbound network traffic on (for
4349
4846
  * example, port 443).</p>
4350
4847
  */
4351
4848
  ServerPort?: number;
4352
4849
  /**
4850
+ * @public
4353
4851
  * <p>Specifies the protocol that your object storage server uses to communicate.</p>
4354
4852
  */
4355
4853
  ServerProtocol?: ObjectStorageServerProtocol | string;
4356
4854
  /**
4855
+ * @public
4357
4856
  * <p>Specifies the object prefix for your object storage server. If this is a source location,
4358
4857
  * DataSync only copies objects with this prefix. If this is a destination location, DataSync
4359
4858
  * writes all objects with this prefix.</p>
4360
4859
  */
4361
4860
  Subdirectory?: string;
4362
4861
  /**
4862
+ * @public
4363
4863
  * <p>Specifies the access key (for example, a user name) if credentials are required to
4364
4864
  * authenticate with the object storage server.</p>
4365
4865
  */
4366
4866
  AccessKey?: string;
4367
4867
  /**
4868
+ * @public
4368
4869
  * <p>Specifies the secret key (for example, a password) if credentials are required to
4369
4870
  * authenticate with the object storage server.</p>
4370
4871
  */
4371
4872
  SecretKey?: string;
4372
4873
  /**
4874
+ * @public
4373
4875
  * <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can
4374
4876
  * securely connect with your location.</p>
4375
4877
  */
4376
4878
  AgentArns?: string[];
4377
4879
  /**
4880
+ * @public
4378
4881
  * <p>Specifies a certificate to authenticate with an object storage system that uses a private
4379
4882
  * or self-signed certificate authority (CA). You must specify a Base64-encoded <code>.pem</code>
4380
4883
  * file (for example, <code>file:///home/user/.ssh/storage_sys_certificate.pem</code>). The
@@ -4394,10 +4897,12 @@ export interface UpdateLocationObjectStorageResponse {
4394
4897
  */
4395
4898
  export interface UpdateLocationSmbRequest {
4396
4899
  /**
4900
+ * @public
4397
4901
  * <p>The Amazon Resource Name (ARN) of the SMB location to update.</p>
4398
4902
  */
4399
4903
  LocationArn: string | undefined;
4400
4904
  /**
4905
+ * @public
4401
4906
  * <p>The subdirectory in the SMB file system that is used to read data from the SMB source
4402
4907
  * location or write data to the SMB destination. The SMB path should be a path that's
4403
4908
  * exported by the SMB server, or a subdirectory of that path. The path should be such that it
@@ -4425,25 +4930,30 @@ export interface UpdateLocationSmbRequest {
4425
4930
  */
4426
4931
  Subdirectory?: string;
4427
4932
  /**
4933
+ * @public
4428
4934
  * <p>The user who can mount the share has the permissions to access files and folders in the
4429
4935
  * SMB share.</p>
4430
4936
  */
4431
4937
  User?: string;
4432
4938
  /**
4939
+ * @public
4433
4940
  * <p>The name of the Windows domain that the SMB server belongs to.</p>
4434
4941
  */
4435
4942
  Domain?: string;
4436
4943
  /**
4944
+ * @public
4437
4945
  * <p>The password of the user who can mount the share has the permissions to access files and
4438
4946
  * folders in the SMB share.</p>
4439
4947
  */
4440
4948
  Password?: string;
4441
4949
  /**
4950
+ * @public
4442
4951
  * <p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)
4443
4952
  * location.</p>
4444
4953
  */
4445
4954
  AgentArns?: string[];
4446
4955
  /**
4956
+ * @public
4447
4957
  * <p>Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.</p>
4448
4958
  */
4449
4959
  MountOptions?: SmbMountOptions;
@@ -4458,29 +4968,35 @@ export interface UpdateLocationSmbResponse {
4458
4968
  */
4459
4969
  export interface UpdateStorageSystemRequest {
4460
4970
  /**
4971
+ * @public
4461
4972
  * <p>Specifies the ARN of the on-premises storage system that you want reconfigure.</p>
4462
4973
  */
4463
4974
  StorageSystemArn: string | undefined;
4464
4975
  /**
4976
+ * @public
4465
4977
  * <p>Specifies the server name and network port required to connect with your on-premises
4466
4978
  * storage system's management interface.</p>
4467
4979
  */
4468
4980
  ServerConfiguration?: DiscoveryServerConfiguration;
4469
4981
  /**
4982
+ * @public
4470
4983
  * <p>Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads
4471
4984
  * your on-premises storage system. You can only specify one ARN.</p>
4472
4985
  */
4473
4986
  AgentArns?: string[];
4474
4987
  /**
4988
+ * @public
4475
4989
  * <p>Specifies a familiar name for your on-premises storage system.</p>
4476
4990
  */
4477
4991
  Name?: string;
4478
4992
  /**
4993
+ * @public
4479
4994
  * <p>Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging
4480
4995
  * discovery job events.</p>
4481
4996
  */
4482
4997
  CloudWatchLogGroupArn?: string;
4483
4998
  /**
4999
+ * @public
4484
5000
  * <p>Specifies the user name and password for accessing your on-premises storage system's
4485
5001
  * management interface.</p>
4486
5002
  */
@@ -4497,10 +5013,12 @@ export interface UpdateStorageSystemResponse {
4497
5013
  */
4498
5014
  export interface UpdateTaskRequest {
4499
5015
  /**
5016
+ * @public
4500
5017
  * <p>The Amazon Resource Name (ARN) of the resource name of the task to update.</p>
4501
5018
  */
4502
5019
  TaskArn: string | undefined;
4503
5020
  /**
5021
+ * @public
4504
5022
  * <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
4505
5023
  * DataSync verifies data integrity, set bandwidth limits for your task, among other
4506
5024
  * options.</p>
@@ -4509,11 +5027,13 @@ export interface UpdateTaskRequest {
4509
5027
  */
4510
5028
  Options?: Options;
4511
5029
  /**
5030
+ * @public
4512
5031
  * <p>Specifies a list of filter rules that exclude specific data during your transfer. For more
4513
5032
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
4514
5033
  */
4515
5034
  Excludes?: FilterRule[];
4516
5035
  /**
5036
+ * @public
4517
5037
  * <p>Specifies a schedule used to periodically transfer files from a source to a destination
4518
5038
  * location. You can configure your task to execute hourly, daily, weekly or on specific days of
4519
5039
  * the week. You control when in the day or hour you want the task to execute. The time you
@@ -4521,15 +5041,18 @@ export interface UpdateTaskRequest {
4521
5041
  */
4522
5042
  Schedule?: TaskSchedule;
4523
5043
  /**
5044
+ * @public
4524
5045
  * <p>The name of the task to update.</p>
4525
5046
  */
4526
5047
  Name?: string;
4527
5048
  /**
5049
+ * @public
4528
5050
  * <p>The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log
4529
5051
  * group.</p>
4530
5052
  */
4531
5053
  CloudWatchLogGroupArn?: string;
4532
5054
  /**
5055
+ * @public
4533
5056
  * <p>Specifies a list of filter rules that include specific data during your transfer. For more
4534
5057
  * information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
4535
5058
  */
@@ -4545,11 +5068,13 @@ export interface UpdateTaskResponse {
4545
5068
  */
4546
5069
  export interface UpdateTaskExecutionRequest {
4547
5070
  /**
5071
+ * @public
4548
5072
  * <p>Specifies the Amazon Resource Name (ARN) of the task execution that you're
4549
5073
  * updating.</p>
4550
5074
  */
4551
5075
  TaskExecutionArn: string | undefined;
4552
5076
  /**
5077
+ * @public
4553
5078
  * <p>Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how
4554
5079
  * DataSync verifies data integrity, set bandwidth limits for your task, among other
4555
5080
  * options.</p>