@aws-sdk/client-efs 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist-types/EFS.d.ts +31 -0
  2. package/dist-types/EFSClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAccessPointCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateFileSystemCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateMountTargetCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateReplicationConfigurationCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateTagsCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteAccessPointCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteFileSystemCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteFileSystemPolicyCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteMountTargetCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteReplicationConfigurationCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteTagsCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeAccessPointsCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeAccountPreferencesCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeBackupPolicyCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeFileSystemPolicyCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeFileSystemsCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeLifecycleConfigurationCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeMountTargetSecurityGroupsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeMountTargetsCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeReplicationConfigurationsCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeTagsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/ModifyMountTargetSecurityGroupsCommand.d.ts +16 -0
  26. package/dist-types/commands/PutAccountPreferencesCommand.d.ts +16 -0
  27. package/dist-types/commands/PutBackupPolicyCommand.d.ts +16 -0
  28. package/dist-types/commands/PutFileSystemPolicyCommand.d.ts +16 -0
  29. package/dist-types/commands/PutLifecycleConfigurationCommand.d.ts +16 -0
  30. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateFileSystemCommand.d.ts +16 -0
  33. package/dist-types/models/EFSServiceException.d.ts +2 -0
  34. package/dist-types/models/models_0.d.ts +176 -1
  35. package/dist-types/pagination/DescribeAccessPointsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/DescribeFileSystemsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/DescribeTagsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/Interfaces.d.ts +3 -0
  39. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  40. package/package.json +3 -3
@@ -31,6 +31,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
31
31
  import { UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput } from "./commands/UpdateFileSystemCommand";
32
32
  import { EFSClient } from "./EFSClient";
33
33
  /**
34
+ * @public
34
35
  * <fullname>Amazon Elastic File System</fullname>
35
36
  * <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
36
37
  * use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and
@@ -39,6 +40,7 @@ import { EFSClient } from "./EFSClient";
39
40
  */
