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