-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
1441 lines (1441 loc) · 110 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<fullname>DataSync</fullname> <p>DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS). </p> <p>This API interface reference for DataSync contains documentation for a programming interface that you can use to manage DataSync.</p>",
"operations": {
"CancelTaskExecution": "<p>Cancels execution of a task. </p> <p>When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.</p>",
"CreateAgent": "<p>Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.</p> <p>You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.</p> <p>You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. </p> <p>Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.</p> <p/>",
"CreateLocationEfs": "<p>Creates an endpoint for an Amazon EFS file system.</p>",
"CreateLocationFsxLustre": "<p>Creates an endpoint for an Amazon FSx for Lustre file system.</p>",
"CreateLocationFsxOpenZfs": "<p>Creates an endpoint for an Amazon FSx for OpenZFS file system.</p>",
"CreateLocationFsxWindows": "<p>Creates an endpoint for an Amazon FSx for Windows File Server file system.</p>",
"CreateLocationHdfs": "<p>Creates an endpoint for a Hadoop Distributed File System (HDFS). </p>",
"CreateLocationNfs": "<p>Defines a file system on a Network File System (NFS) server that can be read from or written to.</p>",
"CreateLocationObjectStorage": "<p>Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html\">Creating a location for object storage</a>.</p>",
"CreateLocationS3": "<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli\">Create an Amazon S3 location</a> in the <i>DataSync User Guide</i>.</p>",
"CreateLocationSmb": "<p>Defines a file system on a Server Message Block (SMB) server that can be read from or written to.</p>",
"CreateTask": "<p>Creates a task.</p> <p>A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.</p> <p>When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.</p> <p>You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.</p> <important> <p>When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see <a href=\"https://aws.amazon.com/ec2/pricing/on-demand/#Data_Transfer\">Data Transfer pricing</a>. </p> </important>",
"DeleteAgent": "<p>Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.</p>",
"DeleteLocation": "<p>Deletes the configuration of a location used by DataSync. </p>",
"DeleteTask": "<p>Deletes a task.</p>",
"DescribeAgent": "<p>Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request. </p>",
"DescribeLocationEfs": "<p>Returns metadata, such as the path information about an Amazon EFS location.</p>",
"DescribeLocationFsxLustre": "<p>Returns metadata about an Amazon FSx for Lustre location, such as information about its path.</p>",
"DescribeLocationFsxOpenZfs": "<p>Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.</p>",
"DescribeLocationFsxWindows": "<p>Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.</p>",
"DescribeLocationHdfs": "<p>Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location. </p>",
"DescribeLocationNfs": "<p>Returns metadata, such as the path information, about an NFS location.</p>",
"DescribeLocationObjectStorage": "<p>Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html\">Creating a location for object storage</a>.</p>",
"DescribeLocationS3": "<p>Returns metadata, such as bucket name, about an Amazon S3 bucket location.</p>",
"DescribeLocationSmb": "<p>Returns metadata, such as the path and user information about an SMB location.</p>",
"DescribeTask": "<p>Returns metadata about a task.</p>",
"DescribeTaskExecution": "<p>Returns detailed metadata about a task that is being executed.</p>",
"ListAgents": "<p>Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).</p> <p>By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.</p> <p>If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.</p>",
"ListLocations": "<p>Returns a list of source and destination locations.</p> <p>If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.</p>",
"ListTagsForResource": "<p>Returns all the tags associated with a specified resource. </p>",
"ListTaskExecutions": "<p>Returns a list of executed tasks.</p>",
"ListTasks": "<p>Returns a list of all the tasks.</p>",
"StartTaskExecution": "<p>Starts a specific invocation of a task. A <code>TaskExecution</code> value represents an individual run of a task. Each task can have at most one <code>TaskExecution</code> at a time.</p> <p> <code>TaskExecution</code> has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. </p> <p>For detailed information, see the Task Execution section in the Components and Terminology topic in the <i>DataSync User Guide</i>.</p>",
"TagResource": "<p>Applies a key-value pair to an Amazon Web Services resource.</p>",
"UntagResource": "<p>Removes a tag from an Amazon Web Services resource.</p>",
"UpdateAgent": "<p>Updates the name of an agent.</p>",
"UpdateLocationHdfs": "<p>Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.</p>",
"UpdateLocationNfs": "<p>Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html\">Creating a location for NFS</a>.</p>",
"UpdateLocationObjectStorage": "<p>Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html\">Creating a location for object storage</a>.</p>",
"UpdateLocationSmb": "<p>Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html\">Creating a location for SMB</a>.</p>",
"UpdateTask": "<p>Updates the metadata associated with a task.</p>",
"UpdateTaskExecution": "<p>Updates execution of a task.</p> <p>You can modify bandwidth throttling for a task execution that is running or queued. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling\">Adjusting Bandwidth Throttling for a Task Execution</a>.</p> <note> <p>The only <code>Option</code> that can be modified by <code>UpdateTaskExecution</code> is <code> <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond\">BytesPerSecond</a> </code>.</p> </note>"
},
"shapes": {
"ActivationKey": {
"base": null,
"refs": {
"CreateAgentRequest$ActivationKey": "<p>Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.</p> <p>The redirect URL returned in the response provides you the activation key for your agent in the query string parameter <code>activationKey</code>. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.</p> <p>For more information, see Activating an Agent in the <i>DataSync User Guide.</i> </p>"
}
},
"AgentArn": {
"base": null,
"refs": {
"AgentArnList$member": null,
"AgentListEntry$AgentArn": "<p>The Amazon Resource Name (ARN) of the agent.</p>",
"CreateAgentResponse$AgentArn": "<p>The Amazon Resource Name (ARN) of the agent. Use the <code>ListAgents</code> operation to return a list of agents for your account and Amazon Web Services Region.</p>",
"DeleteAgentRequest$AgentArn": "<p>The Amazon Resource Name (ARN) of the agent to delete. Use the <code>ListAgents</code> operation to return a list of agents for your account and Amazon Web Services Region.</p>",
"DescribeAgentRequest$AgentArn": "<p>The Amazon Resource Name (ARN) of the agent to describe.</p>",
"DescribeAgentResponse$AgentArn": "<p>The Amazon Resource Name (ARN) of the agent.</p>",
"UpdateAgentRequest$AgentArn": "<p>The Amazon Resource Name (ARN) of the agent to update.</p>"
}
},
"AgentArnList": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$AgentArns": "<p>The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.</p>",
"CreateLocationObjectStorageRequest$AgentArns": "<p>The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.</p>",
"CreateLocationS3Request$AgentArns": "<p>If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about 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 on Outposts</a>.</p>",
"CreateLocationSmbRequest$AgentArns": "<p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. </p>",
"DescribeLocationHdfsResponse$AgentArns": "<p>The ARNs of the agents that are used to connect to the HDFS cluster. </p>",
"DescribeLocationObjectStorageResponse$AgentArns": "<p>The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.</p>",
"DescribeLocationS3Response$AgentArns": "<p>If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about 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 on Outposts</a>.</p>",
"DescribeLocationSmbResponse$AgentArns": "<p>The Amazon Resource Name (ARN) of the source SMB file system location that is created.</p>",
"OnPremConfig$AgentArns": "<p>ARNs of the agents to use for an NFS location.</p>",
"UpdateLocationHdfsRequest$AgentArns": "<p>The ARNs of the agents that are used to connect to the HDFS cluster. </p>",
"UpdateLocationObjectStorageRequest$AgentArns": "<p>The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.</p>",
"UpdateLocationSmbRequest$AgentArns": "<p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.</p>"
}
},
"AgentList": {
"base": null,
"refs": {
"ListAgentsResponse$Agents": "<p>A list of agents in your account.</p>"
}
},
"AgentListEntry": {
"base": "<p>Represents a single entry in a list of agents. <code>AgentListEntry</code> returns an array that contains a list of agents when the <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html\">ListAgents</a> operation is called.</p>",
"refs": {
"AgentList$member": null
}
},
"AgentStatus": {
"base": null,
"refs": {
"AgentListEntry$Status": "<p>The status of the agent.</p>",
"DescribeAgentResponse$Status": "<p>The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.</p>"
}
},
"Atime": {
"base": null,
"refs": {
"Options$Atime": "<p>A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set <code>Atime</code> to BEST_EFFORT, DataSync attempts to preserve the original <code>Atime</code> attribute on all source files (that is, the version before the PREPARING phase). However, <code>Atime</code>'s behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis. </p> <p>Default value: BEST_EFFORT.</p> <p>BEST_EFFORT: Attempt to preserve the per-file <code>Atime</code> value (recommended).</p> <p>NONE: Ignore <code>Atime</code>.</p> <note> <p>If <code>Atime</code> is set to BEST_EFFORT, <code>Mtime</code> must be set to PRESERVE. </p> <p>If <code>Atime</code> is set to NONE, <code>Mtime</code> must also be NONE. </p> </note>"
}
},
"BytesPerSecond": {
"base": null,
"refs": {
"Options$BytesPerSecond": "<p>A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to <code>1048576</code> (<code>=1024*1024</code>).</p>"
}
},
"CancelTaskExecutionRequest": {
"base": "<p>CancelTaskExecutionRequest</p>",
"refs": {
}
},
"CancelTaskExecutionResponse": {
"base": null,
"refs": {
}
},
"CreateAgentRequest": {
"base": "<p>CreateAgentRequest</p>",
"refs": {
}
},
"CreateAgentResponse": {
"base": "<p>CreateAgentResponse</p>",
"refs": {
}
},
"CreateLocationEfsRequest": {
"base": "<p>CreateLocationEfsRequest</p>",
"refs": {
}
},
"CreateLocationEfsResponse": {
"base": "<p>CreateLocationEfs</p>",
"refs": {
}
},
"CreateLocationFsxLustreRequest": {
"base": null,
"refs": {
}
},
"CreateLocationFsxLustreResponse": {
"base": null,
"refs": {
}
},
"CreateLocationFsxOpenZfsRequest": {
"base": null,
"refs": {
}
},
"CreateLocationFsxOpenZfsResponse": {
"base": null,
"refs": {
}
},
"CreateLocationFsxWindowsRequest": {
"base": null,
"refs": {
}
},
"CreateLocationFsxWindowsResponse": {
"base": null,
"refs": {
}
},
"CreateLocationHdfsRequest": {
"base": null,
"refs": {
}
},
"CreateLocationHdfsResponse": {
"base": null,
"refs": {
}
},
"CreateLocationNfsRequest": {
"base": "<p>CreateLocationNfsRequest</p>",
"refs": {
}
},
"CreateLocationNfsResponse": {
"base": "<p>CreateLocationNfsResponse</p>",
"refs": {
}
},
"CreateLocationObjectStorageRequest": {
"base": "<p>CreateLocationObjectStorageRequest</p>",
"refs": {
}
},
"CreateLocationObjectStorageResponse": {
"base": "<p>CreateLocationObjectStorageResponse</p>",
"refs": {
}
},
"CreateLocationS3Request": {
"base": "<p>CreateLocationS3Request</p>",
"refs": {
}
},
"CreateLocationS3Response": {
"base": "<p>CreateLocationS3Response</p>",
"refs": {
}
},
"CreateLocationSmbRequest": {
"base": "<p>CreateLocationSmbRequest</p>",
"refs": {
}
},
"CreateLocationSmbResponse": {
"base": "<p>CreateLocationSmbResponse</p>",
"refs": {
}
},
"CreateTaskRequest": {
"base": "<p>CreateTaskRequest</p>",
"refs": {
}
},
"CreateTaskResponse": {
"base": "<p>CreateTaskResponse</p>",
"refs": {
}
},
"DeleteAgentRequest": {
"base": "<p>DeleteAgentRequest</p>",
"refs": {
}
},
"DeleteAgentResponse": {
"base": null,
"refs": {
}
},
"DeleteLocationRequest": {
"base": "<p>DeleteLocation</p>",
"refs": {
}
},
"DeleteLocationResponse": {
"base": null,
"refs": {
}
},
"DeleteTaskRequest": {
"base": "<p>DeleteTask</p>",
"refs": {
}
},
"DeleteTaskResponse": {
"base": null,
"refs": {
}
},
"DescribeAgentRequest": {
"base": "<p>DescribeAgent</p>",
"refs": {
}
},
"DescribeAgentResponse": {
"base": "<p>DescribeAgentResponse</p>",
"refs": {
}
},
"DescribeLocationEfsRequest": {
"base": "<p>DescribeLocationEfsRequest</p>",
"refs": {
}
},
"DescribeLocationEfsResponse": {
"base": "<p>DescribeLocationEfsResponse</p>",
"refs": {
}
},
"DescribeLocationFsxLustreRequest": {
"base": null,
"refs": {
}
},
"DescribeLocationFsxLustreResponse": {
"base": null,
"refs": {
}
},
"DescribeLocationFsxOpenZfsRequest": {
"base": null,
"refs": {
}
},
"DescribeLocationFsxOpenZfsResponse": {
"base": null,
"refs": {
}
},
"DescribeLocationFsxWindowsRequest": {
"base": null,
"refs": {
}
},
"DescribeLocationFsxWindowsResponse": {
"base": null,
"refs": {
}
},
"DescribeLocationHdfsRequest": {
"base": null,
"refs": {
}
},
"DescribeLocationHdfsResponse": {
"base": null,
"refs": {
}
},
"DescribeLocationNfsRequest": {
"base": "<p>DescribeLocationNfsRequest</p>",
"refs": {
}
},
"DescribeLocationNfsResponse": {
"base": "<p>DescribeLocationNfsResponse</p>",
"refs": {
}
},
"DescribeLocationObjectStorageRequest": {
"base": "<p>DescribeLocationObjectStorageRequest</p>",
"refs": {
}
},
"DescribeLocationObjectStorageResponse": {
"base": "<p>DescribeLocationObjectStorageResponse</p>",
"refs": {
}
},
"DescribeLocationS3Request": {
"base": "<p>DescribeLocationS3Request</p>",
"refs": {
}
},
"DescribeLocationS3Response": {
"base": "<p>DescribeLocationS3Response</p>",
"refs": {
}
},
"DescribeLocationSmbRequest": {
"base": "<p>DescribeLocationSmbRequest</p>",
"refs": {
}
},
"DescribeLocationSmbResponse": {
"base": "<p>DescribeLocationSmbResponse</p>",
"refs": {
}
},
"DescribeTaskExecutionRequest": {
"base": "<p>DescribeTaskExecutionRequest</p>",
"refs": {
}
},
"DescribeTaskExecutionResponse": {
"base": "<p>DescribeTaskExecutionResponse</p>",
"refs": {
}
},
"DescribeTaskRequest": {
"base": "<p>DescribeTaskRequest</p>",
"refs": {
}
},
"DescribeTaskResponse": {
"base": "<p>DescribeTaskResponse</p>",
"refs": {
}
},
"DestinationNetworkInterfaceArns": {
"base": null,
"refs": {
"DescribeTaskResponse$DestinationNetworkInterfaceArns": "<p>The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.</p>"
}
},
"Duration": {
"base": null,
"refs": {
"TaskExecutionResultDetail$PrepareDuration": "<p>The total time in milliseconds that DataSync spent in the PREPARING phase. </p>",
"TaskExecutionResultDetail$TotalDuration": "<p>The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.</p>",
"TaskExecutionResultDetail$TransferDuration": "<p>The total time in milliseconds that DataSync spent in the TRANSFERRING phase.</p>",
"TaskExecutionResultDetail$VerifyDuration": "<p>The total time in milliseconds that DataSync spent in the VERIFYING phase.</p>"
}
},
"Ec2Config": {
"base": "<p>The subnet that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified. </p>",
"refs": {
"CreateLocationEfsRequest$Ec2Config": "<p>The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.</p> <p>The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows: </p> <ul> <li> <p> Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group. </p> </li> <li> <p>Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.</p> <p>For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the <i>Amazon EFS User Guide.</i> </p> </li> </ul>",
"DescribeLocationEfsResponse$Ec2Config": null
}
},
"Ec2SecurityGroupArn": {
"base": null,
"refs": {
"Ec2SecurityGroupArnList$member": null,
"PLSecurityGroupArnList$member": null
}
},
"Ec2SecurityGroupArnList": {
"base": null,
"refs": {
"CreateLocationFsxLustreRequest$SecurityGroupArns": "<p>The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.</p>",
"CreateLocationFsxOpenZfsRequest$SecurityGroupArns": "<p>The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.</p>",
"CreateLocationFsxWindowsRequest$SecurityGroupArns": "<p>The ARNs of the security groups that are used to configure the FSx for Windows File Server file system.</p>",
"DescribeLocationFsxLustreResponse$SecurityGroupArns": "<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.</p>",
"DescribeLocationFsxOpenZfsResponse$SecurityGroupArns": "<p>The ARNs of the security groups that are configured for the FSx for OpenZFS file system.</p>",
"DescribeLocationFsxWindowsResponse$SecurityGroupArns": "<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.</p>",
"Ec2Config$SecurityGroupArns": "<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.</p>"
}
},
"Ec2SubnetArn": {
"base": null,
"refs": {
"Ec2Config$SubnetArn": "<p>The ARN of the subnet that DataSync uses to access the target EFS file system.</p>",
"PLSubnetArnList$member": null
}
},
"EfsFilesystemArn": {
"base": null,
"refs": {
"CreateLocationEfsRequest$EfsFilesystemArn": "<p>The Amazon Resource Name (ARN) for the Amazon EFS file system.</p>"
}
},
"EfsSubdirectory": {
"base": null,
"refs": {
"CreateLocationEfsRequest$Subdirectory": "<p>A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, DataSync uses the root directory.</p> <note> <p> <code>Subdirectory</code> must be specified with forward slashes. For example, <code>/path/to/folder</code>.</p> </note>"
}
},
"Endpoint": {
"base": null,
"refs": {
"PrivateLinkConfig$PrivateLinkEndpoint": "<p>The private endpoint that is configured for an agent that has access to IP addresses in a <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html\">PrivateLink</a>. An agent that is configured with this endpoint will not be accessible over the public internet.</p>"
}
},
"EndpointType": {
"base": null,
"refs": {
"DescribeAgentResponse$EndpointType": "<p>The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet. </p>"
}
},
"FilterAttributeValue": {
"base": null,
"refs": {
"FilterValues$member": null
}
},
"FilterList": {
"base": null,
"refs": {
"CreateTaskRequest$Excludes": "<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>. </p> <p> </p>",
"CreateTaskRequest$Includes": "<p>A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>.</p>",
"DescribeTaskExecutionResponse$Excludes": "<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>",
"DescribeTaskExecutionResponse$Includes": "<p>A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>\"/folder1|/folder2\"</code> </p> <p> </p>",
"DescribeTaskResponse$Excludes": "<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>. </p> <p> </p>",
"DescribeTaskResponse$Includes": "<p>A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2</code>\".</p>",
"StartTaskExecutionRequest$Includes": "<p>A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>. </p> <p> </p>",
"StartTaskExecutionRequest$Excludes": "<p>A list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>. </p>",
"UpdateTaskRequest$Excludes": "<p>A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>.</p> <p> </p>",
"UpdateTaskRequest$Includes": "<p>A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example, <code>\"/folder1|/folder2\"</code>.</p>"
}
},
"FilterRule": {
"base": "<p>Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.</p>",
"refs": {
"FilterList$member": null
}
},
"FilterType": {
"base": null,
"refs": {
"FilterRule$FilterType": "<p>The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.</p>"
}
},
"FilterValue": {
"base": null,
"refs": {
"FilterRule$Value": "<p>A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: <code>/folder1|/folder2</code> </p> <p> </p>"
}
},
"FilterValues": {
"base": null,
"refs": {
"LocationFilter$Values": "<p>The values that you want to filter for. For example, you might want to display only Amazon S3 locations.</p>",
"TaskFilter$Values": "<p>The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.</p>"
}
},
"FsxFilesystemArn": {
"base": null,
"refs": {
"CreateLocationFsxLustreRequest$FsxFilesystemArn": "<p>The Amazon Resource Name (ARN) for the FSx for Lustre file system.</p>",
"CreateLocationFsxOpenZfsRequest$FsxFilesystemArn": "<p>The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.</p>",
"CreateLocationFsxWindowsRequest$FsxFilesystemArn": "<p>The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.</p>"
}
},
"FsxLustreSubdirectory": {
"base": null,
"refs": {
"CreateLocationFsxLustreRequest$Subdirectory": "<p>A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.</p>"
}
},
"FsxOpenZfsSubdirectory": {
"base": null,
"refs": {
"CreateLocationFsxOpenZfsRequest$Subdirectory": "<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 system is a source or destination location).</p>"
}
},
"FsxProtocol": {
"base": "<p>Represents the protocol that DataSync uses to access your Amazon FSx for OpenZFS file system.</p>",
"refs": {
"CreateLocationFsxOpenZfsRequest$Protocol": "<p>The type of protocol that DataSync uses to access your file system.</p>",
"DescribeLocationFsxOpenZfsResponse$Protocol": "<p>The type of protocol that DataSync uses to access your file system.</p>"
}
},
"FsxProtocolNfs": {
"base": "<p>Represents the Network File System (NFS) protocol that DataSync uses to access your Amazon FSx for OpenZFS file system.</p>",
"refs": {
"FsxProtocol$NFS": "<p>Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.</p>"
}
},
"FsxWindowsSubdirectory": {
"base": null,
"refs": {
"CreateLocationFsxWindowsRequest$Subdirectory": "<p>A subdirectory in the location's path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.</p>"
}
},
"Gid": {
"base": null,
"refs": {
"Options$Gid": "<p>The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied\">Metadata Copied by DataSync</a>. </p> <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p> <p>INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).</p> <p>NONE: Ignore UID and GID. </p>"
}
},
"HdfsAuthenticationType": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$AuthenticationType": "<p>The type of authentication used to determine the identity of the user. </p>",
"DescribeLocationHdfsResponse$AuthenticationType": "<p>The type of authentication used to determine the identity of the user. </p>",
"UpdateLocationHdfsRequest$AuthenticationType": "<p>The type of authentication used to determine the identity of the user. </p>"
}
},
"HdfsBlockSize": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$BlockSize": "<p>The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).</p>",
"DescribeLocationHdfsResponse$BlockSize": "<p>The size of the data blocks to write into the HDFS cluster. </p>",
"UpdateLocationHdfsRequest$BlockSize": "<p>The size of the data blocks to write into the HDFS cluster. </p>"
}
},
"HdfsDataTransferProtection": {
"base": null,
"refs": {
"QopConfiguration$DataTransferProtection": "<p>The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your <code>dfs.data.transfer.protection</code> setting in the <code>hdfs-site.xml</code> file on your Hadoop cluster.</p>"
}
},
"HdfsNameNode": {
"base": "<p>The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.</p>",
"refs": {
"HdfsNameNodeList$member": null
}
},
"HdfsNameNodeList": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$NameNodes": "<p>The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.</p>",
"DescribeLocationHdfsResponse$NameNodes": "<p>The NameNode that manage the HDFS namespace. </p>",
"UpdateLocationHdfsRequest$NameNodes": "<p>The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.</p>"
}
},
"HdfsReplicationFactor": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$ReplicationFactor": "<p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.</p>",
"DescribeLocationHdfsResponse$ReplicationFactor": "<p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. </p>",
"UpdateLocationHdfsRequest$ReplicationFactor": "<p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. </p>"
}
},
"HdfsRpcProtection": {
"base": null,
"refs": {
"QopConfiguration$RpcProtection": "<p>The RPC protection setting configured on the HDFS cluster. This setting corresponds to your <code>hadoop.rpc.protection</code> setting in your <code>core-site.xml</code> file on your Hadoop cluster.</p>"
}
},
"HdfsServerHostname": {
"base": null,
"refs": {
"HdfsNameNode$Hostname": "<p>The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.</p>"
}
},
"HdfsServerPort": {
"base": null,
"refs": {
"HdfsNameNode$Port": "<p>The port that the NameNode uses to listen to client requests.</p>"
}
},
"HdfsSubdirectory": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$Subdirectory": "<p>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to <code>/</code>.</p>",
"UpdateLocationHdfsRequest$Subdirectory": "<p>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.</p>"
}
},
"HdfsUser": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$SimpleUser": "<p>The user name used to identify the client on the host operating system. </p> <note> <p>If <code>SIMPLE</code> is specified for <code>AuthenticationType</code>, this parameter is required. </p> </note>",
"DescribeLocationHdfsResponse$SimpleUser": "<p>The user name used to identify the client on the host operating system. This parameter is used if the <code>AuthenticationType</code> is defined as <code>SIMPLE</code>.</p>",
"UpdateLocationHdfsRequest$SimpleUser": "<p>The user name used to identify the client on the host operating system.</p>"
}
},
"IamRoleArn": {
"base": null,
"refs": {
"S3Config$BucketAccessRoleArn": "<p>The ARN of the IAM role for accessing the S3 bucket. </p>"
}
},
"InputTagList": {
"base": null,
"refs": {
"CreateAgentRequest$Tags": "<p>The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. </p> </note>",
"CreateLocationEfsRequest$Tags": "<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>",
"CreateLocationFsxLustreRequest$Tags": "<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>",
"CreateLocationFsxOpenZfsRequest$Tags": "<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>",
"CreateLocationFsxWindowsRequest$Tags": "<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>",
"CreateLocationHdfsRequest$Tags": "<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources. </p>",
"CreateLocationNfsRequest$Tags": "<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>",
"CreateLocationObjectStorageRequest$Tags": "<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>",
"CreateLocationS3Request$Tags": "<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>",
"CreateLocationSmbRequest$Tags": "<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>",
"CreateTaskRequest$Tags": "<p>The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string. </p>",
"TagResourceRequest$Tags": "<p>The tags to apply.</p>"
}
},
"InternalException": {
"base": "<p>This exception is thrown when an error occurs in the DataSync service.</p>",
"refs": {
}
},
"InvalidRequestException": {
"base": "<p>This exception is thrown when the client submits a malformed request.</p>",
"refs": {
}
},
"KerberosKeytabFile": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$KerberosKeytab": "<p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text. </p> <note> <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required. </p> </note>",
"UpdateLocationHdfsRequest$KerberosKeytab": "<p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.</p>"
}
},
"KerberosKrb5ConfFile": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$KerberosKrb5Conf": "<p>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You can load the <code>krb5.conf</code> file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text. </p> <note> <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required.</p> </note>",
"UpdateLocationHdfsRequest$KerberosKrb5Conf": "<p>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You can load the <code>krb5.conf</code> file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.</p>"
}
},
"KerberosPrincipal": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$KerberosPrincipal": "<p>The Kerberos principal with access to the files and folders on the HDFS cluster. </p> <note> <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required.</p> </note>",
"DescribeLocationHdfsResponse$KerberosPrincipal": "<p>The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the <code>AuthenticationType</code> is defined as <code>KERBEROS</code>.</p>",
"UpdateLocationHdfsRequest$KerberosPrincipal": "<p>The Kerberos principal with access to the files and folders on the HDFS cluster. </p>"
}
},
"KmsKeyProviderUri": {
"base": null,
"refs": {
"CreateLocationHdfsRequest$KmsKeyProviderUri": "<p>The URI of the HDFS cluster's Key Management Server (KMS). </p>",
"DescribeLocationHdfsResponse$KmsKeyProviderUri": "<p> The URI of the HDFS cluster's Key Management Server (KMS). </p>",
"UpdateLocationHdfsRequest$KmsKeyProviderUri": "<p>The URI of the HDFS cluster's Key Management Server (KMS). </p>"
}
},
"ListAgentsRequest": {
"base": "<p>ListAgentsRequest</p>",
"refs": {
}
},
"ListAgentsResponse": {
"base": "<p>ListAgentsResponse</p>",
"refs": {
}
},
"ListLocationsRequest": {
"base": "<p>ListLocationsRequest</p>",
"refs": {
}
},
"ListLocationsResponse": {
"base": "<p>ListLocationsResponse</p>",
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": "<p>ListTagsForResourceRequest</p>",
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": "<p>ListTagsForResourceResponse</p>",
"refs": {
}
},
"ListTaskExecutionsRequest": {
"base": "<p>ListTaskExecutions</p>",
"refs": {
}
},
"ListTaskExecutionsResponse": {
"base": "<p>ListTaskExecutionsResponse</p>",
"refs": {
}
},
"ListTasksRequest": {
"base": "<p>ListTasksRequest</p>",
"refs": {
}
},
"ListTasksResponse": {
"base": "<p>ListTasksResponse</p>",
"refs": {
}
},
"LocationArn": {
"base": null,
"refs": {
"CreateLocationEfsResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.</p>",
"CreateLocationFsxLustreResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's created. </p>",
"CreateLocationFsxOpenZfsResponse$LocationArn": "<p>The ARN of the FSx for OpenZFS file system location that you created.</p>",
"CreateLocationFsxWindowsResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location you created.</p>",
"CreateLocationHdfsResponse$LocationArn": "<p>The ARN of the source HDFS cluster location that's created. </p>",
"CreateLocationNfsResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the source NFS file system location that is created.</p>",
"CreateLocationObjectStorageResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.</p>",
"CreateLocationS3Response$LocationArn": "<p>The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.</p>",
"CreateLocationSmbResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the source SMB file system location that is created.</p>",
"CreateTaskRequest$SourceLocationArn": "<p>The Amazon Resource Name (ARN) of the source location for the task.</p>",
"CreateTaskRequest$DestinationLocationArn": "<p>The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location. </p>",
"DeleteLocationRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the location to delete.</p>",
"DescribeLocationEfsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the EFS location to describe.</p>",
"DescribeLocationEfsResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the EFS location that was described.</p>",
"DescribeLocationFsxLustreRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for Lustre location to describe. </p>",
"DescribeLocationFsxLustreResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.</p>",
"DescribeLocationFsxOpenZfsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.</p>",
"DescribeLocationFsxOpenZfsResponse$LocationArn": "<p>The ARN of the FSx for OpenZFS location that was described.</p>",
"DescribeLocationFsxWindowsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.</p>",
"DescribeLocationFsxWindowsResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.</p>",
"DescribeLocationHdfsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the HDFS cluster location to describe.</p>",
"DescribeLocationHdfsResponse$LocationArn": "<p>The ARN of the HDFS cluster location.</p>",
"DescribeLocationNfsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the NFS location to describe.</p>",
"DescribeLocationNfsResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the NFS location that was described.</p>",
"DescribeLocationObjectStorageRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.</p>",
"DescribeLocationObjectStorageResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.</p>",
"DescribeLocationS3Request$LocationArn": "<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.</p>",
"DescribeLocationS3Response$LocationArn": "<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.</p>",
"DescribeLocationSmbRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the SMB location to describe.</p>",
"DescribeLocationSmbResponse$LocationArn": "<p>The Amazon Resource Name (ARN) of the SMB location that was described.</p>",
"DescribeTaskResponse$SourceLocationArn": "<p>The Amazon Resource Name (ARN) of the source file system's location.</p>",
"DescribeTaskResponse$DestinationLocationArn": "<p>The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.</p>",
"LocationListEntry$LocationArn": "<p>The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.</p>",
"UpdateLocationHdfsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the source HDFS cluster location.</p>",
"UpdateLocationNfsRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the NFS location to update.</p>",
"UpdateLocationObjectStorageRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.</p>",
"UpdateLocationSmbRequest$LocationArn": "<p>The Amazon Resource Name (ARN) of the SMB location to update.</p>"
}
},
"LocationFilter": {
"base": "<p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all your Amazon S3 locations, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>",
"refs": {
"LocationFilters$member": null
}
},
"LocationFilterName": {
"base": null,
"refs": {
"LocationFilter$Name": "<p>The name of the filter being used. Each API call supports a list of filters that are available for it (for example, <code>LocationType</code> for <code>ListLocations</code>).</p>"
}
},
"LocationFilters": {
"base": null,
"refs": {
"ListLocationsRequest$Filters": "<p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>"
}
},
"LocationList": {
"base": null,
"refs": {
"ListLocationsResponse$Locations": "<p>An array that contains a list of locations.</p>"
}
},
"LocationListEntry": {
"base": "<p>Represents a single entry in a list of locations. <code>LocationListEntry</code> returns an array that contains a list of locations when the <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html\">ListLocations</a> operation is called.</p>",
"refs": {
"LocationList$member": null
}
},
"LocationUri": {
"base": null,
"refs": {
"DescribeLocationEfsResponse$LocationUri": "<p>The URL of the EFS location that was described.</p>",
"DescribeLocationFsxLustreResponse$LocationUri": "<p>The URI of the FSx for Lustre location that was described.</p>",
"DescribeLocationFsxOpenZfsResponse$LocationUri": "<p>The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.</p> <p>Example: <code>fsxz:https://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder</code> </p>",
"DescribeLocationFsxWindowsResponse$LocationUri": "<p>The URL of the FSx for Windows File Server location that was described.</p>",
"DescribeLocationHdfsResponse$LocationUri": "<p>The URI of the HDFS cluster location.</p>",
"DescribeLocationNfsResponse$LocationUri": "<p>The URL of the source NFS location that was described.</p>",
"DescribeLocationObjectStorageResponse$LocationUri": "<p>The URL of the source self-managed object storage server location that was described.</p>",
"DescribeLocationS3Response$LocationUri": "<p>The URL of the Amazon S3 location that was described.</p>",
"DescribeLocationSmbResponse$LocationUri": "<p>The URL of the source SMB location that was described.</p>",
"LocationListEntry$LocationUri": "<p>Represents a list of URIs of a location. <code>LocationUri</code> returns an array that contains a list of locations when the <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html\">ListLocations</a> operation is called.</p> <p>Format: <code>TYPE:https://GLOBAL_ID/SUBDIR</code>.</p> <p>TYPE designates the type of location (for example, <code>nfs</code> or <code>s3</code>).</p> <p>GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is <code>us-east-2.fs-abcd1234</code>. An example for Amazon S3 is the bucket name, such as <code>myBucket</code>. An example for NFS is a valid IPv4 address or a hostname that is compliant with Domain Name Service (DNS).</p> <p>SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.</p> <p/>"
}
},
"LogGroupArn": {
"base": null,
"refs": {
"CreateTaskRequest$CloudWatchLogGroupArn": "<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. </p>",
"DescribeTaskResponse$CloudWatchLogGroupArn": "<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.</p> <p>For more information on these groups, see Working with Log Groups and Log Streams in the <i>Amazon CloudWatch User Guide</i>.</p>",
"UpdateTaskRequest$CloudWatchLogGroupArn": "<p>The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.</p>"
}
},
"LogLevel": {
"base": null,
"refs": {
"Options$LogLevel": "<p>A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn\">CloudWatchLogGroupArn</a>. If set to <code>OFF</code>, no logs are published. <code>BASIC</code> publishes logs on errors for individual files transferred, and <code>TRANSFER</code> publishes logs for every file or object that is transferred and integrity checked.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListAgentsRequest$MaxResults": "<p>The maximum number of agents to list.</p>",
"ListLocationsRequest$MaxResults": "<p>The maximum number of locations to return.</p>",
"ListTagsForResourceRequest$MaxResults": "<p>The maximum number of locations to return.</p>",
"ListTaskExecutionsRequest$MaxResults": "<p>The maximum number of executed tasks to list.</p>",
"ListTasksRequest$MaxResults": "<p>The maximum number of tasks to return.</p>"
}
},
"Mtime": {
"base": null,
"refs": {
"Options$Mtime": "<p>A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time. </p> <p>Default value: PRESERVE. </p> <p>PRESERVE: Preserve original <code>Mtime</code> (recommended)</p> <p> NONE: Ignore <code>Mtime</code>. </p> <note> <p>If <code>Mtime</code> is set to PRESERVE, <code>Atime</code> must be set to BEST_EFFORT.</p> <p>If <code>Mtime</code> is set to NONE, <code>Atime</code> must also be set to NONE. </p> </note>"
}
},
"NetworkInterfaceArn": {
"base": null,
"refs": {
"DestinationNetworkInterfaceArns$member": null,
"SourceNetworkInterfaceArns$member": null
}
},
"NextToken": {
"base": null,
"refs": {
"ListAgentsRequest$NextToken": "<p>An opaque string that indicates the position at which to begin the next list of agents.</p>",
"ListAgentsResponse$NextToken": "<p>An opaque string that indicates the position at which to begin returning the next list of agents.</p>",
"ListLocationsRequest$NextToken": "<p>An opaque string that indicates the position at which to begin the next list of locations.</p>",
"ListLocationsResponse$NextToken": "<p>An opaque string that indicates the position at which to begin returning the next list of locations.</p>",
"ListTagsForResourceRequest$NextToken": "<p>An opaque string that indicates the position at which to begin the next list of locations.</p>",
"ListTagsForResourceResponse$NextToken": "<p>An opaque string that indicates the position at which to begin returning the next list of resource tags.</p>",
"ListTaskExecutionsRequest$NextToken": "<p>An opaque string that indicates the position at which to begin the next list of the executed tasks.</p>",
"ListTaskExecutionsResponse$NextToken": "<p>An opaque string that indicates the position at which to begin returning the next list of executed tasks.</p>",
"ListTasksRequest$NextToken": "<p>An opaque string that indicates the position at which to begin the next list of tasks.</p>",
"ListTasksResponse$NextToken": "<p>An opaque string that indicates the position at which to begin returning the next list of tasks.</p>"
}
},
"NfsMountOptions": {
"base": "<p>Represents the mount options that are available for DataSync to access an NFS location.</p>",
"refs": {
"CreateLocationNfsRequest$MountOptions": "<p>The NFS mount options that DataSync can use to mount your NFS share.</p>",
"DescribeLocationNfsResponse$MountOptions": "<p>The NFS mount options that DataSync used to mount your NFS share.</p>",
"FsxProtocolNfs$MountOptions": null,
"UpdateLocationNfsRequest$MountOptions": null
}
},
"NfsSubdirectory": {
"base": null,
"refs": {
"CreateLocationNfsRequest$Subdirectory": "<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p> <p>To see all the paths exported by your NFS server, run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p> <p>If you are copying data to or from your Snowcone device, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone\">NFS Server on Snowcone</a> for more information.</p> <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>",
"UpdateLocationNfsRequest$Subdirectory": "<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.</p> <p>To see all the paths exported by your NFS server, run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash</code>, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p> <p>If you are copying data to or from your Snowcone device, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone\">NFS Server on Snowcone</a> for more information.</p> <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>"
}
},
"NfsVersion": {
"base": null,
"refs": {
"NfsMountOptions$Version": "<p>The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the NFS server.</p> <p>You can specify the following NFS versions:</p> <ul> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc1813\">NFSv3</a> </b> - stateless protocol version that allows for asynchronous writes on the server.</p> </li> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc3530\">NFSv4.0</a> </b> - stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.</p> </li> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc5661\">NFSv4.1</a> </b> - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.</p> </li> </ul>"
}
},
"ObjectStorageAccessKey": {
"base": null,
"refs": {
"CreateLocationObjectStorageRequest$AccessKey": "<p>Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>",
"DescribeLocationObjectStorageResponse$AccessKey": "<p>Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>",
"UpdateLocationObjectStorageRequest$AccessKey": "<p>Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>"
}
},
"ObjectStorageBucketName": {
"base": null,
"refs": {
"CreateLocationObjectStorageRequest$BucketName": "<p>The bucket on the self-managed object storage server that is used to read data from.</p>"
}
},
"ObjectStorageSecretKey": {
"base": null,
"refs": {
"CreateLocationObjectStorageRequest$SecretKey": "<p>Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>",
"UpdateLocationObjectStorageRequest$SecretKey": "<p>Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>"
}
},
"ObjectStorageServerPort": {
"base": null,
"refs": {
"CreateLocationObjectStorageRequest$ServerPort": "<p>The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.</p>",
"DescribeLocationObjectStorageResponse$ServerPort": "<p>The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).</p>",
"UpdateLocationObjectStorageRequest$ServerPort": "<p>The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.</p>"
}
},
"ObjectStorageServerProtocol": {
"base": null,
"refs": {
"CreateLocationObjectStorageRequest$ServerProtocol": "<p>The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.</p>",
"DescribeLocationObjectStorageResponse$ServerProtocol": "<p>The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.</p>",
"UpdateLocationObjectStorageRequest$ServerProtocol": "<p>The protocol that the object storage server uses to communicate. Valid values are <code>HTTP</code> or <code>HTTPS</code>.</p>"
}
},
"OnPremConfig": {
"base": "<p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.</p>",
"refs": {
"CreateLocationNfsRequest$OnPremConfig": "<p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server. </p> <p>If you are copying data to or from your Snowcone device, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone\">NFS Server on Snowcone</a> for more information.</p>",
"DescribeLocationNfsResponse$OnPremConfig": null,
"UpdateLocationNfsRequest$OnPremConfig": null
}
},
"Operator": {
"base": null,
"refs": {
"LocationFilter$Operator": "<p>The operator that is used to compare filter values (for example, <code>Equals</code> or <code>Contains</code>). For more about API filtering operators, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html\">API filters for ListTasks and ListLocations</a>.</p>",
"TaskFilter$Operator": "<p>The operator that is used to compare filter values (for example, <code>Equals</code> or <code>Contains</code>). For more about API filtering operators, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html\">API filters for ListTasks and ListLocations</a>.</p>"
}
},
"Options": {
"base": "<p>Represents the options that are available to control the behavior of a <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html\">StartTaskExecution</a> operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.</p> <p>A task has a set of default options associated with it. If you don't specify an option in <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html\">StartTaskExecution</a>, the default value is used. You can override the defaults options on each task execution by specifying an overriding <code>Options</code> value to <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html\">StartTaskExecution</a>.</p>",
"refs": {
"CreateTaskRequest$Options": "<p>The set of configuration options that control the behavior of a single execution of the task that occurs when you call <code>StartTaskExecution</code>. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.</p> <p>For each individual task execution, you can override these options by specifying the <code>OverrideOptions</code> before starting the task execution. For more information, see the <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html\">StartTaskExecution</a> operation. </p>",
"DescribeTaskExecutionResponse$Options": null,
"DescribeTaskResponse$Options": "<p>The set of configuration options that control the behavior of a single execution of the task that occurs when you call <code>StartTaskExecution</code>. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.</p> <p>For each individual task execution, you can override these options by specifying the overriding <code>OverrideOptions</code> value to <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html\">StartTaskExecution</a> operation. </p>",
"StartTaskExecutionRequest$OverrideOptions": null,
"UpdateTaskExecutionRequest$Options": null,
"UpdateTaskRequest$Options": null
}
},
"OutputTagList": {
"base": null,
"refs": {
"ListTagsForResourceResponse$Tags": "<p>Array of resource tags.</p>"
}
},
"OverwriteMode": {
"base": null,
"refs": {
"Options$OverwriteMode": "<p>A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to <code>NEVER</code> a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes. </p> <p>Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes\">Considerations when working with Amazon S3 storage classes in DataSync </a> in the <i>DataSync User Guide</i>.</p>"
}
},
"PLSecurityGroupArnList": {
"base": null,
"refs": {
"CreateAgentRequest$SecurityGroupArns": "<p>The ARNs of the security groups used to protect your data transfer task subnets. See <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns\">SecurityGroupArns</a>.</p>",
"PrivateLinkConfig$SecurityGroupArns": "<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.</p>"
}
},
"PLSubnetArnList": {
"base": null,
"refs": {
"CreateAgentRequest$SubnetArns": "<p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.</p>",
"PrivateLinkConfig$SubnetArns": "<p>The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.</p>"
}
},
"PhaseStatus": {
"base": null,
"refs": {
"TaskExecutionResultDetail$PrepareStatus": "<p>The status of the PREPARING phase.</p>",
"TaskExecutionResultDetail$TransferStatus": "<p>The status of the TRANSFERRING phase.</p>",
"TaskExecutionResultDetail$VerifyStatus": "<p>The status of the VERIFYING phase.</p>"
}
},
"PosixPermissions": {
"base": null,
"refs": {
"Options$PosixPermissions": "<p>A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied\">Metadata Copied by DataSync</a>. </p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Preserve POSIX-style permissions (recommended).</p> <p>NONE: Ignore permissions. </p> <note> <p>DataSync can preserve extant permissions of a source location.</p> </note>"
}