40
41
  export declare class EFS extends EFSClient {
41
42
  /**
43
+ * @public
42
44
  * <p>Creates an EFS access point. An access point is an application-specific view into an EFS
43
45
  * file system that applies an operating system user and group, and a file system path, to any
44
46
  * file system request made through the access point. The operating system user and group
@@ -58,6 +60,7 @@ export declare class EFS extends EFSClient {
58
60
  createAccessPoint(args: CreateAccessPointCommandInput, cb: (err: any, data?: CreateAccessPointCommandOutput) => void): void;
59
61
  createAccessPoint(args: CreateAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPointCommandOutput) => void): void;
60
62
  /**
63
+ * @public
61
64
  * <p>Creates a new, empty file system. The operation requires a creation token in the
62
65
  * request that Amazon EFS uses to ensure idempotent creation (calling the operation with same
63
66
  * creation token has no effect). If a file system does not currently exist that is owned by the
@@ -112,6 +115,7 @@ export declare class EFS extends EFSClient {
112
115
  createFileSystem(args: CreateFileSystemCommandInput, cb: (err: any, data?: CreateFileSystemCommandOutput) => void): void;
113
116
  createFileSystem(args: CreateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFileSystemCommandOutput) => void): void;
114
117
  /**
118
+ * @public
115
119
  * <p>Creates a mount target for a file system. You can then mount the file system on EC2
116
120
  * instances by using the mount target.</p>
117
121
  * <p>You can create one mount target in each Availability Zone in your VPC. All EC2
@@ -257,6 +261,7 @@ export declare class EFS extends EFSClient {
257
261
  createMountTarget(args: CreateMountTargetCommandInput, cb: (err: any, data?: CreateMountTargetCommandOutput) => void): void;
258
262
  createMountTarget(args: CreateMountTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMountTargetCommandOutput) => void): void;
259
263
  /**
264
+ * @public
260
265
  * <p>Creates a replication configuration that replicates an existing EFS file system to a new,
261
266
  * read-only file system. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the
262
267
  * <i>Amazon EFS User Guide</i>. The replication configuration
@@ -344,6 +349,7 @@ export declare class EFS extends EFSClient {
344
349
  createReplicationConfiguration(args: CreateReplicationConfigurationCommandInput, cb: (err: any, data?: CreateReplicationConfigurationCommandOutput) => void): void;
345
350
  createReplicationConfiguration(args: CreateReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationConfigurationCommandOutput) => void): void;
346
351
  /**
352
+ * @public
347
353
  * @deprecated
348
354
  *
349
355
  * <note>
@@ -361,6 +367,7 @@ export declare class EFS extends EFSClient {
361
367
  createTags(args: CreateTagsCommandInput, cb: (err: any, data?: CreateTagsCommandOutput) => void): void;
362
368
  createTags(args: CreateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTagsCommandOutput) => void): void;
363
369
  /**
370
+ * @public
364
371
  * <p>Deletes the specified access point. After deletion is complete, new clients can no
365
372
  * longer connect to the access points. Clients connected to the access point at the time of
366
373
  * deletion will continue to function until they terminate their connection.</p>
@@ -370,6 +377,7 @@ export declare class EFS extends EFSClient {
370
377
  deleteAccessPoint(args: DeleteAccessPointCommandInput, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void): void;
371
378
  deleteAccessPoint(args: DeleteAccessPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPointCommandOutput) => void): void;
372
379
  /**
380
+ * @public
373
381
  * <p>Deletes a file system, permanently severing access to its contents. Upon return, the
374
382
  * file system no longer exists and you can't access any contents of the deleted file
375
383
  * system.</p>
@@ -395,6 +403,7 @@ export declare class EFS extends EFSClient {
395
403
  deleteFileSystem(args: DeleteFileSystemCommandInput, cb: (err: any, data?: DeleteFileSystemCommandOutput) => void): void;
396
404
  deleteFileSystem(args: DeleteFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileSystemCommandOutput) => void): void;
397
405
  /**
406
+ * @public
398
407
  * <p>Deletes the <code>FileSystemPolicy</code> for the specified file system.
399
408
  * The default <code>FileSystemPolicy</code> goes into effect once the existing policy is deleted.
400
409
  * 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>
@@ -404,6 +413,7 @@ export declare class EFS extends EFSClient {
404
413
  deleteFileSystemPolicy(args: DeleteFileSystemPolicyCommandInput, cb: (err: any, data?: DeleteFileSystemPolicyCommandOutput) => void): void;
405
414
  deleteFileSystemPolicy(args: DeleteFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileSystemPolicyCommandOutput) => void): void;
406
415
  /**
416
+ * @public
407
417
  * <p>Deletes the specified mount target.</p>
408
418
  * <p>This operation forcibly breaks any mounts of the file system by using the mount target
409
419
  * that is being deleted, which might disrupt instances or applications using those mounts. To
@@ -440,6 +450,7 @@ export declare class EFS extends EFSClient {
440
450
  deleteMountTarget(args: DeleteMountTargetCommandInput, cb: (err: any, data?: DeleteMountTargetCommandOutput) => void): void;
441
451
  deleteMountTarget(args: DeleteMountTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMountTargetCommandOutput) => void): void;
442
452
  /**
453
+ * @public
443
454
  * <p>Deletes an existing replication configuration. To delete a replication configuration, you
444
455
  * must make the request from the Amazon Web Services Region in which the destination file system
445
456
  * is located. Deleting a replication configuration ends the replication process. After a
@@ -451,6 +462,7 @@ export declare class EFS extends EFSClient {
451
462
  deleteReplicationConfiguration(args: DeleteReplicationConfigurationCommandInput, cb: (err: any, data?: DeleteReplicationConfigurationCommandOutput) => void): void;
452
463
  deleteReplicationConfiguration(args: DeleteReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationConfigurationCommandOutput) => void): void;
453
464
  /**
465
+ * @public
454
466
  * @deprecated
455
467
  *
456
468
  * <note>
@@ -468,6 +480,7 @@ export declare class EFS extends EFSClient {
468
480
  deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
469
481
  deleteTags(args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
470
482
  /**
483
+ * @public
471
484
  * <p>Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided.
472
485
  * If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system.
473
486
  * You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. </p>
@@ -477,6 +490,7 @@ export declare class EFS extends EFSClient {
477
490
  describeAccessPoints(args: DescribeAccessPointsCommandInput, cb: (err: any, data?: DescribeAccessPointsCommandOutput) => void): void;
478
491
  describeAccessPoints(args: DescribeAccessPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessPointsCommandOutput) => void): void;
479
492
  /**
493
+ * @public
480
494
  * <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.
481
495
  * For more information, see <a href="efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>.</p>
482
496
  */
@@ -484,12 +498,14 @@ export declare class EFS extends EFSClient {
484
498
  describeAccountPreferences(args: DescribeAccountPreferencesCommandInput, cb: (err: any, data?: DescribeAccountPreferencesCommandOutput) => void): void;
485
499
  describeAccountPreferences(args: DescribeAccountPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountPreferencesCommandOutput) => void): void;
486
500
  /**
501
+ * @public
487
502
  * <p>Returns the backup policy for the specified EFS file system.</p>
488
503
  */
489
504
  describeBackupPolicy(args: DescribeBackupPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBackupPolicyCommandOutput>;
490
505
  describeBackupPolicy(args: DescribeBackupPolicyCommandInput, cb: (err: any, data?: DescribeBackupPolicyCommandOutput) => void): void;
491
506
  describeBackupPolicy(args: DescribeBackupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupPolicyCommandOutput) => void): void;
492
507
  /**
508
+ * @public
493
509
  * <p>Returns the <code>FileSystemPolicy</code> for the specified EFS file system.</p>
494
510
  * <p>This operation requires permissions for the <code>elasticfilesystem:DescribeFileSystemPolicy</code> action.</p>
495
511
  */
@@ -497,6 +513,7 @@ export declare class EFS extends EFSClient {
497
513
  describeFileSystemPolicy(args: DescribeFileSystemPolicyCommandInput, cb: (err: any, data?: DescribeFileSystemPolicyCommandOutput) => void): void;
498
514
  describeFileSystemPolicy(args: DescribeFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemPolicyCommandOutput) => void): void;
499
515
  /**
516
+ * @public
500
517
  * <p>Returns the description of a specific Amazon EFS file system if either the file system
501
518
  * <code>CreationToken</code> or the <code>FileSystemId</code> is provided. Otherwise, it
502
519
  * returns descriptions of all file systems owned by the caller's Amazon Web Services account in the
@@ -522,6 +539,7 @@ export declare class EFS extends EFSClient {
522
539
  describeFileSystems(args: DescribeFileSystemsCommandInput, cb: (err: any, data?: DescribeFileSystemsCommandOutput) => void): void;
523
540
  describeFileSystems(args: DescribeFileSystemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemsCommandOutput) => void): void;
524
541
  /**
542
+ * @public
525
543
  * <p>Returns the current <code>LifecycleConfiguration</code> object for the specified Amazon
526
544
  * EFS file system. EFS lifecycle management uses the <code>LifecycleConfiguration</code> object
527
545
  * to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system
@@ -536,6 +554,7 @@ export declare class EFS extends EFSClient {
536
554
  describeLifecycleConfiguration(args: DescribeLifecycleConfigurationCommandInput, cb: (err: any, data?: DescribeLifecycleConfigurationCommandOutput) => void): void;
537
555
  describeLifecycleConfiguration(args: DescribeLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLifecycleConfigurationCommandOutput) => void): void;
538
556
  /**
557
+ * @public
539
558
  * <p>Returns the descriptions of all the current mount targets, or a specific mount target,
540
559
  * for a file system. When requesting all of the current mount targets, the order of mount
541
560
  * targets returned in the response is unspecified.</p>
@@ -548,6 +567,7 @@ export declare class EFS extends EFSClient {
548
567
  describeMountTargets(args: DescribeMountTargetsCommandInput, cb: (err: any, data?: DescribeMountTargetsCommandOutput) => void): void;
549
568
  describeMountTargets(args: DescribeMountTargetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMountTargetsCommandOutput) => void): void;
550
569
  /**
570
+ * @public
551
571
  * <p>Returns the security groups currently in effect for a mount target. This operation
552
572
  * requires that the network interface of the mount target has been created and the lifecycle
553
573
  * state of the mount target is not <code>deleted</code>.</p>
@@ -569,6 +589,7 @@ export declare class EFS extends EFSClient {
569
589
  describeMountTargetSecurityGroups(args: DescribeMountTargetSecurityGroupsCommandInput, cb: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void): void;
570
590
  describeMountTargetSecurityGroups(args: DescribeMountTargetSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void): void;
571
591
  /**
592
+ * @public
572
593
  * <p>Retrieves the replication configuration for a specific file system. If a file system is
573
594
  * not specified, all of the replication configurations for the Amazon Web Services account in an
574
595
  * Amazon Web Services Region are retrieved.</p>
@@ -577,6 +598,7 @@ export declare class EFS extends EFSClient {
577
598
  describeReplicationConfigurations(args: DescribeReplicationConfigurationsCommandInput, cb: (err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void): void;
578
599
  describeReplicationConfigurations(args: DescribeReplicationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void): void;
579
600
  /**
601
+ * @public
580
602
  * @deprecated
581
603
  *
582
604
  * <note>
@@ -594,6 +616,7 @@ export declare class EFS extends EFSClient {
594
616
  describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
595
617
  describeTags(args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
596
618
  /**
619
+ * @public
597
620
  * <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>
598
621
  * <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>
599
622
  */
@@ -601,6 +624,7 @@ export declare class EFS extends EFSClient {
601
624
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
602
625
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
603
626
  /**
627
+ * @public
604
628
  * <p>Modifies the set of security groups in effect for a mount target.</p>
605
629
  * <p>When you create a mount target, Amazon EFS also creates a new network interface. For
606
630
  * more information, see <a>CreateMountTarget</a>. This operation replaces the security groups in effect for the
@@ -626,6 +650,7 @@ export declare class EFS extends EFSClient {
626
650
  modifyMountTargetSecurityGroups(args: ModifyMountTargetSecurityGroupsCommandInput, cb: (err: any, data?: ModifyMountTargetSecurityGroupsCommandOutput) => void): void;
627
651
  modifyMountTargetSecurityGroups(args: ModifyMountTargetSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyMountTargetSecurityGroupsCommandOutput) => void): void;
628
652
  /**
653
+ * @public
629
654
  * <p>Use this operation to set the account preference in the current Amazon Web Services Region
630
655
  * to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for
631
656
  * new EFS file system and mount target resources. All existing resource IDs are not affected
@@ -642,12 +667,14 @@ export declare class EFS extends EFSClient {
642
667
  putAccountPreferences(args: PutAccountPreferencesCommandInput, cb: (err: any, data?: PutAccountPreferencesCommandOutput) => void): void;
643
668
  putAccountPreferences(args: PutAccountPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAccountPreferencesCommandOutput) => void): void;
644
669
  /**
670
+ * @public
645
671
  * <p>Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. </p>
646
672
  */
647
673
  putBackupPolicy(args: PutBackupPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutBackupPolicyCommandOutput>;
648
674
  putBackupPolicy(args: PutBackupPolicyCommandInput, cb: (err: any, data?: PutBackupPolicyCommandOutput) => void): void;
649
675
  putBackupPolicy(args: PutBackupPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBackupPolicyCommandOutput) => void): void;
650
676
  /**
677
+ * @public
651
678
  * <p>Applies an Amazon EFS <code>FileSystemPolicy</code> to an Amazon EFS file system.
652
679
  * A file system policy is an IAM resource-based policy and can contain multiple policy statements.
653
680
  * A file system always has exactly one file system policy, which can be the default policy or
@@ -665,6 +692,7 @@ export declare class EFS extends EFSClient {
665
692
  putFileSystemPolicy(args: PutFileSystemPolicyCommandInput, cb: (err: any, data?: PutFileSystemPolicyCommandOutput) => void): void;
666
693
  putFileSystemPolicy(args: PutFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFileSystemPolicyCommandOutput) => void): void;
667
694
  /**
695
+ * @public
668
696
  * <p>Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A
669
697
  * <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code>
670
698
  * objects that define the following:</p>
@@ -717,6 +745,7 @@ export declare class EFS extends EFSClient {
717
745
  putLifecycleConfiguration(args: PutLifecycleConfigurationCommandInput, cb: (err: any, data?: PutLifecycleConfigurationCommandOutput) => void): void;
718
746
  putLifecycleConfiguration(args: PutLifecycleConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecycleConfigurationCommandOutput) => void): void;
719
747
  /**
748
+ * @public
720
749
  * <p>Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.</p>
721
750
  * <p>This operation requires permissions for the <code>elasticfilesystem:TagResource</code> action.</p>
722
751
  */
@@ -724,6 +753,7 @@ export declare class EFS extends EFSClient {
724
753
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
725
754
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
726
755
  /**
756
+ * @public
727
757
  * <p>Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.</p>
728
758
  * <p>This operation requires permissions for the <code>elasticfilesystem:UntagResource</code> action.</p>
729
759
  */
@@ -731,6 +761,7 @@ export declare class EFS extends EFSClient {
731
761
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
732
762
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
733
763
  /**
764
+ * @public
734
765
  * <p>Updates the throughput mode or the amount of provisioned throughput of an existing file
735
766
  * system.</p>
736
767
  */
@@ -38,15 +38,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
38
38
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
39
39
  import { UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput } from "./commands/UpdateFileSystemCommand";
40
40
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
41
+ /**
42
+ * @public
43
+ */
41
44
  export type ServiceInputTypes = CreateAccessPointCommandInput | CreateFileSystemCommandInput | CreateMountTargetCommandInput | CreateReplicationConfigurationCommandInput | CreateTagsCommandInput | DeleteAccessPointCommandInput | DeleteFileSystemCommandInput | DeleteFileSystemPolicyCommandInput | DeleteMountTargetCommandInput | DeleteReplicationConfigurationCommandInput | DeleteTagsCommandInput | DescribeAccessPointsCommandInput | DescribeAccountPreferencesCommandInput | DescribeBackupPolicyCommandInput | DescribeFileSystemPolicyCommandInput | DescribeFileSystemsCommandInput | DescribeLifecycleConfigurationCommandInput | DescribeMountTargetSecurityGroupsCommandInput | DescribeMountTargetsCommandInput | DescribeReplicationConfigurationsCommandInput | DescribeTagsCommandInput | ListTagsForResourceCommandInput | ModifyMountTargetSecurityGroupsCommandInput | PutAccountPreferencesCommandInput | PutBackupPolicyCommandInput | PutFileSystemPolicyCommandInput | PutLifecycleConfigurationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateFileSystemCommandInput;
45
+ /**
46
+ * @public
47
+ */
42
48
  export type ServiceOutputTypes = CreateAccessPointCommandOutput | CreateFileSystemCommandOutput | CreateMountTargetCommandOutput | CreateReplicationConfigurationCommandOutput | CreateTagsCommandOutput | DeleteAccessPointCommandOutput | DeleteFileSystemCommandOutput | DeleteFileSystemPolicyCommandOutput | DeleteMountTargetCommandOutput | DeleteReplicationConfigurationCommandOutput | DeleteTagsCommandOutput | DescribeAccessPointsCommandOutput | DescribeAccountPreferencesCommandOutput | DescribeBackupPolicyCommandOutput | DescribeFileSystemPolicyCommandOutput | DescribeFileSystemsCommandOutput | DescribeLifecycleConfigurationCommandOutput | DescribeMountTargetSecurityGroupsCommandOutput | DescribeMountTargetsCommandOutput | DescribeReplicationConfigurationsCommandOutput | DescribeTagsCommandOutput | ListTagsForResourceCommandOutput | ModifyMountTargetSecurityGroupsCommandOutput | PutAccountPreferencesCommandOutput | PutBackupPolicyCommandOutput | PutFileSystemPolicyCommandOutput | PutLifecycleConfigurationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateFileSystemCommandOutput;
49
+ /**
50
+ * @public
51
+ */
43
52
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
44
53
  /**
45
54
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
46
55
  */
47
56
  requestHandler?: __HttpHandler;
48
57
  /**
49
- * A constructor for a class implementing the {@link __Checksum} interface
58
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
50
59
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
51
60
  * @internal
52
61
  */
@@ -136,23 +145,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
136
145
  */
137
146
  logger?: __Logger;
138
147
  /**
139
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
148
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
140
149
  */
141
150
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
142
151
  }
152
+ /**
153
+ * @public
154
+ */
143
155
  type EFSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
144
156
  /**
145
- * The configuration interface of EFSClient class constructor that set the region, credentials and other options.
157
+ * @public
158
+ *
159
+ * The configuration interface of EFSClient class constructor that set the region, credentials and other options.
146
160
  */
147
161
  export interface EFSClientConfig extends EFSClientConfigType {
148
162
  }
163
+ /**
164
+ * @public
165
+ */
149
166
  type EFSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
150
167
  /**
151
- * The resolved configuration interface of EFSClient class. This is resolved and normalized from the {@link EFSClientConfig | constructor configuration interface}.
168
+ * @public
169
+ *
170
+ * The resolved configuration interface of EFSClient class. This is resolved and normalized from the {@link EFSClientConfig | constructor configuration interface}.
152
171
  */
153
172
  export interface EFSClientResolvedConfig extends EFSClientResolvedConfigType {
154
173
  }
155
174
  /**
175
+ * @public
156
176
  * <fullname>Amazon Elastic File System</fullname>
157
177
  * <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
158
178
  * use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
5
5
  import { AccessPointDescription, CreateAccessPointRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAccessPointCommand}.
8
10
  */
9
11
  export interface CreateAccessPointCommandInput extends CreateAccessPointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAccessPointCommand}.
13
17
  */
14
18
  export interface CreateAccessPointCommandOutput extends AccessPointDescription, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an EFS access point. An access point is an application-specific view into an EFS
18
23
  * file system that applies an operating system user and group, and a file system path, to any
19
24
  * file system request made through the access point. The operating system user and group
@@ -38,6 +43,8 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription,
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param CreateAccessPointCommandInput - {@link CreateAccessPointCommandInput}
47
+ * @returns {@link CreateAccessPointCommandOutput}
41
48
  * @see {@link CreateAccessPointCommandInput} for command's `input` shape.
42
49
  * @see {@link CreateAccessPointCommandOutput} for command's `response` shape.
43
50
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
@@ -74,11 +81,20 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription,
74
81
  export declare class CreateAccessPointCommand extends $Command<CreateAccessPointCommandInput, CreateAccessPointCommandOutput, EFSClientResolvedConfig> {
75
82
  readonly input: CreateAccessPointCommandInput;
76
83
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
84
+ /**
85
+ * @public
86
+ */
77
87
  constructor(input: CreateAccessPointCommandInput);
78
88
  /**
79
89
  * @internal
80
90
  */
81
91
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EFSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessPointCommandInput, CreateAccessPointCommandOutput>;
92
+ /**
93
+ * @internal
94
+ */
82
95
  private serialize;
96
+ /**
97
+ * @internal
98
+ */
83
99
  private deserialize;
84
100
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
5
5
  import { CreateFileSystemRequest, FileSystemDescription } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateFileSystemCommand}.
8
10
  */
9
11
  export interface CreateFileSystemCommandInput extends CreateFileSystemRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateFileSystemCommand}.
13
17
  */
14
18
  export interface CreateFileSystemCommandOutput extends FileSystemDescription, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new, empty file system. The operation requires a creation token in the
18
23
  * request that Amazon EFS uses to ensure idempotent creation (calling the operation with same
19
24
  * creation token has no effect). If a file system does not currently exist that is owned by the
@@ -73,6 +78,8 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __
73
78
  * const response = await client.send(command);
74
79
  * ```
75
80
  *
81
+ * @param CreateFileSystemCommandInput - {@link CreateFileSystemCommandInput}
82
+ * @returns {@link CreateFileSystemCommandOutput}
76
83
  * @see {@link CreateFileSystemCommandInput} for command's `input` shape.
77
84
  * @see {@link CreateFileSystemCommandOutput} for command's `response` shape.
78
85
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
@@ -152,11 +159,20 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __
152
159
  export declare class CreateFileSystemCommand extends $Command<CreateFileSystemCommandInput, CreateFileSystemCommandOutput, EFSClientResolvedConfig> {
153
160
  readonly input: CreateFileSystemCommandInput;
154
161
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
162
+ /**
163
+ * @public
164
+ */
155
165
  constructor(input: CreateFileSystemCommandInput);
156
166
  /**
157
167
  * @internal
158
168
  */
159
169
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EFSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateFileSystemCommandInput, CreateFileSystemCommandOutput>;
170
+ /**
171
+ * @internal
172
+ */
160
173
  private serialize;
174
+ /**
175
+ * @internal
176
+ */
161
177
  private deserialize;
162
178
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
5
5
  import { CreateMountTargetRequest, MountTargetDescription } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateMountTargetCommand}.
8
10
  */
9
11
  export interface CreateMountTargetCommandInput extends CreateMountTargetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateMountTargetCommand}.
13
17
  */
14
18
  export interface CreateMountTargetCommandOutput extends MountTargetDescription, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a mount target for a file system. You can then mount the file system on EC2
18
23
  * instances by using the mount target.</p>
19
24
  * <p>You can create one mount target in each Availability Zone in your VPC. All EC2
@@ -164,6 +169,8 @@ export interface CreateMountTargetCommandOutput extends MountTargetDescription,
164
169
  * const response = await client.send(command);
165
170
  * ```
166
171
  *
172
+ * @param CreateMountTargetCommandInput - {@link CreateMountTargetCommandInput}
173
+ * @returns {@link CreateMountTargetCommandOutput}
167
174
  * @see {@link CreateMountTargetCommandInput} for command's `input` shape.
168
175
  * @see {@link CreateMountTargetCommandOutput} for command's `response` shape.
169
176
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
@@ -250,11 +257,20 @@ export interface CreateMountTargetCommandOutput extends MountTargetDescription,
250
257
  export declare class CreateMountTargetCommand extends $Command<CreateMountTargetCommandInput, CreateMountTargetCommandOutput, EFSClientResolvedConfig> {
251
258
  readonly input: CreateMountTargetCommandInput;
252
259
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
260
+ /**
261
+ * @public
262
+ */
253
263
  constructor(input: CreateMountTargetCommandInput);
254
264
  /**
255
265
  * @internal
256
266
  */
257
267
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EFSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateMountTargetCommandInput, CreateMountTargetCommandOutput>;
268
+ /**
269
+ * @internal
270
+ */
258
271
  private serialize;
272
+ /**
273
+ * @internal
274
+ */
259
275
  private deserialize;
260
276
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
5
5
  import { CreateReplicationConfigurationRequest, ReplicationConfigurationDescription } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateReplicationConfigurationCommand}.
8
10
  */
9
11
  export interface CreateReplicationConfigurationCommandInput extends CreateReplicationConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateReplicationConfigurationCommand}.
