@aws-sdk/client-efs 3.451.0 → 3.458.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 (35) hide show
  1. package/README.md +30 -30
  2. package/dist-cjs/models/models_0.js +15 -1
  3. package/dist-cjs/pagination/DescribeMountTargetsPaginator.js +29 -0
  4. package/dist-cjs/pagination/DescribeReplicationConfigurationsPaginator.js +29 -0
  5. package/dist-cjs/pagination/index.js +2 -0
  6. package/dist-cjs/protocols/Aws_restJson1.js +1 -0
  7. package/dist-es/models/models_0.js +14 -0
  8. package/dist-es/pagination/DescribeMountTargetsPaginator.js +25 -0
  9. package/dist-es/pagination/DescribeReplicationConfigurationsPaginator.js +25 -0
  10. package/dist-es/pagination/index.js +2 -0
  11. package/dist-es/protocols/Aws_restJson1.js +1 -0
  12. package/dist-types/commands/CreateAccessPointCommand.d.ts +8 -7
  13. package/dist-types/commands/CreateFileSystemCommand.d.ts +11 -6
  14. package/dist-types/commands/CreateMountTargetCommand.d.ts +6 -6
  15. package/dist-types/commands/CreateReplicationConfigurationCommand.d.ts +8 -10
  16. package/dist-types/commands/DescribeAccessPointsCommand.d.ts +5 -3
  17. package/dist-types/commands/DescribeFileSystemPolicyCommand.d.ts +2 -1
  18. package/dist-types/commands/DescribeFileSystemsCommand.d.ts +1 -0
  19. package/dist-types/commands/DescribeLifecycleConfigurationCommand.d.ts +5 -6
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  21. package/dist-types/commands/PutAccountPreferencesCommand.d.ts +4 -5
  22. package/dist-types/commands/PutFileSystemPolicyCommand.d.ts +8 -8
  23. package/dist-types/commands/PutLifecycleConfigurationCommand.d.ts +35 -17
  24. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  25. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  26. package/dist-types/commands/UpdateFileSystemCommand.d.ts +1 -0
  27. package/dist-types/models/models_0.d.ts +168 -97
  28. package/dist-types/pagination/DescribeMountTargetsPaginator.d.ts +7 -0
  29. package/dist-types/pagination/DescribeReplicationConfigurationsPaginator.d.ts +7 -0
  30. package/dist-types/pagination/index.d.ts +2 -0
  31. package/dist-types/ts3.4/models/models_0.d.ts +18 -0
  32. package/dist-types/ts3.4/pagination/DescribeMountTargetsPaginator.d.ts +11 -0
  33. package/dist-types/ts3.4/pagination/DescribeReplicationConfigurationsPaginator.d.ts +11 -0
  34. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  35. package/package.json +3 -3
@@ -23,8 +23,8 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates a replication configuration that replicates an existing EFS file system to a new,
27
- * 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
26
+ * <p>Creates a replication configuration that replicates an existing EFS file system
27
+ * to a new, 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
28
28
  * <i>Amazon EFS User Guide</i>. The replication configuration
29
29
  * specifies the following:</p>
30
30
  * <ul>
@@ -52,9 +52,8 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
52
52
  * <li>
53
53
  * <p>
54
54
  * <b>Availability Zone</b> - If you want the destination file system
55
- * to use EFS One Zone availability and durability, you must specify the Availability
56
- * Zone to create the file system in. For more information about EFS storage classes, see
57
- * <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">
55
+ * to use EFS One Zone availability, you must specify the Availability Zone to create the
56
+ * file system in. For more information about EFS storage classes, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">
58
57
  * Amazon EFS storage classes</a> in the <i>Amazon EFS User
59
58
  * Guide</i>.</p>
60
59
  * </li>
@@ -91,14 +90,13 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
91
90
  * <ul>
92
91
  * <li>
93
92
  * <p>
94
- * <b>Lifecycle management</b> - EFS lifecycle management and EFS
95
- * Intelligent-Tiering are not enabled on the destination file system. After the destination
96
- * file system is created, you can enable EFS lifecycle management and EFS
97
- * Intelligent-Tiering.</p>
93
+ * <b>Lifecycle management</b> Lifecycle management is not enabled
94
+ * on the destination file system. After the destination file system is created, you can
95
+ * enable it.</p>
98
96
  * </li>
99
97
  * <li>
100
98
  * <p>
101
- * <b>Automatic backups</b> - Automatic daily backups are enabled on
99
+ * <b>Automatic backups</b> Automatic daily backups are enabled on
102
100
  * the destination file system. After the file system is created, you can change this
103
101
  * setting.</p>
104
102
  * </li>
@@ -23,9 +23,11 @@ export interface DescribeAccessPointsCommandOutput extends DescribeAccessPointsR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided.
27
- * If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system.
28
- * You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. </p>
26
+ * <p>Returns the description of a specific Amazon EFS access point if the
27
+ * <code>AccessPointId</code> is provided. If you provide an EFS
28
+ * <code>FileSystemId</code>, it returns descriptions of all access points for that file
29
+ * system. You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in
30
+ * the request, but not both. </p>
29
31
  * <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>
30
32
  * @example
31
33
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,7 +23,8 @@ export interface DescribeFileSystemPolicyCommandOutput extends FileSystemPolicyD
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Returns the <code>FileSystemPolicy</code> for the specified EFS file system.</p>
26
+ * <p>Returns the <code>FileSystemPolicy</code> for the specified EFS file
27
+ * system.</p>
27
28
  * <p>This operation requires permissions for the <code>elasticfilesystem:DescribeFileSystemPolicy</code> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -74,6 +74,7 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
74
74
  * // Timestamp: new Date("TIMESTAMP"),
75
75
  * // ValueInIA: Number("long"),
76
76
  * // ValueInStandard: Number("long"),
77
+ * // ValueInArchive: Number("long"),
77
78
  * // },
78
79
  * // PerformanceMode: "generalPurpose" || "maxIO", // required
79
80
  * // Encrypted: true || false,
@@ -24,12 +24,10 @@ export interface DescribeLifecycleConfigurationCommandOutput extends LifecycleCo
24
24
  /**
25
25
  * @public
26
26
  * <p>Returns the current <code>LifecycleConfiguration</code> object for the specified Amazon
27
- * EFS file system. EFS lifecycle management uses the <code>LifecycleConfiguration</code> object
28
- * to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system
29
- * without a <code>LifecycleConfiguration</code> object, the call returns an empty array in the
27
+ * EFS file system. Llifecycle management uses the <code>LifecycleConfiguration</code> object to
28
+ * identify when to move files between storage classes. For a file system without a
29
+ * <code>LifecycleConfiguration</code> object, the call returns an empty array in the
30
30
  * response.</p>
31
- * <p>When EFS Intelligent-Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has
32
- * a value of <code>AFTER_1_ACCESS</code>.</p>
33
31
  * <p>This operation requires permissions for the
34
32
  * <code>elasticfilesystem:DescribeLifecycleConfiguration</code> operation.</p>
35
33
  * @example
@@ -46,8 +44,9 @@ export interface DescribeLifecycleConfigurationCommandOutput extends LifecycleCo
46
44
  * // { // LifecycleConfigurationDescription
47
45
  * // LifecyclePolicies: [ // LifecyclePolicies
48
46
  * // { // LifecyclePolicy
49
- * // TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY",
47
+ * // TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY" || "AFTER_180_DAYS" || "AFTER_270_DAYS" || "AFTER_365_DAYS",
50
48
  * // TransitionToPrimaryStorageClass: "AFTER_1_ACCESS",
49
+ * // TransitionToArchive: "AFTER_1_DAY" || "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_180_DAYS" || "AFTER_270_DAYS" || "AFTER_365_DAYS",
51
50
  * // },
52
51
  * // ],
53
52
  * // };
@@ -23,7 +23,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <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>
26
+ * <p>Lists all tags for a top-level EFS resource. You must provide the ID of the
27
+ * resource that you want to retrieve the tags for.</p>
27
28
  * <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -24,11 +24,10 @@ export interface PutAccountPreferencesCommandOutput extends PutAccountPreference
24
24
  /**
25
25
  * @public
26
26
  * <p>Use this operation to set the account preference in the current Amazon Web Services Region
27
- * to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for
28
- * new EFS file system and mount target resources. All existing resource IDs are not affected
29
- * by any changes you make. You can set the ID preference during the
30
- * opt-in period as EFS transitions to long resource IDs. For more information,
31
- * see <a href="https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>.</p>
27
+ * to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new
28
+ * EFS file system and mount target resources. All existing resource IDs are not
29
+ * affected by any changes you make. You can set the ID preference during the opt-in period as
30
+ * 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>
32
31
  * <note>
33
32
  * <p>Starting in October, 2021, you will receive an error if you try to set the account preference
34
33
  * to use the short 8 character format resource ID. Contact Amazon Web Services support if you
@@ -23,14 +23,14 @@ export interface PutFileSystemPolicyCommandOutput extends FileSystemPolicyDescri
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Applies an Amazon EFS <code>FileSystemPolicy</code> to an Amazon EFS file system.
27
- * A file system policy is an IAM resource-based policy and can contain multiple policy statements.
28
- * A file system always has exactly one file system policy, which can be the default policy or
29
- * an explicit policy set or updated using this API operation.
30
- * EFS file system policies have a 20,000 character limit.
31
- * When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see
32
- * <a href="https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy">Default EFS File System Policy</a>.
33
- * </p>
26
+ * <p>Applies an Amazon EFS
27
+ * <code>FileSystemPolicy</code> to an Amazon EFS file system. A file system policy is an
28
+ * IAM resource-based policy and can contain multiple policy statements. A file system always has
29
+ * exactly one file system policy, which can be the default policy or an explicit policy set or
30
+ * updated using this API operation. EFS file system policies have a 20,000 character
31
+ * limit. When an explicit policy is set, it overrides the default policy. For more information
32
+ * 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
33
+ * File System Policy</a>. </p>
34
34
  * <note>
35
35
  * <p>EFS file system policies have a 20,000 character limit.</p>
36
36
  * </note>
@@ -23,43 +23,59 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A
26
+ * <p>Use this action to manage storage of your file system. A
27
27
  * <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code>
28
28
  * objects that define the following:</p>
29
29
  * <ul>
30
30
  * <li>
31
31
  * <p>
32
- * <b>EFS Lifecycle management</b> - When Amazon EFS
33
- * automatically transitions files in a file system into the lower-cost EFS Infrequent Access
34
- * (IA) storage class.</p>
35
- * <p>To enable EFS Lifecycle management, set the value of <code>TransitionToIA</code> to one of the available options.</p>
32
+ * <b>
33
+ * <code>TransitionToIA</code>
34
+ * </b>
35
+ * When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access
36
+ * (IA) storage.</p>
36
37
  * </li>
37
38
  * <li>
38
39
  * <p>
39
- * <b>EFS Intelligent-Tiering</b> - When Amazon EFS
40
- * automatically transitions files from IA back into the file system's primary storage class
41
- * (EFS Standard or EFS One Zone Standard).</p>
42
- * <p>To enable EFS Intelligent-Tiering, set the value of
43
- * <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>.</p>
40
+ * <b>
41
+ * <code>TransitionToArchive</code>
42
+ * </b>
43
+ * When to move files in the file system from their current storage class (either IA or Standard storage) into the
44
+ * Archive storage.</p>
45
+ * <p>File systems cannot transition into Archive storage before transitioning into IA storage. Therefore,
46
+ * TransitionToArchive must either not be set or must be later than TransitionToIA.</p>
47
+ * <note>
48
+ * <p> The Archive storage class is available only for file systems that use the Elastic Throughput mode
49
+ * and the General Purpose Performance mode. </p>
50
+ * </note>
51
+ * </li>
52
+ * <li>
53
+ * <p>
54
+ * <b>
55
+ * <code>TransitionToPrimaryStorageClass</code>
56
+ * </b> –
57
+ * Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA
58
+ * or Archive storage.</p>
44
59
  * </li>
45
60
  * </ul>
46
- * <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p>
61
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">
62
+ * Managing file system storage</a>.</p>
47
63
  * <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to
48
64
  * all files in the file system. If a <code>LifecycleConfiguration</code> object already exists
49
65
  * for the specified file system, a <code>PutLifecycleConfiguration</code> call modifies the
50
66
  * existing configuration. A <code>PutLifecycleConfiguration</code> call with an empty
51
67
  * <code>LifecyclePolicies</code> array in the request body deletes any existing
52
- * <code>LifecycleConfiguration</code> and turns off lifecycle management and EFS
53
- * Intelligent-Tiering for the file system.</p>
68
+ * <code>LifecycleConfiguration</code> for the file system.</p>
54
69
  * <p>In the request, specify the following: </p>
55
70
  * <ul>
56
71
  * <li>
57
72
  * <p>The ID for the file system for which you are enabling, disabling, or modifying
58
- * lifecycle management and EFS Intelligent-Tiering.</p>
73
+ * Lifecycle management.</p>
59
74
  * </li>
60
75
  * <li>
61
76
  * <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that
62
- * define when files are moved into IA storage, and when they are moved back to Standard storage.</p>
77
+ * define when to move files to IA storage, to Archive storage,
78
+ * and back to primary storage.</p>
63
79
  * <note>
64
80
  * <p>Amazon EFS requires that each <code>LifecyclePolicy</code>
65
81
  * object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate
@@ -80,8 +96,9 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu
80
96
  * FileSystemId: "STRING_VALUE", // required
81
97
  * LifecyclePolicies: [ // LifecyclePolicies // required
82
98
  * { // LifecyclePolicy
83
- * TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY",
99
+ * TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY" || "AFTER_180_DAYS" || "AFTER_270_DAYS" || "AFTER_365_DAYS",
84
100
  * TransitionToPrimaryStorageClass: "AFTER_1_ACCESS",
101
+ * TransitionToArchive: "AFTER_1_DAY" || "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_180_DAYS" || "AFTER_270_DAYS" || "AFTER_365_DAYS",
85
102
  * },
86
103
  * ],
87
104
  * };
@@ -90,8 +107,9 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu
90
107
  * // { // LifecycleConfigurationDescription
91
108
  * // LifecyclePolicies: [ // LifecyclePolicies
92
109
  * // { // LifecyclePolicy
93
- * // TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY",
110
+ * // TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY" || "AFTER_180_DAYS" || "AFTER_270_DAYS" || "AFTER_365_DAYS",
94
111
  * // TransitionToPrimaryStorageClass: "AFTER_1_ACCESS",
112
+ * // TransitionToArchive: "AFTER_1_DAY" || "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_180_DAYS" || "AFTER_270_DAYS" || "AFTER_365_DAYS",
95
113
  * // },
96
114
  * // ],
97
115
  * // };
@@ -23,7 +23,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.</p>
26
+ * <p>Creates a tag for an EFS resource. You can create tags for EFS file
27
+ * systems and access points using this API operation.</p>
27
28
  * <p>This operation requires permissions for the <code>elasticfilesystem:TagResource</code> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -23,7 +23,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.</p>
26
+ * <p>Removes tags from an EFS resource. You can remove tags from EFS file
27
+ * systems and access points using this API operation.</p>
27
28
  * <p>This operation requires permissions for the <code>elasticfilesystem:UntagResource</code> action.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -52,6 +52,7 @@ export interface UpdateFileSystemCommandOutput extends FileSystemDescription, __
52
52
  * // Timestamp: new Date("TIMESTAMP"),
53
53
  * // ValueInIA: Number("long"),
54
54
  * // ValueInStandard: Number("long"),
55
+ * // ValueInArchive: Number("long"),
55
56
  * // },
56
57
  * // PerformanceMode: "generalPurpose" || "maxIO", // required
57
58
  * // Encrypted: true || false,