@aws-sdk/client-efs 3.295.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 +29 -29
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { EFSServiceException as __BaseException } from "./EFSServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Returned if the access point that you are trying to create already exists, with the
5
6
  * creation token you provided in the request.</p>
6
7
  */
@@ -26,6 +27,9 @@ export declare class AccessPointAlreadyExists extends __BaseException {
26
27
  */
27
28
  constructor(opts: __ExceptionOptionType<AccessPointAlreadyExists, __BaseException>);
28
29
  }
30
+ /**
31
+ * @public
32
+ */
29
33
  export declare enum LifeCycleState {
30
34
  AVAILABLE = "available",
31
35
  CREATING = "creating",
@@ -35,6 +39,7 @@ export declare enum LifeCycleState {
35
39
  UPDATING = "updating"
36
40
  }
37
41
  /**
42
+ * @public
38
43
  * <p>The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by
39
44
  * NFS clients using the access point.</p>
40
45
  */
@@ -53,6 +58,7 @@ export interface PosixUser {
53
58
  SecondaryGids?: number[];
54
59
  }
55
60
  /**
61
+ * @public
56
62
  * <p>Required if the <code>RootDirectory</code> > <code>Path</code> specified does not exist.
57
63
  * Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code> > <code>Path</code>.
58
64
  * If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point.
@@ -81,6 +87,7 @@ export interface CreationInfo {
81
87
  Permissions: string | undefined;
82
88
  }
83
89
  /**
90
+ * @public
84
91
  * <p>Specifies the directory on the Amazon EFS file system that the access point provides access to.
85
92
  * The access point exposes the specified file system path as
86
93
  * the root directory of your file system to applications using the access point.
@@ -107,6 +114,7 @@ export interface RootDirectory {
107
114
  CreationInfo?: CreationInfo;
108
115
  }
109
116
  /**
117
+ * @public
110
118
  * <p>A tag is a key-value pair. Allowed characters are letters, white space, and numbers that
111
119
  * can be represented in UTF-8, and the following characters:<code> + - = . _ : /</code>.</p>
112
120
  */
@@ -121,6 +129,7 @@ export interface Tag {
121
129
  Value: string | undefined;
122
130
  }
123
131
  /**
132
+ * @public
124
133
  * <p>Provides a description of an EFS file system access point.</p>
125
134
  */
126
135
  export interface AccessPointDescription {
@@ -167,6 +176,7 @@ export interface AccessPointDescription {
167
176
  LifeCycleState?: LifeCycleState | string;
168
177
  }
169
178
  /**
179
+ * @public
170
180
  * <p>Returned if the Amazon Web Services account has already created the maximum number of access points
171
181
  * allowed per file system. For more informaton, see <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region">https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region</a>.</p>
172
182
  */
@@ -192,6 +202,7 @@ export declare class AccessPointLimitExceeded extends __BaseException {
192
202
  constructor(opts: __ExceptionOptionType<AccessPointLimitExceeded, __BaseException>);
193
203
  }
194
204
  /**
205
+ * @public
195
206
  * <p>Returned if the specified <code>AccessPointId</code> value doesn't exist in the
196
207
  * requester's Amazon Web Services account.</p>
197
208
  */
@@ -217,6 +228,7 @@ export declare class AccessPointNotFound extends __BaseException {
217
228
  constructor(opts: __ExceptionOptionType<AccessPointNotFound, __BaseException>);
218
229
  }
219
230
  /**
231
+ * @public
220
232
  * <p>Returned if the Availability Zone that was specified for a mount target is
221
233
  * different from the Availability Zone that was specified for One Zone storage.
222
234
  * For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html">Regional and One Zone storage redundancy</a>.</p>
@@ -242,6 +254,9 @@ export declare class AvailabilityZonesMismatch extends __BaseException {
242
254
  */
243
255
  constructor(opts: __ExceptionOptionType<AvailabilityZonesMismatch, __BaseException>);
244
256
  }
257
+ /**
258
+ * @public
259
+ */
245
260
  export declare enum Status {
246
261
  DISABLED = "DISABLED",
247
262
  DISABLING = "DISABLING",
@@ -249,6 +264,7 @@ export declare enum Status {
249
264
  ENABLING = "ENABLING"
250
265
  }
251
266
  /**
267
+ * @public
252
268
  * <p>The backup policy for the file system used to create automatic daily backups. If status has a value of
253
269
  * <code>ENABLED</code>, the file system is being automatically backed up. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups">Automatic backups</a>.</p>
254
270
  */
@@ -285,6 +301,9 @@ export interface BackupPolicy {
285
301
  */
286
302
  Status: Status | string | undefined;
287
303
  }
304
+ /**
305
+ * @public
306
+ */
288
307
  export interface BackupPolicyDescription {
289
308
  /**
290
309
  * <p>Describes the file system's backup policy, indicating whether automatic backups are
@@ -293,6 +312,7 @@ export interface BackupPolicyDescription {
293
312
  BackupPolicy?: BackupPolicy;
294
313
  }
295
314
  /**
315
+ * @public
296
316
  * <p>Returned if the request is malformed or contains an error such as an invalid
297
317
  * parameter value or a missing required parameter.</p>
298
318
  */
@@ -317,6 +337,9 @@ export declare class BadRequest extends __BaseException {
317
337
  */
318
338
  constructor(opts: __ExceptionOptionType<BadRequest, __BaseException>);
319
339
  }
340
+ /**
341
+ * @public
342
+ */
320
343
  export interface CreateAccessPointRequest {
321
344
  /**
322
345
  * <p>A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
@@ -353,6 +376,7 @@ export interface CreateAccessPointRequest {
353
376
  RootDirectory?: RootDirectory;
354
377
  }
355
378
  /**
379
+ * @public
356
380
  * <p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the
357
381
  * requester's Amazon Web Services account.</p>
358
382
  */
@@ -378,6 +402,7 @@ export declare class FileSystemNotFound extends __BaseException {
378
402
  constructor(opts: __ExceptionOptionType<FileSystemNotFound, __BaseException>);
379
403
  }
380
404
  /**
405
+ * @public
381
406
  * <p>Returned if the file system's lifecycle state is not "available".</p>
382
407
  */
383
408
  export declare class IncorrectFileSystemLifeCycleState extends __BaseException {
@@ -402,6 +427,7 @@ export declare class IncorrectFileSystemLifeCycleState extends __BaseException {
402
427
  constructor(opts: __ExceptionOptionType<IncorrectFileSystemLifeCycleState, __BaseException>);
403
428
  }
404
429
  /**
430
+ * @public
405
431
  * <p>Returned if an error occurred on the server side.</p>
406
432
  */
407
433
  export declare class InternalServerError extends __BaseException {
@@ -426,6 +452,7 @@ export declare class InternalServerError extends __BaseException {
426
452
  constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
427
453
  }
428
454
  /**
455
+ * @public
429
456
  * <p>Returned when the <code>CreateAccessPoint</code> API action is called too quickly and
430
457
  * the number of Access Points on the file system is nearing the
431
458
  * <a href="https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region">limit of 120</a>.</p>
@@ -451,15 +478,24 @@ export declare class ThrottlingException extends __BaseException {
451
478
  */
452
479
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
453
480
  }
481
+ /**
482
+ * @public
483
+ */
454
484
  export declare enum PerformanceMode {
455
485
  GENERAL_PURPOSE = "generalPurpose",
456
486
  MAX_IO = "maxIO"
457
487
  }
488
+ /**
489
+ * @public
490
+ */
458
491
  export declare enum ThroughputMode {
459
492
  BURSTING = "bursting",
460
493
  ELASTIC = "elastic",
461
494
  PROVISIONED = "provisioned"
462
495
  }
496
+ /**
497
+ * @public
498
+ */
463
499
  export interface CreateFileSystemRequest {
464
500
  /**
465
501
  * <p>A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent
@@ -563,13 +599,14 @@ export interface CreateFileSystemRequest {
563
599
  /**
564
600
  * <p>Use to create one or more tags associated with the file system. Each
565
601
  * tag is a user-defined key-value pair. Name your file system on creation by including a
566
- * <code>"Key":"Name","Value":"{value}"</code> key-value pair. Each key must be unique. For more
602
+ * <code>"Key":"Name","Value":"\{value\}"</code> key-value pair. Each key must be unique. For more
567
603
  * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
568
604
  * in the <i>Amazon Web Services General Reference Guide</i>.</p>
569
605
  */
570
606
  Tags?: Tag[];
571
607
  }
572
608
  /**
609
+ * @public
573
610
  * <p>Returned if the file system you are trying to create already exists, with the
574
611
  * creation token you provided.</p>
575
612
  */
@@ -596,6 +633,7 @@ export declare class FileSystemAlreadyExists extends __BaseException {
596
633
  constructor(opts: __ExceptionOptionType<FileSystemAlreadyExists, __BaseException>);
597
634
  }
598
635
  /**
636
+ * @public
599
637
  * <p>The latest known metered size (in bytes) of data stored in the file system, in its
600
638
  * <code>Value</code> field, and the time at which that size was determined in its
601
639
  * <code>Timestamp</code> field. The value doesn't represent the size of a consistent
@@ -626,6 +664,7 @@ export interface FileSystemSize {
626
664
  ValueInStandard?: number;
627
665
  }
628
666
  /**
667
+ * @public
629
668
  * <p>A description of the file system.</p>
630
669
  */
631
670
  export interface FileSystemDescription {
@@ -723,6 +762,7 @@ export interface FileSystemDescription {
723
762
  Tags: Tag[] | undefined;
724
763
  }
725
764
  /**
765
+ * @public
726
766
  * <p>Returned if the Amazon Web Services account has already created the maximum number of file systems
727
767
  * allowed per account.</p>
728
768
  */
@@ -748,6 +788,7 @@ export declare class FileSystemLimitExceeded extends __BaseException {
748
788
  constructor(opts: __ExceptionOptionType<FileSystemLimitExceeded, __BaseException>);
749
789
  }
750
790
  /**
791
+ * @public
751
792
  * <p>Returned if there's not enough capacity to provision additional throughput. This value
752
793
  * might be returned when you try to create a file system in provisioned throughput mode,
753
794
  * when you attempt to increase the provisioned throughput of an existing file system, or
@@ -776,6 +817,7 @@ export declare class InsufficientThroughputCapacity extends __BaseException {
776
817
  constructor(opts: __ExceptionOptionType<InsufficientThroughputCapacity, __BaseException>);
777
818
  }
778
819
  /**
820
+ * @public
779
821
  * <p>Returned if the throughput mode or amount of provisioned throughput can't be changed
780
822
  * because the throughput limit of 1024 MiB/s has been reached.</p>
781
823
  */
@@ -801,6 +843,7 @@ export declare class ThroughputLimitExceeded extends __BaseException {
801
843
  constructor(opts: __ExceptionOptionType<ThroughputLimitExceeded, __BaseException>);
802
844
  }
803
845
  /**
846
+ * @public
804
847
  * <p>Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.</p>
805
848
  */
806
849
  export declare class UnsupportedAvailabilityZone extends __BaseException {
@@ -825,6 +868,7 @@ export declare class UnsupportedAvailabilityZone extends __BaseException {
825
868
  constructor(opts: __ExceptionOptionType<UnsupportedAvailabilityZone, __BaseException>);
826
869
  }
827
870
  /**
871
+ * @public
828
872
  * <p></p>
829
873
  */
830
874
  export interface CreateMountTargetRequest {
@@ -848,6 +892,7 @@ export interface CreateMountTargetRequest {
848
892
  SecurityGroups?: string[];
849
893
  }
850
894
  /**
895
+ * @public
851
896
  * <p>Returned if the request specified an <code>IpAddress</code> that is already in use
852
897
  * in the subnet.</p>
853
898
  */
@@ -873,6 +918,7 @@ export declare class IpAddressInUse extends __BaseException {
873
918
  constructor(opts: __ExceptionOptionType<IpAddressInUse, __BaseException>);
874
919
  }
875
920
  /**
921
+ * @public
876
922
  * <p>Returned if the mount target would violate one of the specified restrictions based
877
923
  * on the file system's existing mount targets.</p>
878
924
  */
@@ -898,6 +944,7 @@ export declare class MountTargetConflict extends __BaseException {
898
944
  constructor(opts: __ExceptionOptionType<MountTargetConflict, __BaseException>);
899
945
  }
900
946
  /**
947
+ * @public
901
948
  * <p>Provides a description of a mount target.</p>
902
949
  */
903
950
  export interface MountTargetDescription {
@@ -947,6 +994,7 @@ export interface MountTargetDescription {
947
994
  VpcId?: string;
948
995
  }
949
996
  /**
997
+ * @public
950
998
  * <p>The calling account has reached the limit for elastic network interfaces for the
951
999
  * specific Amazon Web Services Region. Either delete some network interfaces or request
952
1000
  * that the account quota be raised. For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html">Amazon VPC Quotas</a>
@@ -976,6 +1024,7 @@ export declare class NetworkInterfaceLimitExceeded extends __BaseException {
976
1024
  constructor(opts: __ExceptionOptionType<NetworkInterfaceLimitExceeded, __BaseException>);
977
1025
  }
978
1026
  /**
1027
+ * @public
979
1028
  * <p>Returned if <code>IpAddress</code> was not specified in the request and there are
980
1029
  * no free IP addresses in the subnet.</p>
981
1030
  */
@@ -1001,6 +1050,7 @@ export declare class NoFreeAddressesInSubnet extends __BaseException {
1001
1050
  constructor(opts: __ExceptionOptionType<NoFreeAddressesInSubnet, __BaseException>);
1002
1051
  }
1003
1052
  /**
1053
+ * @public
1004
1054
  * <p>Returned if the size of <code>SecurityGroups</code> specified in the request is
1005
1055
  * greater than five.</p>
1006
1056
  */
@@ -1026,6 +1076,7 @@ export declare class SecurityGroupLimitExceeded extends __BaseException {
1026
1076
  constructor(opts: __ExceptionOptionType<SecurityGroupLimitExceeded, __BaseException>);
1027
1077
  }
1028
1078
  /**
1079
+ * @public
1029
1080
  * <p>Returned if one of the specified security groups doesn't exist in the subnet's
1030
1081
  * virtual private cloud (VPC).</p>
1031
1082
  */
@@ -1051,6 +1102,7 @@ export declare class SecurityGroupNotFound extends __BaseException {
1051
1102
  constructor(opts: __ExceptionOptionType<SecurityGroupNotFound, __BaseException>);
1052
1103
  }
1053
1104
  /**
1105
+ * @public
1054
1106
  * <p>Returned if there is no subnet with ID <code>SubnetId</code> provided in the
1055
1107
  * request.</p>
1056
1108
  */
@@ -1076,6 +1128,7 @@ export declare class SubnetNotFound extends __BaseException {
1076
1128
  constructor(opts: __ExceptionOptionType<SubnetNotFound, __BaseException>);
1077
1129
  }
1078
1130
  /**
1131
+ * @public
1079
1132
  * <p>Describes the destination file system to create in the replication configuration.</p>
1080
1133
  */
1081
1134
  export interface DestinationToCreate {
@@ -1114,6 +1167,9 @@ export interface DestinationToCreate {
1114
1167
  */
1115
1168
  KmsKeyId?: string;
1116
1169
  }
1170
+ /**
1171
+ * @public
1172
+ */
1117
1173
  export interface CreateReplicationConfigurationRequest {
1118
1174
  /**
1119
1175
  * <p>Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be
@@ -1125,6 +1181,9 @@ export interface CreateReplicationConfigurationRequest {
1125
1181
  */
1126
1182
  Destinations: DestinationToCreate[] | undefined;
1127
1183
  }
1184
+ /**
1185
+ * @public
1186
+ */
1128
1187
  export declare enum ReplicationStatus {
1129
1188
  DELETING = "DELETING",
1130
1189
  ENABLED = "ENABLED",
@@ -1132,6 +1191,7 @@ export declare enum ReplicationStatus {
1132
1191
  ERROR = "ERROR"
1133
1192
  }
1134
1193
  /**
1194
+ * @public
1135
1195
  * <p>Describes the destination file system in the replication configuration.</p>
1136
1196
  */
1137
1197
  export interface Destination {
@@ -1158,6 +1218,9 @@ export interface Destination {
1158
1218
  */
1159
1219
  LastReplicatedTimestamp?: Date;
1160
1220
  }
1221
+ /**
1222
+ * @public
1223
+ */
1161
1224
  export interface ReplicationConfigurationDescription {
1162
1225
  /**
1163
1226
  * <p>The ID of the source Amazon EFS file system that is being replicated.</p>
@@ -1186,6 +1249,7 @@ export interface ReplicationConfigurationDescription {
1186
1249
  Destinations: Destination[] | undefined;
1187
1250
  }
1188
1251
  /**
1252
+ * @public
1189
1253
  * <p>Returned if the specified file system does not have a replication
1190
1254
  * configuration.</p>
1191
1255
  */
@@ -1210,6 +1274,7 @@ export declare class ReplicationNotFound extends __BaseException {
1210
1274
  constructor(opts: __ExceptionOptionType<ReplicationNotFound, __BaseException>);
1211
1275
  }
1212
1276
  /**
1277
+ * @public
1213
1278
  * <p>Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.</p>
1214
1279
  */
1215
1280
  export declare class ValidationException extends __BaseException {
@@ -1234,6 +1299,7 @@ export declare class ValidationException extends __BaseException {
1234
1299
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
1235
1300
  }
1236
1301
  /**
1302
+ * @public
1237
1303
  * <p></p>
1238
1304
  */
1239
1305
  export interface CreateTagsRequest {
@@ -1248,6 +1314,9 @@ export interface CreateTagsRequest {
1248
1314
  */
1249
1315
  Tags: Tag[] | undefined;
1250
1316
  }
1317
+ /**
1318
+ * @public
1319
+ */
1251
1320
  export interface DeleteAccessPointRequest {
1252
1321
  /**
1253
1322
  * <p>The ID of the access point that you want to delete.</p>
@@ -1255,6 +1324,7 @@ export interface DeleteAccessPointRequest {
1255
1324
  AccessPointId: string | undefined;
1256
1325
  }
1257
1326
  /**
1327
+ * @public
1258
1328
  * <p></p>
1259
1329
  */
1260
1330
  export interface DeleteFileSystemRequest {
@@ -1264,6 +1334,7 @@ export interface DeleteFileSystemRequest {
1264
1334
  FileSystemId: string | undefined;
1265
1335
  }
1266
1336
  /**
1337
+ * @public
1267
1338
  * <p>Returned if a file system has mount targets.</p>
1268
1339
  */
1269
1340
  export declare class FileSystemInUse extends __BaseException {
@@ -1287,6 +1358,9 @@ export declare class FileSystemInUse extends __BaseException {
1287
1358
  */
1288
1359
  constructor(opts: __ExceptionOptionType<FileSystemInUse, __BaseException>);
1289
1360
  }
1361
+ /**
1362
+ * @public
1363
+ */
1290
1364
  export interface DeleteFileSystemPolicyRequest {
1291
1365
  /**
1292
1366
  * <p>Specifies the EFS file system for which to delete the <code>FileSystemPolicy</code>.</p>
@@ -1294,6 +1368,7 @@ export interface DeleteFileSystemPolicyRequest {
1294
1368
  FileSystemId: string | undefined;
1295
1369
  }
1296
1370
  /**
1371
+ * @public
1297
1372
  * <p></p>
1298
1373
  */
1299
1374
  export interface DeleteMountTargetRequest {
@@ -1303,6 +1378,7 @@ export interface DeleteMountTargetRequest {
1303
1378
  MountTargetId: string | undefined;
1304
1379
  }
1305
1380
  /**
1381
+ * @public
1306
1382
  * <p>The service timed out trying to fulfill the request, and the client should try the
1307
1383
  * call again.</p>
1308
1384
  */
@@ -1328,6 +1404,7 @@ export declare class DependencyTimeout extends __BaseException {
1328
1404
  constructor(opts: __ExceptionOptionType<DependencyTimeout, __BaseException>);
1329
1405
  }
1330
1406
  /**
1407
+ * @public
1331
1408
  * <p>Returned if there is no mount target with the specified ID found in the
1332
1409
  * caller's Amazon Web Services account.</p>
1333
1410
  */
@@ -1352,6 +1429,9 @@ export declare class MountTargetNotFound extends __BaseException {
1352
1429
  */
1353
1430
  constructor(opts: __ExceptionOptionType<MountTargetNotFound, __BaseException>);
1354
1431
  }
1432
+ /**
1433
+ * @public
1434
+ */
1355
1435
  export interface DeleteReplicationConfigurationRequest {
1356
1436
  /**
1357
1437
  * <p>The ID of the source file system in the replication configuration.</p>
@@ -1359,6 +1439,7 @@ export interface DeleteReplicationConfigurationRequest {
1359
1439
  SourceFileSystemId: string | undefined;
1360
1440
  }
1361
1441
  /**
1442
+ * @public
1362
1443
  * <p></p>
1363
1444
  */
1364
1445
  export interface DeleteTagsRequest {
@@ -1371,6 +1452,9 @@ export interface DeleteTagsRequest {
1371
1452
  */
1372
1453
  TagKeys: string[] | undefined;
1373
1454
  }
1455
+ /**
1456
+ * @public
1457
+ */
1374
1458
  export interface DescribeAccessPointsRequest {
1375
1459
  /**
1376
1460
  * <p>(Optional) When retrieving all access points for a file system,
@@ -1393,6 +1477,9 @@ export interface DescribeAccessPointsRequest {
1393
1477
  */
1394
1478
  FileSystemId?: string;
1395
1479
  }
1480
+ /**
1481
+ * @public
1482
+ */
1396
1483
  export interface DescribeAccessPointsResponse {
1397
1484
  /**
1398
1485
  * <p>An array of access point descriptions.</p>
@@ -1404,6 +1491,9 @@ export interface DescribeAccessPointsResponse {
1404
1491
  */
1405
1492
  NextToken?: string;
1406
1493
  }
1494
+ /**
1495
+ * @public
1496
+ */
1407
1497
  export interface DescribeAccountPreferencesRequest {
1408
1498
  /**
1409
1499
  * <p>(Optional) You can use <code>NextToken</code> in a subsequent request to fetch the next page of
@@ -1417,15 +1507,22 @@ export interface DescribeAccountPreferencesRequest {
1417
1507
  */
1418
1508
  MaxResults?: number;
1419
1509
  }
1510
+ /**
1511
+ * @public
1512
+ */
1420
1513
  export declare enum ResourceIdType {
1421
1514
  LongId = "LONG_ID",
1422
1515
  ShortId = "SHORT_ID"
1423
1516
  }
1517
+ /**
1518
+ * @public
1519
+ */
1424
1520
  export declare enum Resource {
1425
1521
  FileSystem = "FILE_SYSTEM",
1426
1522
  MountTarget = "MOUNT_TARGET"
1427
1523
  }
1428
1524
  /**
1525
+ * @public
1429
1526
  * <p>Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.</p>
1430
1527
  */
1431
1528
  export interface ResourceIdPreference {
@@ -1438,6 +1535,9 @@ export interface ResourceIdPreference {
1438
1535
  */
1439
1536
  Resources?: (Resource | string)[];
1440
1537
  }
1538
+ /**
1539
+ * @public
1540
+ */
1441
1541
  export interface DescribeAccountPreferencesResponse {
1442
1542
  /**
1443
1543
  * <p>Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.</p>
@@ -1449,6 +1549,9 @@ export interface DescribeAccountPreferencesResponse {
1449
1549
  */
1450
1550
  NextToken?: string;
1451
1551
  }
1552
+ /**
1553
+ * @public
1554
+ */
1452
1555
  export interface DescribeBackupPolicyRequest {
1453
1556
  /**
1454
1557
  * <p>Specifies which EFS file system to retrieve the <code>BackupPolicy</code> for.</p>
@@ -1456,6 +1559,7 @@ export interface DescribeBackupPolicyRequest {
1456
1559
  FileSystemId: string | undefined;
1457
1560
  }
1458
1561
  /**
1562
+ * @public
1459
1563
  * <p>Returned if the default file system policy is in effect for the EFS file system specified.</p>
1460
1564
  */
1461
1565
  export declare class PolicyNotFound extends __BaseException {
@@ -1479,12 +1583,18 @@ export declare class PolicyNotFound extends __BaseException {
1479
1583
  */
1480
1584
  constructor(opts: __ExceptionOptionType<PolicyNotFound, __BaseException>);
1481
1585
  }
1586
+ /**
1587
+ * @public
1588
+ */
1482
1589
  export interface DescribeFileSystemPolicyRequest {
1483
1590
  /**
1484
1591
  * <p>Specifies which EFS file system to retrieve the <code>FileSystemPolicy</code> for.</p>
1485
1592
  */
1486
1593
  FileSystemId: string | undefined;
1487
1594
  }
1595
+ /**
1596
+ * @public
1597
+ */
1488
1598
  export interface FileSystemPolicyDescription {
1489
1599
  /**
1490
1600
  * <p>Specifies the EFS file system to which the <code>FileSystemPolicy</code> applies.</p>
@@ -1496,6 +1606,7 @@ export interface FileSystemPolicyDescription {
1496
1606
  Policy?: string;
1497
1607
  }
1498
1608
  /**
1609
+ * @public
1499
1610
  * <p></p>
1500
1611
  */
1501
1612
  export interface DescribeFileSystemsRequest {
@@ -1522,6 +1633,9 @@ export interface DescribeFileSystemsRequest {
1522
1633
  */
1523
1634
  FileSystemId?: string;
1524
1635
  }
1636
+ /**
1637
+ * @public
1638
+ */
1525
1639
  export interface DescribeFileSystemsResponse {
1526
1640
  /**
1527
1641
  * <p>Present if provided by caller in the request (String).</p>
@@ -1537,6 +1651,9 @@ export interface DescribeFileSystemsResponse {
1537
1651
  */
1538
1652
  NextMarker?: string;
1539
1653
  }
1654
+ /**
1655
+ * @public
1656
+ */
1540
1657
  export interface DescribeLifecycleConfigurationRequest {
1541
1658
  /**
1542
1659
  * <p>The ID of the file system whose <code>LifecycleConfiguration</code> object you want to
@@ -1544,6 +1661,9 @@ export interface DescribeLifecycleConfigurationRequest {
1544
1661
  */
1545
1662
  FileSystemId: string | undefined;
1546
1663
  }
1664
+ /**
1665
+ * @public
1666
+ */
1547
1667
  export declare enum TransitionToIARules {
1548
1668
  AFTER_14_DAYS = "AFTER_14_DAYS",
1549
1669
  AFTER_1_DAY = "AFTER_1_DAY",
@@ -1552,10 +1672,14 @@ export declare enum TransitionToIARules {
1552
1672
  AFTER_7_DAYS = "AFTER_7_DAYS",
1553
1673
  AFTER_90_DAYS = "AFTER_90_DAYS"
1554
1674
  }
1675
+ /**
1676
+ * @public
1677
+ */
1555
1678
  export declare enum TransitionToPrimaryStorageClassRules {
1556
1679
  AFTER_1_ACCESS = "AFTER_1_ACCESS"
1557
1680
  }
1558
1681
  /**
1682
+ * @public
1559
1683
  * <p>Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that
1560
1684
  * specifies when to transition files into and out of the file system's Infrequent Access (IA)
1561
1685
  * storage class. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Intelligent‐Tiering and EFS Lifecycle
@@ -1585,6 +1709,9 @@ export interface LifecyclePolicy {
1585
1709
  */
1586
1710
  TransitionToPrimaryStorageClass?: TransitionToPrimaryStorageClassRules | string;
1587
1711
  }
1712
+ /**
1713
+ * @public
1714
+ */
1588
1715
  export interface LifecycleConfigurationDescription {
1589
1716
  /**
1590
1717
  * <p>An array of lifecycle management policies. EFS supports a maximum of one
@@ -1593,6 +1720,7 @@ export interface LifecycleConfigurationDescription {
1593
1720
  LifecyclePolicies?: LifecyclePolicy[];
1594
1721
  }
1595
1722
  /**
1723
+ * @public
1596
1724
  * <p></p>
1597
1725
  */
1598
1726
  export interface DescribeMountTargetsRequest {
@@ -1625,6 +1753,7 @@ export interface DescribeMountTargetsRequest {
1625
1753
  AccessPointId?: string;
1626
1754
  }
1627
1755
  /**
1756
+ * @public
1628
1757
  * <p></p>
1629
1758
  */
1630
1759
  export interface DescribeMountTargetsResponse {
@@ -1646,6 +1775,7 @@ export interface DescribeMountTargetsResponse {
1646
1775
  NextMarker?: string;
1647
1776
  }
1648
1777
  /**
1778
+ * @public
1649
1779
  * <p></p>
1650
1780
  */
1651
1781
  export interface DescribeMountTargetSecurityGroupsRequest {
@@ -1654,6 +1784,9 @@ export interface DescribeMountTargetSecurityGroupsRequest {
1654
1784
  */
1655
1785
  MountTargetId: string | undefined;
1656
1786
  }
1787
+ /**
1788
+ * @public
1789
+ */
1657
1790
  export interface DescribeMountTargetSecurityGroupsResponse {
1658
1791
  /**
1659
1792
  * <p>An array of security groups.</p>
@@ -1661,6 +1794,7 @@ export interface DescribeMountTargetSecurityGroupsResponse {
1661
1794
  SecurityGroups: string[] | undefined;
1662
1795
  }
1663
1796
  /**
1797
+ * @public
1664
1798
  * <p>Returned if the mount target is not in the correct state for the
1665
1799
  * operation.</p>
1666
1800
  */
@@ -1685,6 +1819,9 @@ export declare class IncorrectMountTargetState extends __BaseException {
1685
1819
  */
1686
1820
  constructor(opts: __ExceptionOptionType<IncorrectMountTargetState, __BaseException>);
1687
1821
  }
1822
+ /**
1823
+ * @public
1824
+ */
1688
1825
  export interface DescribeReplicationConfigurationsRequest {
1689
1826
  /**
1690
1827
  * <p>You can retrieve the replication configuration for a specific file system by providing its
@@ -1704,6 +1841,9 @@ export interface DescribeReplicationConfigurationsRequest {
1704
1841
  */
1705
1842
  MaxResults?: number;
1706
1843
  }
1844
+ /**
1845
+ * @public
1846
+ */
1707
1847
  export interface DescribeReplicationConfigurationsResponse {
1708
1848
  /**
1709
1849
  * <p>The collection of replication configurations that is returned.</p>
@@ -1716,6 +1856,7 @@ export interface DescribeReplicationConfigurationsResponse {
1716
1856
  NextToken?: string;
1717
1857
  }
1718
1858
  /**
1859
+ * @public
1719
1860
  * <p></p>
1720
1861
  */
1721
1862
  export interface DescribeTagsRequest {
@@ -1737,6 +1878,7 @@ export interface DescribeTagsRequest {
1737
1878
  FileSystemId: string | undefined;
1738
1879
  }
1739
1880
  /**
1881
+ * @public
1740
1882
  * <p></p>
1741
1883
  */
1742
1884
  export interface DescribeTagsResponse {
@@ -1758,6 +1900,7 @@ export interface DescribeTagsResponse {
1758
1900
  NextMarker?: string;
1759
1901
  }
1760
1902
  /**
1903
+ * @public
1761
1904
  * <p>Returned if the <code>FileSystemPolicy</code> is malformed or contains an error such
1762
1905
  * as a parameter value that is not valid or a missing required parameter. Returned in the
1763
1906
  * case of a policy lockout safety check error.</p>
@@ -1783,6 +1926,9 @@ export declare class InvalidPolicyException extends __BaseException {
1783
1926
  */
1784
1927
  constructor(opts: __ExceptionOptionType<InvalidPolicyException, __BaseException>);
1785
1928
  }
1929
+ /**
1930
+ * @public
1931
+ */
1786
1932
  export interface ListTagsForResourceRequest {
1787
1933
  /**
1788
1934
  * <p>Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.</p>
@@ -1797,6 +1943,9 @@ export interface ListTagsForResourceRequest {
1797
1943
  */
1798
1944
  NextToken?: string;
1799
1945
  }
1946
+ /**
1947
+ * @public
1948
+ */
1800
1949
  export interface ListTagsForResourceResponse {
1801
1950
  /**
1802
1951
  * <p>An array of the tags for the specified EFS resource.</p>
@@ -1809,6 +1958,7 @@ export interface ListTagsForResourceResponse {
1809
1958
  NextToken?: string;
1810
1959
  }
1811
1960
  /**
1961
+ * @public
1812
1962
  * <p></p>
1813
1963
  */
1814
1964
  export interface ModifyMountTargetSecurityGroupsRequest {
@@ -1821,6 +1971,9 @@ export interface ModifyMountTargetSecurityGroupsRequest {
1821
1971
  */
1822
1972
  SecurityGroups?: string[];
1823
1973
  }
1974
+ /**
1975
+ * @public
1976
+ */
1824
1977
  export interface PutAccountPreferencesRequest {
1825
1978
  /**
1826
1979
  * <p>Specifies the EFS resource ID preference to set for the user's Amazon Web Services account,
@@ -1834,12 +1987,18 @@ export interface PutAccountPreferencesRequest {
1834
1987
  */
1835
1988
  ResourceIdType: ResourceIdType | string | undefined;
1836
1989
  }
1990
+ /**
1991
+ * @public
1992
+ */
1837
1993
  export interface PutAccountPreferencesResponse {
1838
1994
  /**
1839
1995
  * <p>Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.</p>
1840
1996
  */
1841
1997
  ResourceIdPreference?: ResourceIdPreference;
1842
1998
  }
1999
+ /**
2000
+ * @public
2001
+ */
1843
2002
  export interface PutBackupPolicyRequest {
1844
2003
  /**
1845
2004
  * <p>Specifies which EFS file system to update the backup policy for.</p>
@@ -1850,6 +2009,9 @@ export interface PutBackupPolicyRequest {
1850
2009
  */
1851
2010
  BackupPolicy: BackupPolicy | undefined;
1852
2011
  }
2012
+ /**
2013
+ * @public
2014
+ */
1853
2015
  export interface PutFileSystemPolicyRequest {
1854
2016
  /**
1855
2017
  * <p>The ID of the EFS file system that you want to create or update the <code>FileSystemPolicy</code> for.</p>
@@ -1873,6 +2035,9 @@ export interface PutFileSystemPolicyRequest {
1873
2035
  */
1874
2036
  BypassPolicyLockoutSafetyCheck?: boolean;
1875
2037
  }
2038
+ /**
2039
+ * @public
2040
+ */
1876
2041
  export interface PutLifecycleConfigurationRequest {
1877
2042
  /**
1878
2043
  * <p>The ID of the file system for which you are creating the
@@ -1903,6 +2068,9 @@ export interface PutLifecycleConfigurationRequest {
1903
2068
  */
1904
2069
  LifecyclePolicies: LifecyclePolicy[] | undefined;
1905
2070
  }
2071
+ /**
2072
+ * @public
2073
+ */
1906
2074
  export interface TagResourceRequest {
1907
2075
  /**
1908
2076
  * <p>The ID specifying the EFS resource that you want to create a tag for.</p>
@@ -1914,6 +2082,9 @@ export interface TagResourceRequest {
1914
2082
  */
1915
2083
  Tags: Tag[] | undefined;
1916
2084
  }
2085
+ /**
2086
+ * @public
2087
+ */
1917
2088
  export interface UntagResourceRequest {
1918
2089
  /**
1919
2090
  * <p>Specifies the EFS resource that you want to remove tags from.</p>
@@ -1926,6 +2097,7 @@ export interface UntagResourceRequest {
1926
2097
  TagKeys: string[] | undefined;
1927
2098
  }
1928
2099
  /**
2100
+ * @public
1929
2101
  * <p>Returned if you don’t wait at least 24 hours before either changing the throughput mode, or
1930
2102
  * decreasing the Provisioned Throughput value.</p>
1931
2103
  */
@@ -1950,6 +2122,9 @@ export declare class TooManyRequests extends __BaseException {
1950
2122
  */
1951
2123
  constructor(opts: __ExceptionOptionType<TooManyRequests, __BaseException>);
1952
2124
  }
2125
+ /**
2126
+ * @public
2127
+ */
1953
2128
  export interface UpdateFileSystemRequest {
1954
2129
  /**
1955
2130
  * <p>The ID of the file system that you want to update.</p>