13
17
  */
14
18
  export interface CreateReplicationConfigurationCommandOutput extends ReplicationConfigurationDescription, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a replication configuration that replicates an existing EFS file system to a new,
18
23
  * read-only file system. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the
19
24
  * <i>Amazon EFS User Guide</i>. The replication configuration
@@ -106,6 +111,8 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
106
111
  * const response = await client.send(command);
107
112
  * ```
108
113
  *
114
+ * @param CreateReplicationConfigurationCommandInput - {@link CreateReplicationConfigurationCommandInput}
115
+ * @returns {@link CreateReplicationConfigurationCommandOutput}
109
116
  * @see {@link CreateReplicationConfigurationCommandInput} for command's `input` shape.
110
117
  * @see {@link CreateReplicationConfigurationCommandOutput} for command's `response` shape.
111
118
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
@@ -154,11 +161,20 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
154
161
  export declare class CreateReplicationConfigurationCommand extends $Command<CreateReplicationConfigurationCommandInput, CreateReplicationConfigurationCommandOutput, EFSClientResolvedConfig> {
155
162
  readonly input: CreateReplicationConfigurationCommandInput;
156
163
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
164
+ /**
165
+ * @public
166
+ */
157
167
  constructor(input: CreateReplicationConfigurationCommandInput);
158
168
  /**
159
169
  * @internal
160
170
  */
161
171
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EFSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateReplicationConfigurationCommandInput, CreateReplicationConfigurationCommandOutput>;
172
+ /**
173
+ * @internal
174
+ */
162
175
  private serialize;
176
+ /**
177
+ * @internal
178
+ */
163
179
  private deserialize;
164
180
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
5
5
  import { CreateTagsRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateTagsCommand}.
8
10
  */
9
11
  export interface CreateTagsCommandInput extends CreateTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateTagsCommand}.
13
17
  */
14
18
  export interface CreateTagsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * @deprecated
18
23
  *
19
24
  * <note>
@@ -36,6 +41,8 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param CreateTagsCommandInput - {@link CreateTagsCommandInput}
45
+ * @returns {@link CreateTagsCommandOutput}
39
46
  * @see {@link CreateTagsCommandInput} for command's `input` shape.
40
47
  * @see {@link CreateTagsCommandOutput} for command's `response` shape.
41
48
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
@@ -73,11 +80,20 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {
73
80
  export declare class CreateTagsCommand extends $Command<CreateTagsCommandInput, CreateTagsCommandOutput, EFSClientResolvedConfig> {
74
81
  readonly input: CreateTagsCommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: CreateTagsCommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EFSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTagsCommandInput, CreateTagsCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient";
5
5
  import { DeleteAccessPointRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAccessPointCommand}.
8
10
  */
9
11
  export interface DeleteAccessPointCommandInput extends DeleteAccessPointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAccessPointCommand}.
13
17
  */
14
18
  export interface DeleteAccessPointCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified access point. After deletion is complete, new clients can no
18
23
  * longer connect to the access points. Clients connected to the access point at the time of
19
24
  * deletion will continue to function until they terminate their connection.</p>
@@ -28,6 +33,8 @@ export interface DeleteAccessPointCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteAccessPointCommandInput - {@link DeleteAccessPointCommandInput}
37
+ * @returns {@link DeleteAccessPointCommandOutput}
31
38
  * @see {@link DeleteAccessPointCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteAccessPointCommandOutput} for command's `response` shape.
33
40
  * @see {@link EFSClientResolvedConfig | config} for EFSClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteAccessPointCommandOutput extends __MetadataBearer {
48
55
  export declare class DeleteAccessPointCommand extends $Command<DeleteAccessPointCommandInput, DeleteAccessPointCommandOutput, EFSClientResolvedConfig> {
49
56
  readonly input: DeleteAccessPointCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteAccessPointCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EFSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAccessPointCommandInput, DeleteAccessPointCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }