@aws-sdk/client-efs 3.56.0 → 3.69.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.
- package/CHANGELOG.md +27 -0
- package/README.md +6 -6
- package/dist-cjs/models/models_0.js +17 -2
- package/dist-cjs/protocols/Aws_restJson1.js +18 -0
- package/dist-es/models/models_0.js +14 -0
- package/dist-es/protocols/Aws_restJson1.js +22 -3
- package/dist-types/EFS.d.ts +106 -72
- package/dist-types/EFSClient.d.ts +4 -4
- package/dist-types/commands/CreateAccessPointCommand.d.ts +2 -2
- package/dist-types/commands/CreateReplicationConfigurationCommand.d.ts +45 -36
- package/dist-types/commands/CreateTagsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +7 -0
- package/dist-types/commands/DeleteReplicationConfigurationCommand.d.ts +6 -5
- package/dist-types/commands/DeleteTagsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeLifecycleConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplicationConfigurationsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeTagsCommand.d.ts +3 -2
- package/dist-types/commands/PutAccountPreferencesCommand.d.ts +3 -2
- package/dist-types/commands/PutLifecycleConfigurationCommand.d.ts +27 -14
- package/dist-types/models/models_0.d.ts +112 -71
- package/dist-types/ts3.4/models/models_0.d.ts +11 -0
- package/package.json +18 -18
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,33 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.69.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.68.0...v3.69.0) (2022-04-12)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **client-efs:** Amazon EFS adds support for a ThrottlingException when using the CreateAccessPoint API if the account is nearing the AccessPoint limit(120). ([848941d](https://github.com/aws/aws-sdk-js-v3/commit/848941d3dc0639cfc0f8dca4589ed371947306e1))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
# [3.67.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.66.0...v3.67.0) (2022-04-08)
|
|
18
|
+
|
|
19
|
+
**Note:** Version bump only for package @aws-sdk/client-efs
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# [3.58.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.57.0...v3.58.0) (2022-03-28)
|
|
26
|
+
|
|
27
|
+
**Note:** Version bump only for package @aws-sdk/client-efs
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
6
33
|
# [3.56.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.55.0...v3.56.0) (2022-03-24)
|
|
7
34
|
|
|
8
35
|
**Note:** Version bump only for package @aws-sdk/client-efs
|
package/README.md
CHANGED
|
@@ -9,10 +9,10 @@ AWS SDK for JavaScript EFS Client for Node.js, Browser and React Native.
|
|
|
9
9
|
|
|
10
10
|
<fullname>Amazon Elastic File System</fullname>
|
|
11
11
|
|
|
12
|
-
<p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
|
|
13
|
-
with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic,
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
<p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
|
|
13
|
+
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
|
|
14
|
+
remove files, so that your applications have the storage they need, when they need it. For
|
|
15
|
+
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>
|
|
16
16
|
|
|
17
17
|
## Installing
|
|
18
18
|
|
|
@@ -120,7 +120,7 @@ but they are supported by the send operation.
|
|
|
120
120
|
```js
|
|
121
121
|
// callbacks.
|
|
122
122
|
client.send(command, (err, data) => {
|
|
123
|
-
//
|
|
123
|
+
// process err and data.
|
|
124
124
|
});
|
|
125
125
|
```
|
|
126
126
|
|
|
@@ -154,7 +154,7 @@ client
|
|
|
154
154
|
|
|
155
155
|
// callbacks.
|
|
156
156
|
client.createAccessPoint(params, (err, data) => {
|
|
157
|
-
//
|
|
157
|
+
// process err and data.
|
|
158
158
|
});
|
|
159
159
|
```
|
|
160
160
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.UpdateFileSystemRequest = exports.TooManyRequests = exports.UntagResourceRequest = exports.TagResourceRequest = exports.PutLifecycleConfigurationRequest = exports.PutFileSystemPolicyRequest = exports.PutBackupPolicyRequest = exports.PutAccountPreferencesResponse = exports.PutAccountPreferencesRequest = exports.ModifyMountTargetSecurityGroupsRequest = exports.ListTagsForResourceResponse = exports.ListTagsForResourceRequest = exports.InvalidPolicyException = exports.DescribeTagsResponse = exports.DescribeTagsRequest = exports.DescribeReplicationConfigurationsResponse = exports.DescribeReplicationConfigurationsRequest = exports.IncorrectMountTargetState = exports.DescribeMountTargetSecurityGroupsResponse = exports.DescribeMountTargetSecurityGroupsRequest = exports.DescribeMountTargetsResponse = exports.DescribeMountTargetsRequest = exports.LifecycleConfigurationDescription = exports.LifecyclePolicy = exports.TransitionToPrimaryStorageClassRules = exports.TransitionToIARules = exports.DescribeLifecycleConfigurationRequest = exports.DescribeFileSystemsResponse = exports.DescribeFileSystemsRequest = exports.FileSystemPolicyDescription = exports.DescribeFileSystemPolicyRequest = exports.PolicyNotFound = exports.DescribeBackupPolicyRequest = exports.DescribeAccountPreferencesResponse = exports.ResourceIdPreference = exports.Resource = exports.ResourceIdType = exports.DescribeAccountPreferencesRequest = exports.DescribeAccessPointsResponse = exports.DescribeAccessPointsRequest = exports.DeleteTagsRequest = exports.DeleteReplicationConfigurationRequest = exports.MountTargetNotFound = exports.DependencyTimeout = void 0;
|
|
3
|
+
exports.DeleteFileSystemPolicyRequest = exports.FileSystemInUse = exports.DeleteFileSystemRequest = exports.DeleteAccessPointRequest = exports.CreateTagsRequest = exports.ValidationException = exports.ReplicationNotFound = exports.ReplicationConfigurationDescription = exports.Destination = exports.ReplicationStatus = exports.CreateReplicationConfigurationRequest = exports.DestinationToCreate = exports.SubnetNotFound = exports.SecurityGroupNotFound = exports.SecurityGroupLimitExceeded = exports.NoFreeAddressesInSubnet = exports.NetworkInterfaceLimitExceeded = exports.MountTargetDescription = exports.MountTargetConflict = exports.IpAddressInUse = exports.CreateMountTargetRequest = exports.UnsupportedAvailabilityZone = exports.ThroughputLimitExceeded = exports.InsufficientThroughputCapacity = exports.FileSystemLimitExceeded = exports.FileSystemDescription = exports.FileSystemSize = exports.FileSystemAlreadyExists = exports.CreateFileSystemRequest = exports.ThroughputMode = exports.PerformanceMode = exports.ThrottlingException = exports.InternalServerError = exports.IncorrectFileSystemLifeCycleState = exports.FileSystemNotFound = exports.CreateAccessPointRequest = exports.BadRequest = exports.BackupPolicyDescription = exports.BackupPolicy = exports.Status = exports.AvailabilityZonesMismatch = exports.AccessPointNotFound = exports.AccessPointLimitExceeded = exports.AccessPointDescription = exports.Tag = exports.RootDirectory = exports.CreationInfo = exports.PosixUser = exports.LifeCycleState = exports.AccessPointAlreadyExists = void 0;
|
|
4
|
+
exports.UpdateFileSystemRequest = exports.TooManyRequests = exports.UntagResourceRequest = exports.TagResourceRequest = exports.PutLifecycleConfigurationRequest = exports.PutFileSystemPolicyRequest = exports.PutBackupPolicyRequest = exports.PutAccountPreferencesResponse = exports.PutAccountPreferencesRequest = exports.ModifyMountTargetSecurityGroupsRequest = exports.ListTagsForResourceResponse = exports.ListTagsForResourceRequest = exports.InvalidPolicyException = exports.DescribeTagsResponse = exports.DescribeTagsRequest = exports.DescribeReplicationConfigurationsResponse = exports.DescribeReplicationConfigurationsRequest = exports.IncorrectMountTargetState = exports.DescribeMountTargetSecurityGroupsResponse = exports.DescribeMountTargetSecurityGroupsRequest = exports.DescribeMountTargetsResponse = exports.DescribeMountTargetsRequest = exports.LifecycleConfigurationDescription = exports.LifecyclePolicy = exports.TransitionToPrimaryStorageClassRules = exports.TransitionToIARules = exports.DescribeLifecycleConfigurationRequest = exports.DescribeFileSystemsResponse = exports.DescribeFileSystemsRequest = exports.FileSystemPolicyDescription = exports.DescribeFileSystemPolicyRequest = exports.PolicyNotFound = exports.DescribeBackupPolicyRequest = exports.DescribeAccountPreferencesResponse = exports.ResourceIdPreference = exports.Resource = exports.ResourceIdType = exports.DescribeAccountPreferencesRequest = exports.DescribeAccessPointsResponse = exports.DescribeAccessPointsRequest = exports.DeleteTagsRequest = exports.DeleteReplicationConfigurationRequest = exports.MountTargetNotFound = exports.DependencyTimeout = exports.DeleteMountTargetRequest = void 0;
|
|
5
5
|
const EFSServiceException_1 = require("./EFSServiceException");
|
|
6
6
|
class AccessPointAlreadyExists extends EFSServiceException_1.EFSServiceException {
|
|
7
7
|
constructor(opts) {
|
|
@@ -188,6 +188,21 @@ class InternalServerError extends EFSServiceException_1.EFSServiceException {
|
|
|
188
188
|
}
|
|
189
189
|
}
|
|
190
190
|
exports.InternalServerError = InternalServerError;
|
|
191
|
+
class ThrottlingException extends EFSServiceException_1.EFSServiceException {
|
|
192
|
+
constructor(opts) {
|
|
193
|
+
super({
|
|
194
|
+
name: "ThrottlingException",
|
|
195
|
+
$fault: "client",
|
|
196
|
+
...opts,
|
|
197
|
+
});
|
|
198
|
+
this.name = "ThrottlingException";
|
|
199
|
+
this.$fault = "client";
|
|
200
|
+
Object.setPrototypeOf(this, ThrottlingException.prototype);
|
|
201
|
+
this.ErrorCode = opts.ErrorCode;
|
|
202
|
+
this.Message = opts.Message;
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
exports.ThrottlingException = ThrottlingException;
|
|
191
206
|
var PerformanceMode;
|
|
192
207
|
(function (PerformanceMode) {
|
|
193
208
|
PerformanceMode["GENERAL_PURPOSE"] = "generalPurpose";
|
|
@@ -951,6 +951,9 @@ const deserializeAws_restJson1CreateAccessPointCommandError = async (output, con
|
|
|
951
951
|
case "InternalServerError":
|
|
952
952
|
case "com.amazonaws.efs#InternalServerError":
|
|
953
953
|
throw await deserializeAws_restJson1InternalServerErrorResponse(parsedOutput, context);
|
|
954
|
+
case "ThrottlingException":
|
|
955
|
+
case "com.amazonaws.efs#ThrottlingException":
|
|
956
|
+
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
954
957
|
default:
|
|
955
958
|
const parsedBody = parsedOutput.body;
|
|
956
959
|
response = new EFSServiceException_1.EFSServiceException({
|
|
@@ -2919,6 +2922,21 @@ const deserializeAws_restJson1SubnetNotFoundResponse = async (parsedOutput, cont
|
|
|
2919
2922
|
});
|
|
2920
2923
|
return (0, smithy_client_1.decorateServiceException)(exception, parsedOutput.body);
|
|
2921
2924
|
};
|
|
2925
|
+
const deserializeAws_restJson1ThrottlingExceptionResponse = async (parsedOutput, context) => {
|
|
2926
|
+
const contents = {};
|
|
2927
|
+
const data = parsedOutput.body;
|
|
2928
|
+
if (data.ErrorCode !== undefined && data.ErrorCode !== null) {
|
|
2929
|
+
contents.ErrorCode = (0, smithy_client_1.expectString)(data.ErrorCode);
|
|
2930
|
+
}
|
|
2931
|
+
if (data.Message !== undefined && data.Message !== null) {
|
|
2932
|
+
contents.Message = (0, smithy_client_1.expectString)(data.Message);
|
|
2933
|
+
}
|
|
2934
|
+
const exception = new models_0_1.ThrottlingException({
|
|
2935
|
+
$metadata: deserializeMetadata(parsedOutput),
|
|
2936
|
+
...contents,
|
|
2937
|
+
});
|
|
2938
|
+
return (0, smithy_client_1.decorateServiceException)(exception, parsedOutput.body);
|
|
2939
|
+
};
|
|
2922
2940
|
const deserializeAws_restJson1ThroughputLimitExceededResponse = async (parsedOutput, context) => {
|
|
2923
2941
|
const contents = {};
|
|
2924
2942
|
const data = parsedOutput.body;
|
|
@@ -161,6 +161,20 @@ var InternalServerError = (function (_super) {
|
|
|
161
161
|
return InternalServerError;
|
|
162
162
|
}(__BaseException));
|
|
163
163
|
export { InternalServerError };
|
|
164
|
+
var ThrottlingException = (function (_super) {
|
|
165
|
+
__extends(ThrottlingException, _super);
|
|
166
|
+
function ThrottlingException(opts) {
|
|
167
|
+
var _this = _super.call(this, __assign({ name: "ThrottlingException", $fault: "client" }, opts)) || this;
|
|
168
|
+
_this.name = "ThrottlingException";
|
|
169
|
+
_this.$fault = "client";
|
|
170
|
+
Object.setPrototypeOf(_this, ThrottlingException.prototype);
|
|
171
|
+
_this.ErrorCode = opts.ErrorCode;
|
|
172
|
+
_this.Message = opts.Message;
|
|
173
|
+
return _this;
|
|
174
|
+
}
|
|
175
|
+
return ThrottlingException;
|
|
176
|
+
}(__BaseException));
|
|
177
|
+
export { ThrottlingException };
|
|
164
178
|
export var PerformanceMode;
|
|
165
179
|
(function (PerformanceMode) {
|
|
166
180
|
PerformanceMode["GENERAL_PURPOSE"] = "generalPurpose";
|
|
@@ -3,7 +3,7 @@ import { HttpRequest as __HttpRequest } from "@aws-sdk/protocol-http";
|
|
|
3
3
|
import { decorateServiceException as __decorateServiceException, expectBoolean as __expectBoolean, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectObject as __expectObject, expectString as __expectString, extendedEncodeURIComponent as __extendedEncodeURIComponent, limitedParseDouble as __limitedParseDouble, parseEpochTimestamp as __parseEpochTimestamp, serializeFloat as __serializeFloat, } from "@aws-sdk/smithy-client";
|
|
4
4
|
import { v4 as generateIdempotencyToken } from "uuid";
|
|
5
5
|
import { EFSServiceException as __BaseException } from "../models/EFSServiceException";
|
|
6
|
-
import { AccessPointAlreadyExists, AccessPointLimitExceeded, AccessPointNotFound, AvailabilityZonesMismatch, BadRequest, DependencyTimeout, FileSystemAlreadyExists, FileSystemInUse, FileSystemLimitExceeded, FileSystemNotFound, IncorrectFileSystemLifeCycleState, IncorrectMountTargetState, InsufficientThroughputCapacity, InternalServerError, InvalidPolicyException, IpAddressInUse, MountTargetConflict, MountTargetNotFound, NetworkInterfaceLimitExceeded, NoFreeAddressesInSubnet, PolicyNotFound, ReplicationNotFound, SecurityGroupLimitExceeded, SecurityGroupNotFound, SubnetNotFound, ThroughputLimitExceeded, TooManyRequests, UnsupportedAvailabilityZone, ValidationException, } from "../models/models_0";
|
|
6
|
+
import { AccessPointAlreadyExists, AccessPointLimitExceeded, AccessPointNotFound, AvailabilityZonesMismatch, BadRequest, DependencyTimeout, FileSystemAlreadyExists, FileSystemInUse, FileSystemLimitExceeded, FileSystemNotFound, IncorrectFileSystemLifeCycleState, IncorrectMountTargetState, InsufficientThroughputCapacity, InternalServerError, InvalidPolicyException, IpAddressInUse, MountTargetConflict, MountTargetNotFound, NetworkInterfaceLimitExceeded, NoFreeAddressesInSubnet, PolicyNotFound, ReplicationNotFound, SecurityGroupLimitExceeded, SecurityGroupNotFound, SubnetNotFound, ThrottlingException, ThroughputLimitExceeded, TooManyRequests, UnsupportedAvailabilityZone, ValidationException, } from "../models/models_0";
|
|
7
7
|
export var serializeAws_restJson1CreateAccessPointCommand = function (input, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
8
8
|
var _a, hostname, _b, protocol, port, basePath, headers, resolvedPath, body;
|
|
9
9
|
var _c;
|
|
@@ -1033,8 +1033,10 @@ var deserializeAws_restJson1CreateAccessPointCommandError = function (output, co
|
|
|
1033
1033
|
case "com.amazonaws.efs#IncorrectFileSystemLifeCycleState": return [3, 10];
|
|
1034
1034
|
case "InternalServerError": return [3, 12];
|
|
1035
1035
|
case "com.amazonaws.efs#InternalServerError": return [3, 12];
|
|
1036
|
+
case "ThrottlingException": return [3, 14];
|
|
1037
|
+
case "com.amazonaws.efs#ThrottlingException": return [3, 14];
|
|
1036
1038
|
}
|
|
1037
|
-
return [3,
|
|
1039
|
+
return [3, 16];
|
|
1038
1040
|
case 2: return [4, deserializeAws_restJson1AccessPointAlreadyExistsResponse(parsedOutput, context)];
|
|
1039
1041
|
case 3: throw _d.sent();
|
|
1040
1042
|
case 4: return [4, deserializeAws_restJson1AccessPointLimitExceededResponse(parsedOutput, context)];
|
|
@@ -1047,7 +1049,9 @@ var deserializeAws_restJson1CreateAccessPointCommandError = function (output, co
|
|
|
1047
1049
|
case 11: throw _d.sent();
|
|
1048
1050
|
case 12: return [4, deserializeAws_restJson1InternalServerErrorResponse(parsedOutput, context)];
|
|
1049
1051
|
case 13: throw _d.sent();
|
|
1050
|
-
case 14:
|
|
1052
|
+
case 14: return [4, deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context)];
|
|
1053
|
+
case 15: throw _d.sent();
|
|
1054
|
+
case 16:
|
|
1051
1055
|
parsedBody = parsedOutput.body;
|
|
1052
1056
|
response = new __BaseException({
|
|
1053
1057
|
name: parsedBody.code || parsedBody.Code || errorCode,
|
|
@@ -3651,6 +3655,21 @@ var deserializeAws_restJson1SubnetNotFoundResponse = function (parsedOutput, con
|
|
|
3651
3655
|
return [2, __decorateServiceException(exception, parsedOutput.body)];
|
|
3652
3656
|
});
|
|
3653
3657
|
}); };
|
|
3658
|
+
var deserializeAws_restJson1ThrottlingExceptionResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
3659
|
+
var contents, data, exception;
|
|
3660
|
+
return __generator(this, function (_a) {
|
|
3661
|
+
contents = {};
|
|
3662
|
+
data = parsedOutput.body;
|
|
3663
|
+
if (data.ErrorCode !== undefined && data.ErrorCode !== null) {
|
|
3664
|
+
contents.ErrorCode = __expectString(data.ErrorCode);
|
|
3665
|
+
}
|
|
3666
|
+
if (data.Message !== undefined && data.Message !== null) {
|
|
3667
|
+
contents.Message = __expectString(data.Message);
|
|
3668
|
+
}
|
|
3669
|
+
exception = new ThrottlingException(__assign({ $metadata: deserializeMetadata(parsedOutput) }, contents));
|
|
3670
|
+
return [2, __decorateServiceException(exception, parsedOutput.body)];
|
|
3671
|
+
});
|
|
3672
|
+
}); };
|
|
3654
3673
|
var deserializeAws_restJson1ThroughputLimitExceededResponse = function (parsedOutput, context) { return __awaiter(void 0, void 0, void 0, function () {
|
|
3655
3674
|
var contents, data, exception;
|
|
3656
3675
|
return __generator(this, function (_a) {
|
package/dist-types/EFS.d.ts
CHANGED
|
@@ -32,10 +32,10 @@ import { UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput } from "./c
|
|
|
32
32
|
import { EFSClient } from "./EFSClient";
|
|
33
33
|
/**
|
|
34
34
|
* <fullname>Amazon Elastic File System</fullname>
|
|
35
|
-
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
|
|
36
|
-
* with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic,
|
|
37
|
-
*
|
|
38
|
-
*
|
|
35
|
+
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
|
|
36
|
+
* 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
|
|
37
|
+
* remove files, so that your applications have the storage they need, when they need it. For
|
|
38
|
+
* 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>
|
|
39
39
|
*/
|
|
40
40
|
export declare class EFS extends EFSClient {
|
|
41
41
|
/**
|
|
@@ -43,8 +43,8 @@ export declare class EFS extends EFSClient {
|
|
|
43
43
|
* file system that applies an operating system user and group, and a file system path, to any
|
|
44
44
|
* file system request made through the access point. The operating system user and group
|
|
45
45
|
* override any identity information provided by the NFS client. The file system path is exposed
|
|
46
|
-
* as the access point's root directory. Applications using the access point can only access data
|
|
47
|
-
*
|
|
46
|
+
* as the access point's root directory. Applications using the access point can only access data in
|
|
47
|
+
* the application's own directory and any subdirectories. 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
|
|
48
48
|
* points</a>.</p>
|
|
49
49
|
* <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>
|
|
50
50
|
*/
|
|
@@ -258,44 +258,50 @@ export declare class EFS extends EFSClient {
|
|
|
258
258
|
createMountTarget(args: CreateMountTargetCommandInput, cb: (err: any, data?: CreateMountTargetCommandOutput) => void): void;
|
|
259
259
|
createMountTarget(args: CreateMountTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMountTargetCommandOutput) => void): void;
|
|
260
260
|
/**
|
|
261
|
-
* <p>Creates a replication configuration that replicates an existing EFS file
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
261
|
+
* <p>Creates a replication configuration that replicates an existing EFS file system to a new,
|
|
262
|
+
* 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
|
|
263
|
+
* <i>Amazon EFS User Guide</i>. The replication configuration
|
|
264
|
+
* specifies the following:</p>
|
|
265
265
|
* <ul>
|
|
266
266
|
* <li>
|
|
267
267
|
* <p>
|
|
268
|
-
* <b>Source file system</b> -
|
|
269
|
-
*
|
|
270
|
-
*
|
|
268
|
+
* <b>Source file system</b> - An existing EFS file system that you
|
|
269
|
+
* want replicated. The source file system cannot be a destination file system in an existing
|
|
270
|
+
* replication configuration.</p>
|
|
271
271
|
* </li>
|
|
272
272
|
* <li>
|
|
273
273
|
* <p>
|
|
274
|
-
* <b>Destination file system configuration</b>
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
274
|
+
* <b>Destination file system configuration</b> - The configuration of
|
|
275
|
+
* the destination file system to which the source file system will be replicated. There can
|
|
276
|
+
* only be one destination file system in a replication configuration. The destination file
|
|
277
|
+
* system configuration consists of the following properties:</p>
|
|
278
278
|
* <ul>
|
|
279
279
|
* <li>
|
|
280
280
|
* <p>
|
|
281
|
-
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in
|
|
282
|
-
*
|
|
283
|
-
*
|
|
281
|
+
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in
|
|
282
|
+
* which the destination file system is created. Amazon EFS replication is
|
|
283
|
+
* available in all Amazon Web Services Regions that Amazon EFS is available in,
|
|
284
|
+
* except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe
|
|
285
|
+
* (Milan), and Middle East (Bahrain).</p>
|
|
284
286
|
* </li>
|
|
285
287
|
* <li>
|
|
286
288
|
* <p>
|
|
287
|
-
* <b>Availability
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
*
|
|
289
|
+
* <b>Availability Zone</b> - If you want the destination file system
|
|
290
|
+
* to use EFS One Zone availability and durability, you must specify the Availability
|
|
291
|
+
* Zone to create the file system in. For more information about EFS storage classes, see
|
|
292
|
+
* <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">
|
|
293
|
+
* Amazon EFS storage classes</a> in the <i>Amazon EFS User
|
|
294
|
+
* Guide</i>.</p>
|
|
291
295
|
* </li>
|
|
292
296
|
* <li>
|
|
293
297
|
* <p>
|
|
294
|
-
* <b>Encryption</b> - All destination file systems are
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
*
|
|
298
|
+
* <b>Encryption</b> - All destination file systems are created with
|
|
299
|
+
* encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't
|
|
300
|
+
* specify a KMS key, your service-managed KMS key for
|
|
301
|
+
* Amazon EFS is used. </p>
|
|
302
|
+
* <note>
|
|
303
|
+
* <p>After the file system is created, you cannot change the KMS key.</p>
|
|
304
|
+
* </note>
|
|
299
305
|
* </li>
|
|
300
306
|
* </ul>
|
|
301
307
|
* </li>
|
|
@@ -305,16 +311,16 @@ export declare class EFS extends EFSClient {
|
|
|
305
311
|
* <ul>
|
|
306
312
|
* <li>
|
|
307
313
|
* <p>
|
|
308
|
-
* <b>Performance mode</b> - The destination file system's
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
314
|
+
* <b>Performance mode</b> - The destination file system's performance
|
|
315
|
+
* mode matches that of the source file system, unless the destination file system uses EFS
|
|
316
|
+
* One Zone storage. In that case, the General Purpose performance mode is used. The
|
|
317
|
+
* performance mode cannot be changed.</p>
|
|
312
318
|
* </li>
|
|
313
319
|
* <li>
|
|
314
320
|
* <p>
|
|
315
|
-
* <b>Throughput mode</b> - The destination file system
|
|
316
|
-
*
|
|
317
|
-
*
|
|
321
|
+
* <b>Throughput mode</b> - The destination file system uses the
|
|
322
|
+
* Bursting Throughput mode by default. After the file system is created, you can modify the
|
|
323
|
+
* throughput mode.</p>
|
|
318
324
|
* </li>
|
|
319
325
|
* </ul>
|
|
320
326
|
*
|
|
@@ -322,18 +328,21 @@ export declare class EFS extends EFSClient {
|
|
|
322
328
|
* <ul>
|
|
323
329
|
* <li>
|
|
324
330
|
* <p>
|
|
325
|
-
* <b>Lifecycle management</b> - EFS lifecycle
|
|
326
|
-
*
|
|
327
|
-
*
|
|
331
|
+
* <b>Lifecycle management</b> - EFS lifecycle management and EFS
|
|
332
|
+
* Intelligent-Tiering are not enabled on the destination file system. After the destination
|
|
333
|
+
* file system is created, you can enable EFS lifecycle management and EFS
|
|
334
|
+
* Intelligent-Tiering.</p>
|
|
328
335
|
* </li>
|
|
329
336
|
* <li>
|
|
330
337
|
* <p>
|
|
331
|
-
* <b>Automatic backups</b> - Automatic daily backups
|
|
332
|
-
*
|
|
338
|
+
* <b>Automatic backups</b> - Automatic daily backups not enabled on
|
|
339
|
+
* the destination file system. After the file system is created, you can change this
|
|
340
|
+
* setting.</p>
|
|
333
341
|
* </li>
|
|
334
342
|
* </ul>
|
|
335
343
|
*
|
|
336
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a
|
|
344
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the
|
|
345
|
+
* <i>Amazon EFS User Guide</i>.</p>
|
|
337
346
|
*/
|
|
338
347
|
createReplicationConfiguration(args: CreateReplicationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateReplicationConfigurationCommandOutput>;
|
|
339
348
|
createReplicationConfiguration(args: CreateReplicationConfigurationCommandInput, cb: (err: any, data?: CreateReplicationConfigurationCommandOutput) => void): void;
|
|
@@ -342,8 +351,8 @@ export declare class EFS extends EFSClient {
|
|
|
342
351
|
* @deprecated
|
|
343
352
|
*
|
|
344
353
|
* <note>
|
|
345
|
-
* <p>DEPRECATED - CreateTags is deprecated and not maintained.
|
|
346
|
-
*
|
|
354
|
+
* <p>DEPRECATED - <code>CreateTags</code> is deprecated and not maintained. To create tags for EFS
|
|
355
|
+
* resources, use the API action.</p>
|
|
347
356
|
* </note>
|
|
348
357
|
* <p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If
|
|
349
358
|
* a tag key specified in the request already exists on the file system, this operation
|
|
@@ -368,6 +377,13 @@ export declare class EFS extends EFSClient {
|
|
|
368
377
|
* <p>Deletes a file system, permanently severing access to its contents. Upon return, the
|
|
369
378
|
* file system no longer exists and you can't access any contents of the deleted file
|
|
370
379
|
* system.</p>
|
|
380
|
+
* <p>You need to manually delete mount targets attached to a file system before you can delete
|
|
381
|
+
* an EFS file system. This step is performed for you when you use the Amazon Web Services console
|
|
382
|
+
* to delete a file system.</p>
|
|
383
|
+
* <note>
|
|
384
|
+
* <p>You cannot delete a file system that is part of an EFS Replication configuration.
|
|
385
|
+
* You need to delete the replication configuration first.</p>
|
|
386
|
+
* </note>
|
|
371
387
|
* <p> You can't delete a file system that is in use. That is, if the file system has
|
|
372
388
|
* any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p>
|
|
373
389
|
*
|
|
@@ -433,11 +449,12 @@ export declare class EFS extends EFSClient {
|
|
|
433
449
|
deleteMountTarget(args: DeleteMountTargetCommandInput, cb: (err: any, data?: DeleteMountTargetCommandOutput) => void): void;
|
|
434
450
|
deleteMountTarget(args: DeleteMountTargetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMountTargetCommandOutput) => void): void;
|
|
435
451
|
/**
|
|
436
|
-
* <p>Deletes an existing replication configuration.
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
* configuration
|
|
440
|
-
* system
|
|
452
|
+
* <p>Deletes an existing replication configuration. To delete a replication configuration, you
|
|
453
|
+
* must make the request from the Amazon Web Services Region in which the destination file system
|
|
454
|
+
* is located. Deleting a replication configuration ends the replication process. After a
|
|
455
|
+
* replication configuration is deleted, the destination file system is no longer read-only. You
|
|
456
|
+
* can write to the destination file system after its status becomes
|
|
457
|
+
* <code>Writeable</code>.</p>
|
|
441
458
|
*/
|
|
442
459
|
deleteReplicationConfiguration(args: DeleteReplicationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteReplicationConfigurationCommandOutput>;
|
|
443
460
|
deleteReplicationConfiguration(args: DeleteReplicationConfigurationCommandInput, cb: (err: any, data?: DeleteReplicationConfigurationCommandOutput) => void): void;
|
|
@@ -446,8 +463,8 @@ export declare class EFS extends EFSClient {
|
|
|
446
463
|
* @deprecated
|
|
447
464
|
*
|
|
448
465
|
* <note>
|
|
449
|
-
* <p>DEPRECATED - DeleteTags is deprecated and not maintained.
|
|
450
|
-
*
|
|
466
|
+
* <p>DEPRECATED - <code>DeleteTags</code> is deprecated and not maintained. To remove tags from EFS
|
|
467
|
+
* resources, use the API action.</p>
|
|
451
468
|
* </note>
|
|
452
469
|
* <p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request
|
|
453
470
|
* includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an
|
|
@@ -523,7 +540,8 @@ export declare class EFS extends EFSClient {
|
|
|
523
540
|
* to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system
|
|
524
541
|
* without a <code>LifecycleConfiguration</code> object, the call returns an empty array in the
|
|
525
542
|
* response.</p>
|
|
526
|
-
* <p>When EFS Intelligent
|
|
543
|
+
* <p>When EFS Intelligent-Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has
|
|
544
|
+
* a value of <code>AFTER_1_ACCESS</code>.</p>
|
|
527
545
|
* <p>This operation requires permissions for the
|
|
528
546
|
* <code>elasticfilesystem:DescribeLifecycleConfiguration</code> operation.</p>
|
|
529
547
|
*/
|
|
@@ -565,8 +583,9 @@ export declare class EFS extends EFSClient {
|
|
|
565
583
|
describeMountTargetSecurityGroups(args: DescribeMountTargetSecurityGroupsCommandInput, cb: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void): void;
|
|
566
584
|
describeMountTargetSecurityGroups(args: DescribeMountTargetSecurityGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMountTargetSecurityGroupsCommandOutput) => void): void;
|
|
567
585
|
/**
|
|
568
|
-
* <p>Retrieves the replication
|
|
569
|
-
*
|
|
586
|
+
* <p>Retrieves the replication configuration for a specific file system. If a file system is
|
|
587
|
+
* not specified, all of the replication configurations for the Amazon Web Services account in an
|
|
588
|
+
* Amazon Web Services Region are retrieved.</p>
|
|
570
589
|
*/
|
|
571
590
|
describeReplicationConfigurations(args: DescribeReplicationConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReplicationConfigurationsCommandOutput>;
|
|
572
591
|
describeReplicationConfigurations(args: DescribeReplicationConfigurationsCommandInput, cb: (err: any, data?: DescribeReplicationConfigurationsCommandOutput) => void): void;
|
|
@@ -575,8 +594,9 @@ export declare class EFS extends EFSClient {
|
|
|
575
594
|
* @deprecated
|
|
576
595
|
*
|
|
577
596
|
* <note>
|
|
578
|
-
* <p>DEPRECATED - The
|
|
579
|
-
*
|
|
597
|
+
* <p>DEPRECATED - The <code>DescribeTags</code> action is deprecated and not maintained. To view
|
|
598
|
+
* tags associated with EFS resources, use the <code>ListTagsForResource</code> API
|
|
599
|
+
* action.</p>
|
|
580
600
|
* </note>
|
|
581
601
|
* <p>Returns the tags associated with a file system. The order of tags returned in the
|
|
582
602
|
* response of one <code>DescribeTags</code> call and the order of tags returned across the
|
|
@@ -627,8 +647,9 @@ export declare class EFS extends EFSClient {
|
|
|
627
647
|
* opt-in period as EFS transitions to long resource IDs. For more information,
|
|
628
648
|
* see <a href="https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>.</p>
|
|
629
649
|
* <note>
|
|
630
|
-
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference
|
|
631
|
-
*
|
|
650
|
+
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference
|
|
651
|
+
* to use the short 8 character format resource ID. Contact Amazon Web Services support if you
|
|
652
|
+
* receive an error and must use short IDs for file system and mount target resources.</p>
|
|
632
653
|
* </note>
|
|
633
654
|
*/
|
|
634
655
|
putAccountPreferences(args: PutAccountPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<PutAccountPreferencesCommandOutput>;
|
|
@@ -658,38 +679,51 @@ export declare class EFS extends EFSClient {
|
|
|
658
679
|
putFileSystemPolicy(args: PutFileSystemPolicyCommandInput, cb: (err: any, data?: PutFileSystemPolicyCommandOutput) => void): void;
|
|
659
680
|
putFileSystemPolicy(args: PutFileSystemPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutFileSystemPolicyCommandOutput) => void): void;
|
|
660
681
|
/**
|
|
661
|
-
* <p>
|
|
662
|
-
*
|
|
663
|
-
*
|
|
664
|
-
*
|
|
665
|
-
*
|
|
682
|
+
* <p>Use this action to manage EFS lifecycle management and intelligent tiering. A
|
|
683
|
+
* <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code> objects that
|
|
684
|
+
* define the following:</p>
|
|
685
|
+
* <ul>
|
|
686
|
+
* <li>
|
|
687
|
+
* <p>
|
|
688
|
+
* <b>EFS Lifecycle management</b> - When Amazon EFS
|
|
689
|
+
* automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class.</p>
|
|
690
|
+
* <p>To enable EFS Lifecycle management, set the value of <code>TransitionToIA</code> to one of the available options.</p>
|
|
691
|
+
* </li>
|
|
692
|
+
* <li>
|
|
693
|
+
* <p>
|
|
694
|
+
* <b>EFS Intelligent tiering</b> - When Amazon EFS
|
|
695
|
+
* automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard.</p>
|
|
696
|
+
* <p>To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>.</p>
|
|
697
|
+
* </li>
|
|
698
|
+
* </ul>
|
|
666
699
|
*
|
|
700
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p>
|
|
667
701
|
* <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a
|
|
668
702
|
* <code>LifecycleConfiguration</code> object already exists for the specified file system, a
|
|
669
703
|
* <code>PutLifecycleConfiguration</code> call modifies the existing configuration. A
|
|
670
704
|
* <code>PutLifecycleConfiguration</code> call with an empty <code>LifecyclePolicies</code>
|
|
671
705
|
* array in the request body deletes any existing <code>LifecycleConfiguration</code> and
|
|
672
|
-
* turns off lifecycle management for the file system.</p>
|
|
673
|
-
*
|
|
674
|
-
*
|
|
706
|
+
* turns off lifecycle management and intelligent tiering for the file system.</p>
|
|
675
707
|
* <p>In the request, specify the following: </p>
|
|
676
708
|
* <ul>
|
|
677
709
|
* <li>
|
|
678
|
-
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management
|
|
710
|
+
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management
|
|
711
|
+
* and intelligent tiering.</p>
|
|
679
712
|
* </li>
|
|
680
713
|
* <li>
|
|
681
714
|
* <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that
|
|
682
|
-
* define when files are moved
|
|
715
|
+
* define when files are moved into IA storage, and when they are moved back to Standard storage.</p>
|
|
716
|
+
* <note>
|
|
717
|
+
* <p>Amazon EFS requires that each <code>LifecyclePolicy</code>
|
|
683
718
|
* object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate
|
|
684
719
|
* <code>LifecyclePolicy</code> objects. See the example requests in the following section for more information.</p>
|
|
720
|
+
* </note>
|
|
685
721
|
* </li>
|
|
686
722
|
* </ul>
|
|
687
723
|
*
|
|
688
|
-
* <p>This operation requires permissions for the
|
|
689
|
-
* <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p>
|
|
724
|
+
* <p>This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p>
|
|
690
725
|
* <p>To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you
|
|
691
|
-
* need the same Key Management Service permissions as when you created the encrypted
|
|
692
|
-
* file system. </p>
|
|
726
|
+
* need the same Key Management Service permissions as when you created the encrypted file system.</p>
|
|
693
727
|
*/
|
|
694
728
|
putLifecycleConfiguration(args: PutLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutLifecycleConfigurationCommandOutput>;
|
|
695
729
|
putLifecycleConfiguration(args: PutLifecycleConfigurationCommandInput, cb: (err: any, data?: PutLifecycleConfigurationCommandOutput) => void): void;
|
|
@@ -157,10 +157,10 @@ export interface EFSClientResolvedConfig extends EFSClientResolvedConfigType {
|
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
159
|
* <fullname>Amazon Elastic File System</fullname>
|
|
160
|
-
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
|
|
161
|
-
* with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic,
|
|
162
|
-
*
|
|
163
|
-
*
|
|
160
|
+
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for
|
|
161
|
+
* 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
|
|
162
|
+
* remove files, so that your applications have the storage they need, when they need it. For
|
|
163
|
+
* 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>
|
|
164
164
|
*/
|
|
165
165
|
export declare class EFSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, EFSClientResolvedConfig> {
|
|
166
166
|
/**
|
|
@@ -11,8 +11,8 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription,
|
|
|
11
11
|
* file system that applies an operating system user and group, and a file system path, to any
|
|
12
12
|
* file system request made through the access point. The operating system user and group
|
|
13
13
|
* override any identity information provided by the NFS client. The file system path is exposed
|
|
14
|
-
* as the access point's root directory. Applications using the access point can only access data
|
|
15
|
-
*
|
|
14
|
+
* as the access point's root directory. Applications using the access point can only access data in
|
|
15
|
+
* the application's own directory and any subdirectories. 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
|
|
16
16
|
* points</a>.</p>
|
|
17
17
|
* <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>
|
|
18
18
|
* @example
|