/
docs-2.json
922 lines (922 loc) · 80.3 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
{
"version": "2.0",
"service": "<fullname>Amazon Elastic File System</fullname> <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the <a href=\"https://docs.aws.amazon.com/efs/latest/ug/api-reference.html\">Amazon Elastic File System API Reference</a> and the <a href=\"https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html\">Amazon Elastic File System User Guide</a>.</p>",
"operations": {
"CreateAccessPoint": "<p>Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Mounting a file system using EFS access points</a>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>",
"CreateFileSystem": "<p>Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:</p> <ul> <li> <p>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state <code>creating</code>.</p> </li> <li> <p>Returns with the description of the created file system.</p> </li> </ul> <p>Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system.</p> <note> <p>For basic use cases, you can use a randomly generated UUID for the creation token.</p> </note> <p> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1\">Creating a file system</a> in the <i>Amazon EFS User Guide</i>.</p> <note> <p>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still <code>creating</code>. You can check the file system creation status by calling the <a>DescribeFileSystems</a> operation, which among other things returns the file system state.</p> </note> <p>This operation accepts an optional <code>PerformanceMode</code> parameter that you choose for your file system. We recommend <code>generalPurpose</code> performance mode for most file systems. File systems using the <code>maxIO</code> performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html\">Amazon EFS performance modes</a>.</p> <p>You can set the throughput mode for the file system using the <code>ThroughputMode</code> parameter.</p> <p>After the file system is fully created, Amazon EFS sets its lifecycle state to <code>available</code>, at which point you can create one or more mount targets for the file system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p> <p> This operation requires permissions for the <code>elasticfilesystem:CreateFileSystem</code> action. </p>",
"CreateMountTarget": "<p>Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.</p> <p>You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.</p> <p>You can create only one mount target for an EFS file system using One Zone storage classes. You must create that mount target in the same Availability Zone in which the file system is located. Use the <code>AvailabilityZoneName</code> and <code>AvailabiltyZoneId</code> properties in the <a>DescribeFileSystems</a> response object to get this information. Use the <code>subnetId</code> associated with the file system's Availability Zone when creating the mount target.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p> <p>To create a mount target for a file system, the file system's lifecycle state must be <code>available</code>. For more information, see <a>DescribeFileSystems</a>.</p> <p>In the request, provide the following:</p> <ul> <li> <p>The file system ID for which you are creating the mount target.</p> </li> <li> <p>A subnet ID, which determines the following:</p> <ul> <li> <p>The VPC in which Amazon EFS creates the mount target</p> </li> <li> <p>The Availability Zone in which Amazon EFS creates the mount target</p> </li> <li> <p>The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)</p> </li> </ul> </li> </ul> <p>After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation\">How it Works: Implementation Overview</a>. </p> <p>Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:</p> <ul> <li> <p>Must belong to the same VPC as the subnets of the existing mount targets</p> </li> <li> <p>Must not be in the same Availability Zone as any of the subnets of the existing mount targets</p> </li> </ul> <p>If the request satisfies the requirements, Amazon EFS does the following:</p> <ul> <li> <p>Creates a new mount target in the specified subnet.</p> </li> <li> <p>Also creates a new network interface in the subnet as follows:</p> <ul> <li> <p>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address).</p> </li> <li> <p>If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.</p> </li> <li> <p>Assigns the description <code>Mount target <i>fsmt-id</i> for file system <i>fs-id</i> </code> where <code> <i>fsmt-id</i> </code> is the mount target ID, and <code> <i>fs-id</i> </code> is the <code>FileSystemId</code>.</p> </li> <li> <p>Sets the <code>requesterManaged</code> property of the network interface to <code>true</code>, and the <code>requesterId</code> value to <code>EFS</code>.</p> </li> </ul> <p>Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails.</p> </li> </ul> <note> <p>The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still <code>creating</code>, you can check the mount target creation status by calling the <a>DescribeMountTargets</a> operation, which among other things returns the mount target state.</p> </note> <p>We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see <a href=\"http://aws.amazon.com/efs/\">Amazon EFS</a>. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. </p> <p>This operation requires permissions for the following action on the file system:</p> <ul> <li> <p> <code>elasticfilesystem:CreateMountTarget</code> </p> </li> </ul> <p>This operation also requires permissions for the following Amazon EC2 actions:</p> <ul> <li> <p> <code>ec2:DescribeSubnets</code> </p> </li> <li> <p> <code>ec2:DescribeNetworkInterfaces</code> </p> </li> <li> <p> <code>ec2:CreateNetworkInterface</code> </p> </li> </ul>",
"CreateTags": "<note> <p>DEPRECATED - CreateTags is deprecated and not maintained. Please use the API action to create tags for EFS resources.</p> </note> <p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the <code>Name</code> tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> operation. </p> <p>This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action.</p>",
"DeleteAccessPoint": "<p>Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteAccessPoint</code> action.</p>",
"DeleteFileSystem": "<p>Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.</p> <p> You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p> <note> <p>The <code>DeleteFileSystem</code> call returns while the file system state is still <code>deleting</code>. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> returns a <code>404 FileSystemNotFound</code> error.</p> </note> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteFileSystem</code> action.</p>",
"DeleteFileSystemPolicy": "<p>Deletes the <code>FileSystemPolicy</code> for the specified file system. The default <code>FileSystemPolicy</code> goes into effect once the existing policy is deleted. For more information about the default file system policy, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html\">Using Resource-based Policies with EFS</a>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteFileSystemPolicy</code> action.</p>",
"DeleteMountTarget": "<p>Deletes the specified mount target.</p> <p>This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.</p> <p>This operation requires permissions for the following action on the file system:</p> <ul> <li> <p> <code>elasticfilesystem:DeleteMountTarget</code> </p> </li> </ul> <note> <p>The <code>DeleteMountTarget</code> call returns while the mount target state is still <code>deleting</code>. You can check the mount target deletion by calling the <a>DescribeMountTargets</a> operation, which returns a list of mount target descriptions for the given file system. </p> </note> <p>The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:</p> <ul> <li> <p> <code>ec2:DeleteNetworkInterface</code> </p> </li> </ul>",
"DeleteTags": "<note> <p>DEPRECATED - DeleteTags is deprecated and not maintained. Please use the API action to remove tags from EFS resources.</p> </note> <p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Tag restrictions</a> in the <i>Billing and Cost Management User Guide</i>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteTags</code> action.</p>",
"DescribeAccessPoints": "<p>Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided. If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system. You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. </p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>",
"DescribeAccountPreferences": "<p>Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region. For more information, see <a href=\"efs/latest/ug/manage-efs-resource-ids.html\">Managing Amazon EFS resource IDs</a>.</p>",
"DescribeBackupPolicy": "<p>Returns the backup policy for the specified EFS file system.</p>",
"DescribeFileSystemPolicy": "<p>Returns the <code>FileSystemPolicy</code> for the specified EFS file system.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeFileSystemPolicy</code> action.</p>",
"DescribeFileSystems": "<p>Returns the description of a specific Amazon EFS file system if either the file system <code>CreationToken</code> or the <code>FileSystemId</code> is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.</p> <p>When retrieving all file system descriptions, you can optionally specify the <code>MaxItems</code> parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a <code>NextMarker</code>, an opaque token, in the response. In this case, you should send a subsequent request with the <code>Marker</code> request parameter set to the value of <code>NextMarker</code>. </p> <p>To retrieve a list of your file system descriptions, this operation is used in an iterative process, where <code>DescribeFileSystems</code> is called first without the <code>Marker</code> and then the operation continues to call it with the <code>Marker</code> parameter set to the value of the <code>NextMarker</code> from the previous response until the response has no <code>NextMarker</code>. </p> <p> The order of file systems returned in the response of one <code>DescribeFileSystems</code> call and the order of file systems returned across the responses of a multi-call iteration is unspecified. </p> <p> This operation requires permissions for the <code>elasticfilesystem:DescribeFileSystems</code> action. </p>",
"DescribeLifecycleConfiguration": "<p>Returns the current <code>LifecycleConfiguration</code> object for the specified Amazon EFS file system. EFS lifecycle management uses the <code>LifecycleConfiguration</code> object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a <code>LifecycleConfiguration</code> object, the call returns an empty array in the response.</p> <p>When EFS Intelligent Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has a value of <code>AFTER_1_ACCESS</code>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeLifecycleConfiguration</code> operation.</p>",
"DescribeMountTargetSecurityGroups": "<p>Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <code>deleted</code>.</p> <p>This operation requires permissions for the following actions:</p> <ul> <li> <p> <code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </p> </li> <li> <p> <code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </p> </li> </ul>",
"DescribeMountTargets": "<p>Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeMountTargets</code> action, on either the file system ID that you specify in <code>FileSystemId</code>, or on the file system of the mount target that you specify in <code>MountTargetId</code>.</p>",
"DescribeTags": "<note> <p>DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the API action to remove tags from EFS resources.</p> </note> <p>Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. </p> <p> This operation requires permissions for the <code>elasticfilesystem:DescribeTags</code> action. </p>",
"ListTagsForResource": "<p>Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>",
"ModifyMountTargetSecurityGroups": "<p>Modifies the set of security groups in effect for a mount target.</p> <p>When you create a mount target, Amazon EFS also creates a new network interface. For more information, see <a>CreateMountTarget</a>. This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <code>deleted</code>. </p> <p>The operation requires permissions for the following actions:</p> <ul> <li> <p> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </p> </li> <li> <p> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </p> </li> </ul>",
"PutAccountPreferences": "<p>Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html\">Managing Amazon EFS resource IDs</a>.</p> <note> <p>Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.</p> </note>",
"PutBackupPolicy": "<p>Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. </p>",
"PutFileSystemPolicy": "<p>Applies an Amazon EFS <code>FileSystemPolicy</code> to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy\">Default EFS File System Policy</a>. </p> <note> <p>EFS file system policies have a 20,000 character limit.</p> </note> <p>This operation requires permissions for the <code>elasticfilesystem:PutFileSystemPolicy</code> action.</p>",
"PutLifecycleConfiguration": "<p>Enables lifecycle management by creating a new <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html\">EFS Lifecycle Management</a>.</p> <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a <code>LifecycleConfiguration</code> object already exists for the specified file system, a <code>PutLifecycleConfiguration</code> call modifies the existing configuration. A <code>PutLifecycleConfiguration</code> call with an empty <code>LifecyclePolicies</code> array in the request body deletes any existing <code>LifecycleConfiguration</code> and turns off lifecycle management for the file system.</p> <p>In the request, specify the following: </p> <ul> <li> <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.</p> </li> <li> <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that define when files are moved to the IA storage class. Amazon EFS requires that each <code>LifecyclePolicy</code> object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate <code>LifecyclePolicy</code> objects. See the example requests in the following section for more information.</p> </li> </ul> <p>This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p> <p>To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system. </p>",
"TagResource": "<p>Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.</p> <p>This operation requires permissions for the <code>elasticfilesystem:TagResource</code> action.</p>",
"UntagResource": "<p>Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.</p> <p>This operation requires permissions for the <code>elasticfilesystem:UntagResource</code> action.</p>",
"UpdateFileSystem": "<p>Updates the throughput mode or the amount of provisioned throughput of an existing file system.</p>"
},
"shapes": {
"AccessPointAlreadyExists": {
"base": "<p>Returned if the access point you are trying to create already exists, with the creation token you provided in the request.</p>",
"refs": {
}
},
"AccessPointArn": {
"base": null,
"refs": {
"AccessPointDescription$AccessPointArn": "<p>The unique Amazon Resource Name (ARN) associated with the access point.</p>"
}
},
"AccessPointDescription": {
"base": "<p>Provides a description of an EFS file system access point.</p>",
"refs": {
"AccessPointDescriptions$member": null
}
},
"AccessPointDescriptions": {
"base": null,
"refs": {
"DescribeAccessPointsResponse$AccessPoints": "<p>An array of access point descriptions.</p>"
}
},
"AccessPointId": {
"base": null,
"refs": {
"AccessPointAlreadyExists$AccessPointId": null,
"AccessPointDescription$AccessPointId": "<p>The ID of the access point, assigned by Amazon EFS.</p>",
"DeleteAccessPointRequest$AccessPointId": "<p>The ID of the access point that you want to delete.</p>",
"DescribeAccessPointsRequest$AccessPointId": "<p>(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <code>FileSystemId</code>.</p>",
"DescribeMountTargetsRequest$AccessPointId": "<p>(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a <code>FileSystemId</code> or <code>MountTargetId</code> is not included in your request. Accepts either an access point ID or ARN as input.</p>"
}
},
"AccessPointLimitExceeded": {
"base": "<p>Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system.</p>",
"refs": {
}
},
"AccessPointNotFound": {
"base": "<p>Returned if the specified <code>AccessPointId</code> value doesn't exist in the requester's Amazon Web Services account.</p>",
"refs": {
}
},
"AvailabilityZoneId": {
"base": null,
"refs": {
"FileSystemDescription$AvailabilityZoneId": "<p>The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, <code>use1-az1</code> is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.</p>",
"MountTargetDescription$AvailabilityZoneId": "<p>The unique and consistent identifier of the Availability Zone that the mount target resides in. For example, <code>use1-az1</code> is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account.</p>"
}
},
"AvailabilityZoneName": {
"base": null,
"refs": {
"CreateFileSystemRequest$AvailabilityZoneName": "<p>Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format <code>us-east-1a</code> to specify the Availability Zone. For more information about One Zone storage classes, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html\">Using EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.</p> <note> <p>One Zone storage classes are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.</p> </note>",
"FileSystemDescription$AvailabilityZoneName": "<p>Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html\">Using EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.</p>",
"MountTargetDescription$AvailabilityZoneName": "<p>The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone <code>us-east-1a</code> for your Amazon Web Services account might not be the same location as <code>us-east-1a</code> for another Amazon Web Services account.</p>"
}
},
"AvailabilityZonesMismatch": {
"base": "<p>Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage classes. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html\">Regional and One Zone storage redundancy</a>.</p>",
"refs": {
}
},
"AwsAccountId": {
"base": null,
"refs": {
"AccessPointDescription$OwnerId": "<p>Identified the Amazon Web Services account that owns the access point resource.</p>",
"FileSystemDescription$OwnerId": "<p>The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.</p>",
"MountTargetDescription$OwnerId": "<p>Amazon Web Services account ID that owns the resource.</p>"
}
},
"Backup": {
"base": null,
"refs": {
"CreateFileSystemRequest$Backup": "<p>Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to <code>true</code> to enable automatic backups. If you are creating a file system that uses One Zone storage classes, automatic backups are enabled by default. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups\">Automatic backups</a> in the <i>Amazon EFS User Guide</i>.</p> <p>Default is <code>false</code>. However, if you specify an <code>AvailabilityZoneName</code>, the default is <code>true</code>.</p> <note> <p>Backup is not available in all Amazon Web Services Regionswhere Amazon EFS is available.</p> </note>"
}
},
"BackupPolicy": {
"base": "<p>The backup policy for the file system used to create automatic daily backups. If status has a value of <code>ENABLED</code>, the file system is being automatically backed up. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups\">Automatic backups</a>.</p>",
"refs": {
"BackupPolicyDescription$BackupPolicy": "<p>Describes the file system's backup policy, indicating whether automatic backups are turned on or off..</p>",
"PutBackupPolicyRequest$BackupPolicy": "<p>The backup policy included in the <code>PutBackupPolicy</code> request.</p>"
}
},
"BackupPolicyDescription": {
"base": null,
"refs": {
}
},
"BadRequest": {
"base": "<p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>",
"refs": {
}
},
"BypassPolicyLockoutSafetyCheck": {
"base": null,
"refs": {
"PutFileSystemPolicyRequest$BypassPolicyLockoutSafetyCheck": "<p>(Optional) A flag to indicate whether to bypass the <code>FileSystemPolicy</code> lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request will be locked out from making future <code>PutFileSystemPolicy</code> requests on the file system. Set <code>BypassPolicyLockoutSafetyCheck</code> to <code>True</code> only when you intend to prevent the principal that is making the request from making a subsequent <code>PutFileSystemPolicy</code> request on the file system. The default value is False. </p>"
}
},
"ClientToken": {
"base": null,
"refs": {
"AccessPointDescription$ClientToken": "<p>The opaque string specified in the request to ensure idempotent creation.</p>",
"CreateAccessPointRequest$ClientToken": "<p>A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.</p>"
}
},
"CreateAccessPointRequest": {
"base": null,
"refs": {
}
},
"CreateFileSystemRequest": {
"base": null,
"refs": {
}
},
"CreateMountTargetRequest": {
"base": "<p/>",
"refs": {
}
},
"CreateTagsRequest": {
"base": "<p/>",
"refs": {
}
},
"CreationInfo": {
"base": "<p>Required if the <code>RootDirectory</code> > <code>Path</code> specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code> > <code>Path</code>. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying <code>CreationInfo</code>, you must include values for all properties. </p> <p>Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.</p> <important> <p>If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> does not exist, attempts to mount the file system using the access point will fail.</p> </important>",
"refs": {
"RootDirectory$CreationInfo": "<p>(Optional) Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code>. If the <code>RootDirectory</code> > <code>Path</code> specified does not exist, EFS creates the root directory using the <code>CreationInfo</code> settings when a client connects to an access point. When specifying the <code>CreationInfo</code>, you must provide values for all properties. </p> <important> <p>If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> > <code>Path</code> does not exist, attempts to mount the file system using the access point will fail.</p> </important>"
}
},
"CreationToken": {
"base": null,
"refs": {
"CreateFileSystemRequest$CreationToken": "<p>A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</p>",
"DescribeFileSystemsRequest$CreationToken": "<p>(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.</p>",
"FileSystemDescription$CreationToken": "<p>The opaque string specified in the request.</p>"
}
},
"DeleteAccessPointRequest": {
"base": null,
"refs": {
}
},
"DeleteFileSystemPolicyRequest": {
"base": null,
"refs": {
}
},
"DeleteFileSystemRequest": {
"base": "<p/>",
"refs": {
}
},
"DeleteMountTargetRequest": {
"base": "<p/>",
"refs": {
}
},
"DeleteTagsRequest": {
"base": "<p/>",
"refs": {
}
},
"DependencyTimeout": {
"base": "<p>The service timed out trying to fulfill the request, and the client should try the call again.</p>",
"refs": {
}
},
"DescribeAccessPointsRequest": {
"base": null,
"refs": {
}
},
"DescribeAccessPointsResponse": {
"base": null,
"refs": {
}
},
"DescribeAccountPreferencesRequest": {
"base": null,
"refs": {
}
},
"DescribeAccountPreferencesResponse": {
"base": null,
"refs": {
}
},
"DescribeBackupPolicyRequest": {
"base": null,
"refs": {
}
},
"DescribeFileSystemPolicyRequest": {
"base": null,
"refs": {
}
},
"DescribeFileSystemsRequest": {
"base": "<p/>",
"refs": {
}
},
"DescribeFileSystemsResponse": {
"base": null,
"refs": {
}
},
"DescribeLifecycleConfigurationRequest": {
"base": null,
"refs": {
}
},
"DescribeMountTargetSecurityGroupsRequest": {
"base": "<p/>",
"refs": {
}
},
"DescribeMountTargetSecurityGroupsResponse": {
"base": null,
"refs": {
}
},
"DescribeMountTargetsRequest": {
"base": "<p/>",
"refs": {
}
},
"DescribeMountTargetsResponse": {
"base": "<p/>",
"refs": {
}
},
"DescribeTagsRequest": {
"base": "<p/>",
"refs": {
}
},
"DescribeTagsResponse": {
"base": "<p/>",
"refs": {
}
},
"Encrypted": {
"base": null,
"refs": {
"CreateFileSystemRequest$Encrypted": "<p>A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying <a>CreateFileSystemRequest$KmsKeyId</a> for an existing Key Management Service (KMS customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, <code>/aws/elasticfilesystem</code>, is used to protect the encrypted file system. </p>",
"FileSystemDescription$Encrypted": "<p>A Boolean value that, if true, indicates that the file system is encrypted.</p>"
}
},
"ErrorCode": {
"base": null,
"refs": {
"AccessPointAlreadyExists$ErrorCode": null,
"AccessPointLimitExceeded$ErrorCode": null,
"AccessPointNotFound$ErrorCode": null,
"AvailabilityZonesMismatch$ErrorCode": null,
"BadRequest$ErrorCode": null,
"DependencyTimeout$ErrorCode": null,
"FileSystemAlreadyExists$ErrorCode": null,
"FileSystemInUse$ErrorCode": null,
"FileSystemLimitExceeded$ErrorCode": null,
"FileSystemNotFound$ErrorCode": null,
"IncorrectFileSystemLifeCycleState$ErrorCode": null,
"IncorrectMountTargetState$ErrorCode": null,
"InsufficientThroughputCapacity$ErrorCode": null,
"InternalServerError$ErrorCode": null,
"InvalidPolicyException$ErrorCode": null,
"IpAddressInUse$ErrorCode": null,
"MountTargetConflict$ErrorCode": null,
"MountTargetNotFound$ErrorCode": null,
"NetworkInterfaceLimitExceeded$ErrorCode": null,
"NoFreeAddressesInSubnet$ErrorCode": null,
"PolicyNotFound$ErrorCode": null,
"SecurityGroupLimitExceeded$ErrorCode": null,
"SecurityGroupNotFound$ErrorCode": null,
"SubnetNotFound$ErrorCode": null,
"ThroughputLimitExceeded$ErrorCode": null,
"TooManyRequests$ErrorCode": null,
"UnsupportedAvailabilityZone$ErrorCode": null,
"ValidationException$ErrorCode": null
}
},
"ErrorMessage": {
"base": null,
"refs": {
"AccessPointAlreadyExists$Message": null,
"AccessPointLimitExceeded$Message": null,
"AccessPointNotFound$Message": null,
"AvailabilityZonesMismatch$Message": null,
"BadRequest$Message": null,
"DependencyTimeout$Message": null,
"FileSystemAlreadyExists$Message": null,
"FileSystemInUse$Message": null,
"FileSystemLimitExceeded$Message": null,
"FileSystemNotFound$Message": null,
"IncorrectFileSystemLifeCycleState$Message": null,
"IncorrectMountTargetState$Message": null,
"InsufficientThroughputCapacity$Message": null,
"InternalServerError$Message": null,
"InvalidPolicyException$Message": null,
"IpAddressInUse$Message": null,
"MountTargetConflict$Message": null,
"MountTargetNotFound$Message": null,
"NetworkInterfaceLimitExceeded$Message": null,
"NoFreeAddressesInSubnet$Message": null,
"PolicyNotFound$Message": null,
"SecurityGroupLimitExceeded$Message": null,
"SecurityGroupNotFound$Message": null,
"SubnetNotFound$Message": null,
"ThroughputLimitExceeded$Message": null,
"TooManyRequests$Message": null,
"UnsupportedAvailabilityZone$Message": null,
"ValidationException$Message": null
}
},
"FileSystemAlreadyExists": {
"base": "<p>Returned if the file system you are trying to create already exists, with the creation token you provided.</p>",
"refs": {
}
},
"FileSystemArn": {
"base": null,
"refs": {
"FileSystemDescription$FileSystemArn": "<p>The Amazon Resource Name (ARN) for the EFS file system, in the format <code>arn:aws:elasticfilesystem:<i>region</i>:<i>account-id</i>:file-system/<i>file-system-id</i> </code>. Example with sample data: <code>arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567</code> </p>"
}
},
"FileSystemDescription": {
"base": "<p>A description of the file system.</p>",
"refs": {
"FileSystemDescriptions$member": null
}
},
"FileSystemDescriptions": {
"base": null,
"refs": {
"DescribeFileSystemsResponse$FileSystems": "<p>An array of file system descriptions.</p>"
}
},
"FileSystemId": {
"base": null,
"refs": {
"AccessPointDescription$FileSystemId": "<p>The ID of the EFS file system that the access point applies to.</p>",
"CreateAccessPointRequest$FileSystemId": "<p>The ID of the EFS file system that the access point provides access to.</p>",
"CreateMountTargetRequest$FileSystemId": "<p>The ID of the file system for which to create the mount target.</p>",
"CreateTagsRequest$FileSystemId": "<p>The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.</p>",
"DeleteFileSystemPolicyRequest$FileSystemId": "<p>Specifies the EFS file system for which to delete the <code>FileSystemPolicy</code>.</p>",
"DeleteFileSystemRequest$FileSystemId": "<p>The ID of the file system you want to delete.</p>",
"DeleteTagsRequest$FileSystemId": "<p>The ID of the file system whose tags you want to delete (String).</p>",
"DescribeAccessPointsRequest$FileSystemId": "<p>(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access points for that file system; mutually exclusive with <code>AccessPointId</code>.</p>",
"DescribeBackupPolicyRequest$FileSystemId": "<p>Specifies which EFS file system to retrieve the <code>BackupPolicy</code> for.</p>",
"DescribeFileSystemPolicyRequest$FileSystemId": "<p>Specifies which EFS file system to retrieve the <code>FileSystemPolicy</code> for.</p>",
"DescribeFileSystemsRequest$FileSystemId": "<p>(Optional) ID of the file system whose description you want to retrieve (String).</p>",
"DescribeLifecycleConfigurationRequest$FileSystemId": "<p>The ID of the file system whose <code>LifecycleConfiguration</code> object you want to retrieve (String).</p>",
"DescribeMountTargetsRequest$FileSystemId": "<p>(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an <code>AccessPointId</code> or <code>MountTargetId</code> is not included. Accepts either a file system ID or ARN as input.</p>",
"DescribeTagsRequest$FileSystemId": "<p>The ID of the file system whose tag set you want to retrieve.</p>",
"FileSystemAlreadyExists$FileSystemId": null,
"FileSystemDescription$FileSystemId": "<p>The ID of the file system, assigned by Amazon EFS.</p>",
"FileSystemPolicyDescription$FileSystemId": "<p>Specifies the EFS file system to which the <code>FileSystemPolicy</code> applies.</p>",
"MountTargetDescription$FileSystemId": "<p>The ID of the file system for which the mount target is intended.</p>",
"PutBackupPolicyRequest$FileSystemId": "<p>Specifies which EFS file system to update the backup policy for.</p>",
"PutFileSystemPolicyRequest$FileSystemId": "<p>The ID of the EFS file system that you want to create or update the <code>FileSystemPolicy</code> for.</p>",
"PutLifecycleConfigurationRequest$FileSystemId": "<p>The ID of the file system for which you are creating the <code>LifecycleConfiguration</code> object (String).</p>",
"UpdateFileSystemRequest$FileSystemId": "<p>The ID of the file system that you want to update.</p>"
}
},
"FileSystemInUse": {
"base": "<p>Returned if a file system has mount targets.</p>",
"refs": {
}
},
"FileSystemLimitExceeded": {
"base": "<p>Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.</p>",
"refs": {
}
},
"FileSystemNotFound": {
"base": "<p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the requester's Amazon Web Services account.</p>",
"refs": {
}
},
"FileSystemNullableSizeValue": {
"base": null,
"refs": {
"FileSystemSize$ValueInIA": "<p>The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.</p>",
"FileSystemSize$ValueInStandard": "<p>The latest known metered size (in bytes) of data stored in the Standard storage class.</p>"
}
},
"FileSystemPolicyDescription": {
"base": null,
"refs": {
}
},
"FileSystemSize": {
"base": "<p>The latest known metered size (in bytes) of data stored in the file system, in its <code>Value</code> field, and the time at which that size was determined in its <code>Timestamp</code> field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.</p>",
"refs": {
"FileSystemDescription$SizeInBytes": "<p>The latest known metered size (in bytes) of data stored in the file system, in its <code>Value</code> field, and the time at which that size was determined in its <code>Timestamp</code> field. The <code>Timestamp</code> value is the integer number of seconds since 1970-01-01T00:00:00Z. The <code>SizeInBytes</code> value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, <code>SizeInBytes</code> represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time. </p>"
}
},
"FileSystemSizeValue": {
"base": null,
"refs": {
"FileSystemSize$Value": "<p>The latest known metered size (in bytes) of data stored in the file system.</p>"
}
},
"Gid": {
"base": null,
"refs": {
"PosixUser$Gid": "<p>The POSIX group ID used for all file system operations using this access point.</p>",
"SecondaryGids$member": null
}
},
"IncorrectFileSystemLifeCycleState": {
"base": "<p>Returned if the file system's lifecycle state is not \"available\".</p>",
"refs": {
}
},
"IncorrectMountTargetState": {
"base": "<p>Returned if the mount target is not in the correct state for the operation.</p>",
"refs": {
}
},
"InsufficientThroughputCapacity": {
"base": "<p>Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from bursting to provisioned throughput mode. Try again later.</p>",
"refs": {
}
},
"InternalServerError": {
"base": "<p>Returned if an error occurred on the server side.</p>",
"refs": {
}
},
"InvalidPolicyException": {
"base": "<p>Returned if the <code>FileSystemPolicy</code> is is malformed or contains an error such as an invalid parameter value or a missing required parameter. Returned in the case of a policy lockout safety check error.</p>",
"refs": {
}
},
"IpAddress": {
"base": null,
"refs": {
"CreateMountTargetRequest$IpAddress": "<p>Valid IPv4 address within the address range of the specified subnet.</p>",
"MountTargetDescription$IpAddress": "<p>Address at which the file system can be mounted by using the mount target.</p>"
}
},
"IpAddressInUse": {
"base": "<p>Returned if the request specified an <code>IpAddress</code> that is already in use in the subnet.</p>",
"refs": {
}
},
"KmsKeyId": {
"base": null,
"refs": {
"CreateFileSystemRequest$KmsKeyId": "<p>The ID of the KMS CMK that you want to use to protect the encrypted file system. This parameter is only required if you want to use a non-default KMS key. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:</p> <ul> <li> <p>Key ID - A unique identifier of the key, for example <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>ARN - An Amazon Resource Name (ARN) for the key, for example <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>Key alias - A previously created display name for a key, for example <code>alias/projectKey1</code>.</p> </li> <li> <p>Key alias ARN - An ARN for a key alias, for example <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>.</p> </li> </ul> <p>If <code>KmsKeyId</code> is specified, the <a>CreateFileSystemRequest$Encrypted</a> parameter must be set to true.</p> <important> <p>EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with EFS file systems.</p> </important>",
"FileSystemDescription$KmsKeyId": "<p>The ID of an Key Management Service customer master key (CMK) that was used to protect the encrypted file system.</p>"
}
},
"LifeCycleState": {
"base": null,
"refs": {
"AccessPointDescription$LifeCycleState": "<p>Identifies the lifecycle phase of the access point.</p>",
"FileSystemDescription$LifeCycleState": "<p>The lifecycle phase of the file system.</p>",
"MountTargetDescription$LifeCycleState": "<p>Lifecycle state of the mount target.</p>"
}
},
"LifecycleConfigurationDescription": {
"base": null,
"refs": {
}
},
"LifecyclePolicies": {
"base": null,
"refs": {
"LifecycleConfigurationDescription$LifecyclePolicies": "<p>An array of lifecycle management policies. EFS supports a maximum of one policy per file system.</p>",
"PutLifecycleConfigurationRequest$LifecyclePolicies": "<p>An array of <code>LifecyclePolicy</code> objects that define the file system's <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object informs EFS lifecycle management and intelligent tiering of the following:</p> <ul> <li> <p>When to move files in the file system from primary storage to the IA storage class.</p> </li> <li> <p>When to move files that are in IA storage to primary storage.</p> </li> </ul> <note> <p>When using the <code>put-lifecycle-configuration</code> CLI command or the <code>PutLifecycleConfiguration</code> API action, Amazon EFS requires that each <code>LifecyclePolicy</code> object have only a single transition. This means that in a request body, <code>LifecyclePolicies</code> needs to be structured as an array of <code>LifecyclePolicy</code> objects, one object for each transition, <code>TransitionToIA</code>, <code>TransitionToPrimaryStorageClass</code>. See the example requests in the following section for more information.</p> </note>"
}
},
"LifecyclePolicy": {
"base": "<p>Describes a policy used by EFS lifecycle management and EFS intelligent tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html\">EFS Intelligent‐Tiering and EFS Lifecycle Management</a>.</p> <note> <p>When using the <code>put-lifecycle-configuration</code> CLI command or the <code>PutLifecycleConfiguration</code> API action, Amazon EFS requires that each <code>LifecyclePolicy</code> object have only a single transition. This means that in a request body, <code>LifecyclePolicies</code> needs to be structured as an array of <code>LifecyclePolicy</code> objects, one object for each transition, <code>TransitionToIA</code>, <code>TransitionToPrimaryStorageClass</code>. For more information, see the request examples in <a>PutLifecycleConfiguration</a>.</p> </note>",
"refs": {
"LifecyclePolicies$member": null
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"Marker": {
"base": null,
"refs": {
"DescribeFileSystemsRequest$Marker": "<p>(Optional) Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation (String). If present, specifies to continue the list from where the returning call had left off. </p>",
"DescribeFileSystemsResponse$Marker": "<p>Present if provided by caller in the request (String).</p>",
"DescribeFileSystemsResponse$NextMarker": "<p>Present if there are more file systems than returned in the response (String). You can use the <code>NextMarker</code> in the subsequent request to fetch the descriptions.</p>",
"DescribeMountTargetsRequest$Marker": "<p>(Optional) Opaque pagination token returned from a previous <code>DescribeMountTargets</code> operation (String). If present, it specifies to continue the list from where the previous returning call left off.</p>",
"DescribeMountTargetsResponse$Marker": "<p>If the request included the <code>Marker</code>, the response returns that value in this field.</p>",
"DescribeMountTargetsResponse$NextMarker": "<p>If a value is present, there are more mount targets to return. In a subsequent request, you can provide <code>Marker</code> in your request with this value to retrieve the next set of mount targets.</p>",
"DescribeTagsRequest$Marker": "<p>(Optional) An opaque pagination token returned from a previous <code>DescribeTags</code> operation (String). If present, it specifies to continue the list from where the previous call left off.</p>",
"DescribeTagsResponse$Marker": "<p>If the request included a <code>Marker</code>, the response returns that value in this field.</p>",
"DescribeTagsResponse$NextMarker": "<p>If a value is present, there are more tags to return. In a subsequent request, you can provide the value of <code>NextMarker</code> as the value of the <code>Marker</code> parameter in your next request to retrieve the next set of tags.</p>"
}
},
"MaxItems": {
"base": null,
"refs": {
"DescribeFileSystemsRequest$MaxItems": "<p>(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems. </p>",
"DescribeMountTargetsRequest$MaxItems": "<p>(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.</p>",
"DescribeTagsRequest$MaxItems": "<p>(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.</p>"
}
},
"MaxResults": {
"base": "Max results used for pagination.",
"refs": {
"DescribeAccessPointsRequest$MaxResults": "<p>(Optional) When retrieving all access points for a file system, you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response. The default value is 100. </p>",
"DescribeAccountPreferencesRequest$MaxResults": "<p>(Optional) When retrieving account preferences, you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response. The default value is 100. </p>",
"ListTagsForResourceRequest$MaxResults": "<p>(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.</p>"
}
},
"ModifyMountTargetSecurityGroupsRequest": {
"base": "<p/>",
"refs": {
}
},
"MountTargetConflict": {
"base": "<p>Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.</p>",
"refs": {
}
},
"MountTargetCount": {
"base": null,
"refs": {
"FileSystemDescription$NumberOfMountTargets": "<p>The current number of mount targets that the file system has. For more information, see <a>CreateMountTarget</a>.</p>"
}
},
"MountTargetDescription": {
"base": "<p>Provides a description of a mount target.</p>",
"refs": {
"MountTargetDescriptions$member": null
}
},
"MountTargetDescriptions": {
"base": null,
"refs": {
"DescribeMountTargetsResponse$MountTargets": "<p>Returns the file system's mount targets as an array of <code>MountTargetDescription</code> objects.</p>"
}
},
"MountTargetId": {
"base": null,
"refs": {
"DeleteMountTargetRequest$MountTargetId": "<p>The ID of the mount target to delete (String).</p>",
"DescribeMountTargetSecurityGroupsRequest$MountTargetId": "<p>The ID of the mount target whose security groups you want to retrieve.</p>",
"DescribeMountTargetsRequest$MountTargetId": "<p>(Optional) ID of the mount target that you want to have described (String). It must be included in your request if <code>FileSystemId</code> is not included. Accepts either a mount target ID or ARN as input.</p>",
"ModifyMountTargetSecurityGroupsRequest$MountTargetId": "<p>The ID of the mount target whose security groups you want to modify.</p>",
"MountTargetDescription$MountTargetId": "<p>System-assigned mount target ID.</p>"
}
},
"MountTargetNotFound": {
"base": "<p>Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.</p>",
"refs": {
}
},
"Name": {
"base": null,
"refs": {
"AccessPointDescription$Name": "<p>The name of the access point. This is the value of the <code>Name</code> tag.</p>"
}
},
"NetworkInterfaceId": {
"base": null,
"refs": {
"MountTargetDescription$NetworkInterfaceId": "<p>The ID of the network interface that Amazon EFS created when it created the mount target.</p>"
}
},
"NetworkInterfaceLimitExceeded": {
"base": "<p>The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. The client should try to delete some elastic network interfaces or get the account limit raised. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html\">Amazon VPC Limits</a> in the <i>Amazon VPC User Guide </i> (see the Network interfaces per VPC entry in the table). </p>",
"refs": {
}
},
"NoFreeAddressesInSubnet": {
"base": "<p>Returned if <code>IpAddress</code> was not specified in the request and there are no free IP addresses in the subnet.</p>",
"refs": {
}
},
"OwnerGid": {
"base": null,
"refs": {
"CreationInfo$OwnerGid": "<p>Specifies the POSIX group ID to apply to the <code>RootDirectory</code>. Accepts values from 0 to 2^32 (4294967295).</p>"
}
},
"OwnerUid": {
"base": null,
"refs": {
"CreationInfo$OwnerUid": "<p>Specifies the POSIX user ID to apply to the <code>RootDirectory</code>. Accepts values from 0 to 2^32 (4294967295).</p>"
}
},
"Path": {
"base": null,
"refs": {
"RootDirectory$Path": "<p>Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the <code>CreationInfo</code>.</p>"
}
},
"PerformanceMode": {
"base": null,
"refs": {
"CreateFileSystemRequest$PerformanceMode": "<p>The performance mode of the file system. We recommend <code>generalPurpose</code> performance mode for most file systems. File systems using the <code>maxIO</code> performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.</p> <note> <p>The <code>maxIO</code> mode is not supported on file systems using One Zone storage classes.</p> </note>",
"FileSystemDescription$PerformanceMode": "<p>The performance mode of the file system.</p>"
}
},
"Permissions": {
"base": null,
"refs": {
"CreationInfo$Permissions": "<p>Specifies the POSIX permissions to apply to the <code>RootDirectory</code>, in the format of an octal number representing the file's mode bits.</p>"
}
},
"Policy": {
"base": null,
"refs": {
"FileSystemPolicyDescription$Policy": "<p>The JSON formatted <code>FileSystemPolicy</code> for the EFS file system.</p>",
"PutFileSystemPolicyRequest$Policy": "<p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies\">EFS Resource-based Policies</a>. </p>"
}
},
"PolicyNotFound": {
"base": "<p>Returned if the default file system policy is in effect for the EFS file system specified.</p>",
"refs": {
}
},
"PosixUser": {
"base": "<p>The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.</p>",
"refs": {
"AccessPointDescription$PosixUser": "<p>The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.</p>",
"CreateAccessPointRequest$PosixUser": "<p>The operating system user and group applied to all file system requests made using the access point.</p>"
}
},
"ProvisionedThroughputInMibps": {
"base": null,
"refs": {
"CreateFileSystemRequest$ProvisionedThroughputInMibps": "<p>The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if <code>ThroughputMode</code> is set to <code>provisioned</code>. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits\">Amazon EFS quotas that you can increase</a> in the <i>Amazon EFS User Guide</i>.</p>",
"FileSystemDescription$ProvisionedThroughputInMibps": "<p>The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using <code>ThroughputMode</code> set to <code>provisioned</code>.</p>",
"UpdateFileSystemRequest$ProvisionedThroughputInMibps": "<p>(Optional) Sets the amount of provisioned throughput, in MiB/s, for the file system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also provide the amount of provisioned throughput. Required if <code>ThroughputMode</code> is changed to <code>provisioned</code> on update.</p>"
}
},
"PutAccountPreferencesRequest": {
"base": null,
"refs": {
}
},
"PutAccountPreferencesResponse": {
"base": null,
"refs": {
}
},
"PutBackupPolicyRequest": {
"base": null,
"refs": {
}
},
"PutFileSystemPolicyRequest": {
"base": null,
"refs": {
}
},
"PutLifecycleConfigurationRequest": {
"base": null,
"refs": {
}
},
"Resource": {
"base": "An EFS resource, for example a file system or a mount target.",
"refs": {
"Resources$member": null
}
},
"ResourceId": {
"base": null,
"refs": {
"ListTagsForResourceRequest$ResourceId": "<p>Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.</p>",
"TagResourceRequest$ResourceId": "<p>The ID specifying the EFS resource that you want to create a tag for.</p>",
"UntagResourceRequest$ResourceId": "<p>Specifies the EFS resource that you want to remove tags from.</p>"
}
},
"ResourceIdPreference": {
"base": "<p>Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.</p>",
"refs": {
"DescribeAccountPreferencesResponse$ResourceIdPreference": "<p>Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.</p>",
"PutAccountPreferencesResponse$ResourceIdPreference": null
}
},
"ResourceIdType": {
"base": "A preference indicating a choice to use 63bit/32bit IDs for all applicable resources.",
"refs": {
"PutAccountPreferencesRequest$ResourceIdType": "<p>Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either <code>LONG_ID</code> (17 characters), or <code>SHORT_ID</code> (8 characters).</p> <note> <p>Starting in October, 2021, you will receive an error when setting the account preference to <code>SHORT_ID</code>. Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.</p> </note>",
"ResourceIdPreference$ResourceIdType": "<p>Identifies the EFS resource ID preference, either <code>LONG_ID</code> (17 characters) or <code>SHORT_ID</code> (8 characters).</p>"
}
},
"Resources": {
"base": "EFS resources to which a preference applies to.",
"refs": {
"ResourceIdPreference$Resources": "<p>Identifies the Amazon EFS resources to which the ID preference setting applies, <code>FILE_SYSTEM</code> and <code>MOUNT_TARGET</code>.</p>"
}
},
"RootDirectory": {
"base": "<p>Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's <code>RootDirectory</code> and it's subdirectories.</p>",
"refs": {
"AccessPointDescription$RootDirectory": "<p>The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.</p>",
"CreateAccessPointRequest$RootDirectory": "<p>Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the <code>RootDirectory</code> > <code>Path</code> specified does not exist, EFS creates it and applies the <code>CreationInfo</code> settings when a client connects to an access point. When specifying a <code>RootDirectory</code>, you need to provide the <code>Path</code>, and the <code>CreationInfo</code>.</p> <p>Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.</p>"
}
},
"SecondaryGids": {
"base": null,
"refs": {
"PosixUser$SecondaryGids": "<p>Secondary POSIX group IDs used for all file system operations using this access point.</p>"
}
},
"SecurityGroup": {
"base": null,
"refs": {
"SecurityGroups$member": null
}
},
"SecurityGroupLimitExceeded": {
"base": "<p>Returned if the size of <code>SecurityGroups</code> specified in the request is greater than five.</p>",
"refs": {
}
},
"SecurityGroupNotFound": {
"base": "<p>Returned if one of the specified security groups doesn't exist in the subnet's VPC.</p>",
"refs": {
}
},
"SecurityGroups": {
"base": null,
"refs": {
"CreateMountTargetRequest$SecurityGroups": "<p>Up to five VPC security group IDs, of the form <code>sg-xxxxxxxx</code>. These must be for the same VPC as subnet specified.</p>",
"DescribeMountTargetSecurityGroupsResponse$SecurityGroups": "<p>An array of security groups.</p>",
"ModifyMountTargetSecurityGroupsRequest$SecurityGroups": "<p>An array of up to five VPC security group IDs.</p>"
}
},
"Status": {
"base": null,
"refs": {
"BackupPolicy$Status": "<p>Describes the status of the file system's backup policy.</p> <ul> <li> <p> <b> <code>ENABLED</code> </b> - EFS is automatically backing up the file system.</p> </li> <li> <p> <b> <code>ENABLING</code> </b> - EFS is turning on automatic backups for the file system.</p> </li> <li> <p> <b> <code>DISABLED</code> </b> - automatic back ups are turned off for the file system.</p> </li> <li> <p> <b> <code>DISABLING</code> </b> - EFS is turning off automatic backups for the file system.</p> </li> </ul>"
}
},
"SubnetId": {
"base": null,
"refs": {
"CreateMountTargetRequest$SubnetId": "<p>The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.</p>",
"MountTargetDescription$SubnetId": "<p>The ID of the mount target's subnet.</p>"
}
},
"SubnetNotFound": {
"base": "<p>Returned if there is no subnet with ID <code>SubnetId</code> provided in the request.</p>",
"refs": {
}
},
"Tag": {
"base": "<p>A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:<code> + - = . _ : /</code>.</p>",
"refs": {
"Tags$member": null
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$Key": "<p>The tag key (String). The key can't start with <code>aws:</code>.</p>",
"TagKeys$member": null
}
},
"TagKeys": {
"base": null,
"refs": {
"DeleteTagsRequest$TagKeys": "<p>A list of tag keys to delete.</p>",
"UntagResourceRequest$TagKeys": "<p>The keys of the key-value tag pairs that you want to remove from the specified EFS resource.</p>"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"FileSystemDescription$Name": "<p>You can add tags to a file system, including a <code>Name</code> tag. For more information, see <a>CreateFileSystem</a>. If the file system has a <code>Name</code> tag, Amazon EFS returns the value in this field. </p>",
"Tag$Value": "<p>The value of the tag key.</p>"
}
},
"Tags": {
"base": null,
"refs": {
"AccessPointDescription$Tags": "<p>The tags associated with the access point, presented as an array of Tag objects.</p>",
"CreateAccessPointRequest$Tags": "<p>Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>",
"CreateFileSystemRequest$Tags": "<p>Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a <code>\"Key\":\"Name\",\"Value\":\"{value}\"</code> key-value pair. Each key must be unique. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>",
"CreateTagsRequest$Tags": "<p>An array of <code>Tag</code> objects to add. Each <code>Tag</code> object is a key-value pair. </p>",
"DescribeTagsResponse$Tags": "<p>Returns tags associated with the file system as an array of <code>Tag</code> objects. </p>",
"FileSystemDescription$Tags": "<p>The tags associated with the file system, presented as an array of <code>Tag</code> objects.</p>",
"ListTagsForResourceResponse$Tags": "<p>An array of the tags for the specified EFS resource.</p>",
"TagResourceRequest$Tags": "<p>An array of <code>Tag</code> objects to add. Each <code>Tag</code> object is a key-value pair.</p>"
}
},
"ThroughputLimitExceeded": {
"base": "<p>Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.</p>",
"refs": {
}
},
"ThroughputMode": {
"base": null,
"refs": {
"CreateFileSystemRequest$ThroughputMode": "<p>Specifies the throughput mode for the file system, either <code>bursting</code> or <code>provisioned</code>. If you set <code>ThroughputMode</code> to <code>provisioned</code>, you must also set a value for <code>ProvisionedThroughputInMibps</code>. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput\">Specifying throughput with provisioned mode</a> in the <i>Amazon EFS User Guide</i>. </p> <p>Default is <code>bursting</code>.</p>",
"FileSystemDescription$ThroughputMode": "<p>Displays the file system's throughput mode. For more information, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes\">Throughput modes</a> in the <i>Amazon EFS User Guide</i>. </p>",
"UpdateFileSystemRequest$ThroughputMode": "<p>(Optional) Updates the file system's throughput mode. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the <code>ThroughputMode</code> to <code>provisioned</code>, you must also set a value for <code>ProvisionedThroughputInMibps</code>.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"FileSystemDescription$CreationTime": "<p>The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).</p>",
"FileSystemSize$Timestamp": "<p>The time at which the size of data, returned in the <code>Value</code> field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.</p>"
}
},
"Token": {
"base": "Token used for pagination.",
"refs": {
"DescribeAccessPointsRequest$NextToken": "<p> <code>NextToken</code> is present if the response is paginated. You can use <code>NextMarker</code> in the subsequent request to fetch the next page of access point descriptions.</p>",
"DescribeAccessPointsResponse$NextToken": "<p>Present if there are more access points than returned in the response. You can use the NextMarker in the subsequent request to fetch the additional descriptions.</p>",
"DescribeAccountPreferencesRequest$NextToken": "<p>(Optional) You can use <code>NextToken</code> in a subsequent request to fetch the next page of Amazon Web Services account preferences if the response payload was paginated.</p>",
"DescribeAccountPreferencesResponse$NextToken": "<p>Present if there are more records than returned in the response. You can use the <code>NextToken</code> in the subsequent request to fetch the additional descriptions.</p>",
"ListTagsForResourceRequest$NextToken": "<p>(Optional) You can use <code>NextToken</code> in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.</p>",
"ListTagsForResourceResponse$NextToken": "<p> <code>NextToken</code> is present if the response payload is paginated. You can use <code>NextToken</code> in a subsequent request to fetch the next page of access point descriptions.</p>"
}
},
"TooManyRequests": {
"base": "<p>Returned if you don’t wait at least 24 hours before changing the throughput mode, or decreasing the Provisioned Throughput value.</p>",
"refs": {
}
},
"TransitionToIARules": {
"base": null,
"refs": {
"LifecyclePolicy$TransitionToIA": "<p> Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.</p>"
}
},
"TransitionToPrimaryStorageClassRules": {
"base": null,
"refs": {
"LifecyclePolicy$TransitionToPrimaryStorageClass": "<p>Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.</p>"
}
},
"Uid": {
"base": null,
"refs": {
"PosixUser$Uid": "<p>The POSIX user ID used for all file system operations using this access point.</p>"
}
},
"UnsupportedAvailabilityZone": {
"base": "<p>Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.</p>",
"refs": {
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UpdateFileSystemRequest": {
"base": null,
"refs": {
}
},
"ValidationException": {
"base": "<p>Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.</p>",
"refs": {
}
},
"VpcId": {
"base": null,
"refs": {
"MountTargetDescription$VpcId": "<p>The virtual private cloud (VPC) ID that the mount target is configured in.</p>"
}
}
}
}