@aws-sdk/client-efs 3.379.1 → 3.385.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/dist-types/models/models_0.d.ts +226 -0
- package/package.json +5 -5
|
@@ -9,11 +9,13 @@ export declare class AccessPointAlreadyExists extends __BaseException {
|
|
|
9
9
|
readonly name: "AccessPointAlreadyExists";
|
|
10
10
|
readonly $fault: "client";
|
|
11
11
|
/**
|
|
12
|
+
* @public
|
|
12
13
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
13
14
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
14
15
|
*/
|
|
15
16
|
ErrorCode: string | undefined;
|
|
16
17
|
/**
|
|
18
|
+
* @public
|
|
17
19
|
* <p>The error message contains a generic description of the error
|
|
18
20
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
19
21
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -50,14 +52,17 @@ export type LifeCycleState = (typeof LifeCycleState)[keyof typeof LifeCycleState
|
|
|
50
52
|
*/
|
|
51
53
|
export interface PosixUser {
|
|
52
54
|
/**
|
|
55
|
+
* @public
|
|
53
56
|
* <p>The POSIX user ID used for all file system operations using this access point.</p>
|
|
54
57
|
*/
|
|
55
58
|
Uid: number | undefined;
|
|
56
59
|
/**
|
|
60
|
+
* @public
|
|
57
61
|
* <p>The POSIX group ID used for all file system operations using this access point.</p>
|
|
58
62
|
*/
|
|
59
63
|
Gid: number | undefined;
|
|
60
64
|
/**
|
|
65
|
+
* @public
|
|
61
66
|
* <p>Secondary POSIX group IDs used for all file system operations using this access point.</p>
|
|
62
67
|
*/
|
|
63
68
|
SecondaryGids?: number[];
|
|
@@ -79,14 +84,17 @@ export interface PosixUser {
|
|
|
79
84
|
*/
|
|
80
85
|
export interface CreationInfo {
|
|
81
86
|
/**
|
|
87
|
+
* @public
|
|
82
88
|
* <p>Specifies the POSIX user ID to apply to the <code>RootDirectory</code>. Accepts values from 0 to 2^32 (4294967295).</p>
|
|
83
89
|
*/
|
|
84
90
|
OwnerUid: number | undefined;
|
|
85
91
|
/**
|
|
92
|
+
* @public
|
|
86
93
|
* <p>Specifies the POSIX group ID to apply to the <code>RootDirectory</code>. Accepts values from 0 to 2^32 (4294967295).</p>
|
|
87
94
|
*/
|
|
88
95
|
OwnerGid: number | undefined;
|
|
89
96
|
/**
|
|
97
|
+
* @public
|
|
90
98
|
* <p>Specifies the POSIX permissions to apply to the <code>RootDirectory</code>, in the format of an octal number representing the file's mode bits.</p>
|
|
91
99
|
*/
|
|
92
100
|
Permissions: string | undefined;
|
|
@@ -100,12 +108,14 @@ export interface CreationInfo {
|
|
|
100
108
|
*/
|
|
101
109
|
export interface RootDirectory {
|
|
102
110
|
/**
|
|
111
|
+
* @public
|
|
103
112
|
* <p>Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.
|
|
104
113
|
* A path can have up to four subdirectories.
|
|
105
114
|
* If the specified path does not exist, you are required to provide the <code>CreationInfo</code>.</p>
|
|
106
115
|
*/
|
|
107
116
|
Path?: string;
|
|
108
117
|
/**
|
|
118
|
+
* @public
|
|
109
119
|
* <p>(Optional) Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code>.
|
|
110
120
|
* If the <code>RootDirectory</code> > <code>Path</code> specified does not exist,
|
|
111
121
|
* EFS creates the root directory using the <code>CreationInfo</code> settings when a client connects to an access point.
|
|
@@ -125,10 +135,12 @@ export interface RootDirectory {
|
|
|
125
135
|
*/
|
|
126
136
|
export interface Tag {
|
|
127
137
|
/**
|
|
138
|
+
* @public
|
|
128
139
|
* <p>The tag key (String). The key can't start with <code>aws:</code>.</p>
|
|
129
140
|
*/
|
|
130
141
|
Key: string | undefined;
|
|
131
142
|
/**
|
|
143
|
+
* @public
|
|
132
144
|
* <p>The value of the tag key.</p>
|
|
133
145
|
*/
|
|
134
146
|
Value: string | undefined;
|
|
@@ -139,43 +151,53 @@ export interface Tag {
|
|
|
139
151
|
*/
|
|
140
152
|
export interface AccessPointDescription {
|
|
141
153
|
/**
|
|
154
|
+
* @public
|
|
142
155
|
* <p>The opaque string specified in the request to ensure idempotent creation.</p>
|
|
143
156
|
*/
|
|
144
157
|
ClientToken?: string;
|
|
145
158
|
/**
|
|
159
|
+
* @public
|
|
146
160
|
* <p>The name of the access point. This is the value of the <code>Name</code> tag.</p>
|
|
147
161
|
*/
|
|
148
162
|
Name?: string;
|
|
149
163
|
/**
|
|
164
|
+
* @public
|
|
150
165
|
* <p>The tags associated with the access point, presented as an array of Tag objects.</p>
|
|
151
166
|
*/
|
|
152
167
|
Tags?: Tag[];
|
|
153
168
|
/**
|
|
169
|
+
* @public
|
|
154
170
|
* <p>The ID of the access point, assigned by Amazon EFS.</p>
|
|
155
171
|
*/
|
|
156
172
|
AccessPointId?: string;
|
|
157
173
|
/**
|
|
174
|
+
* @public
|
|
158
175
|
* <p>The unique Amazon Resource Name (ARN) associated with the access point.</p>
|
|
159
176
|
*/
|
|
160
177
|
AccessPointArn?: string;
|
|
161
178
|
/**
|
|
179
|
+
* @public
|
|
162
180
|
* <p>The ID of the EFS file system that the access point applies to.</p>
|
|
163
181
|
*/
|
|
164
182
|
FileSystemId?: string;
|
|
165
183
|
/**
|
|
184
|
+
* @public
|
|
166
185
|
* <p>The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by
|
|
167
186
|
* NFS clients using the access point.</p>
|
|
168
187
|
*/
|
|
169
188
|
PosixUser?: PosixUser;
|
|
170
189
|
/**
|
|
190
|
+
* @public
|
|
171
191
|
* <p>The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.</p>
|
|
172
192
|
*/
|
|
173
193
|
RootDirectory?: RootDirectory;
|
|
174
194
|
/**
|
|
195
|
+
* @public
|
|
175
196
|
* <p>Identifies the Amazon Web Services account that owns the access point resource.</p>
|
|
176
197
|
*/
|
|
177
198
|
OwnerId?: string;
|
|
178
199
|
/**
|
|
200
|
+
* @public
|
|
179
201
|
* <p>Identifies the lifecycle phase of the access point.</p>
|
|
180
202
|
*/
|
|
181
203
|
LifeCycleState?: LifeCycleState | string;
|
|
@@ -189,11 +211,13 @@ export declare class AccessPointLimitExceeded extends __BaseException {
|
|
|
189
211
|
readonly name: "AccessPointLimitExceeded";
|
|
190
212
|
readonly $fault: "client";
|
|
191
213
|
/**
|
|
214
|
+
* @public
|
|
192
215
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
193
216
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
194
217
|
*/
|
|
195
218
|
ErrorCode: string | undefined;
|
|
196
219
|
/**
|
|
220
|
+
* @public
|
|
197
221
|
* <p>The error message contains a generic description of the error
|
|
198
222
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
199
223
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -215,11 +239,13 @@ export declare class AccessPointNotFound extends __BaseException {
|
|
|
215
239
|
readonly name: "AccessPointNotFound";
|
|
216
240
|
readonly $fault: "client";
|
|
217
241
|
/**
|
|
242
|
+
* @public
|
|
218
243
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
219
244
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
220
245
|
*/
|
|
221
246
|
ErrorCode: string | undefined;
|
|
222
247
|
/**
|
|
248
|
+
* @public
|
|
223
249
|
* <p>The error message contains a generic description of the error
|
|
224
250
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
225
251
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -242,11 +268,13 @@ export declare class AvailabilityZonesMismatch extends __BaseException {
|
|
|
242
268
|
readonly name: "AvailabilityZonesMismatch";
|
|
243
269
|
readonly $fault: "client";
|
|
244
270
|
/**
|
|
271
|
+
* @public
|
|
245
272
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
246
273
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
247
274
|
*/
|
|
248
275
|
ErrorCode?: string;
|
|
249
276
|
/**
|
|
277
|
+
* @public
|
|
250
278
|
* <p>The error message contains a generic description of the error
|
|
251
279
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
252
280
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -280,6 +308,7 @@ export type Status = (typeof Status)[keyof typeof Status];
|
|
|
280
308
|
*/
|
|
281
309
|
export interface BackupPolicy {
|
|
282
310
|
/**
|
|
311
|
+
* @public
|
|
283
312
|
* <p>Describes the status of the file system's backup policy.</p>
|
|
284
313
|
* <ul>
|
|
285
314
|
* <li>
|
|
@@ -316,6 +345,7 @@ export interface BackupPolicy {
|
|
|
316
345
|
*/
|
|
317
346
|
export interface BackupPolicyDescription {
|
|
318
347
|
/**
|
|
348
|
+
* @public
|
|
319
349
|
* <p>Describes the file system's backup policy, indicating whether automatic backups are
|
|
320
350
|
* turned on or off.</p>
|
|
321
351
|
*/
|
|
@@ -330,11 +360,13 @@ export declare class BadRequest extends __BaseException {
|
|
|
330
360
|
readonly name: "BadRequest";
|
|
331
361
|
readonly $fault: "client";
|
|
332
362
|
/**
|
|
363
|
+
* @public
|
|
333
364
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
334
365
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
335
366
|
*/
|
|
336
367
|
ErrorCode: string | undefined;
|
|
337
368
|
/**
|
|
369
|
+
* @public
|
|
338
370
|
* <p>The error message contains a generic description of the error
|
|
339
371
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
340
372
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -352,26 +384,31 @@ export declare class BadRequest extends __BaseException {
|
|
|
352
384
|
*/
|
|
353
385
|
export interface CreateAccessPointRequest {
|
|
354
386
|
/**
|
|
387
|
+
* @public
|
|
355
388
|
* <p>A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
|
|
356
389
|
* creation.</p>
|
|
357
390
|
*/
|
|
358
391
|
ClientToken?: string;
|
|
359
392
|
/**
|
|
393
|
+
* @public
|
|
360
394
|
* <p>Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more
|
|
361
395
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
|
|
362
396
|
* in the <i>Amazon Web Services General Reference Guide</i>.</p>
|
|
363
397
|
*/
|
|
364
398
|
Tags?: Tag[];
|
|
365
399
|
/**
|
|
400
|
+
* @public
|
|
366
401
|
* <p>The ID of the EFS file system that the access point provides access to.</p>
|
|
367
402
|
*/
|
|
368
403
|
FileSystemId: string | undefined;
|
|
369
404
|
/**
|
|
405
|
+
* @public
|
|
370
406
|
* <p>The operating system user and
|
|
371
407
|
* group applied to all file system requests made using the access point.</p>
|
|
372
408
|
*/
|
|
373
409
|
PosixUser?: PosixUser;
|
|
374
410
|
/**
|
|
411
|
+
* @public
|
|
375
412
|
* <p>Specifies the directory on the Amazon EFS file system that the access point
|
|
376
413
|
* exposes as the root directory of your file system to NFS clients using the access point. The
|
|
377
414
|
* clients using the access point can only access the root directory and below. If the
|
|
@@ -394,11 +431,13 @@ export declare class FileSystemNotFound extends __BaseException {
|
|
|
394
431
|
readonly name: "FileSystemNotFound";
|
|
395
432
|
readonly $fault: "client";
|
|
396
433
|
/**
|
|
434
|
+
* @public
|
|
397
435
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
398
436
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
399
437
|
*/
|
|
400
438
|
ErrorCode: string | undefined;
|
|
401
439
|
/**
|
|
440
|
+
* @public
|
|
402
441
|
* <p>The error message contains a generic description of the error
|
|
403
442
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
404
443
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -419,11 +458,13 @@ export declare class IncorrectFileSystemLifeCycleState extends __BaseException {
|
|
|
419
458
|
readonly name: "IncorrectFileSystemLifeCycleState";
|
|
420
459
|
readonly $fault: "client";
|
|
421
460
|
/**
|
|
461
|
+
* @public
|
|
422
462
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
423
463
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
424
464
|
*/
|
|
425
465
|
ErrorCode: string | undefined;
|
|
426
466
|
/**
|
|
467
|
+
* @public
|
|
427
468
|
* <p>The error message contains a generic description of the error
|
|
428
469
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
429
470
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -444,11 +485,13 @@ export declare class InternalServerError extends __BaseException {
|
|
|
444
485
|
readonly name: "InternalServerError";
|
|
445
486
|
readonly $fault: "server";
|
|
446
487
|
/**
|
|
488
|
+
* @public
|
|
447
489
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
448
490
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
449
491
|
*/
|
|
450
492
|
ErrorCode: string | undefined;
|
|
451
493
|
/**
|
|
494
|
+
* @public
|
|
452
495
|
* <p>The error message contains a generic description of the error
|
|
453
496
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
454
497
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -471,11 +514,13 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
471
514
|
readonly name: "ThrottlingException";
|
|
472
515
|
readonly $fault: "client";
|
|
473
516
|
/**
|
|
517
|
+
* @public
|
|
474
518
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
475
519
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
476
520
|
*/
|
|
477
521
|
ErrorCode?: string;
|
|
478
522
|
/**
|
|
523
|
+
* @public
|
|
479
524
|
* <p>The error message contains a generic description of the error
|
|
480
525
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
481
526
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -518,11 +563,13 @@ export type ThroughputMode = (typeof ThroughputMode)[keyof typeof ThroughputMode
|
|
|
518
563
|
*/
|
|
519
564
|
export interface CreateFileSystemRequest {
|
|
520
565
|
/**
|
|
566
|
+
* @public
|
|
521
567
|
* <p>A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent
|
|
522
568
|
* creation.</p>
|
|
523
569
|
*/
|
|
524
570
|
CreationToken?: string;
|
|
525
571
|
/**
|
|
572
|
+
* @public
|
|
526
573
|
* <p>The performance mode of the file system. We recommend <code>generalPurpose</code>
|
|
527
574
|
* performance mode for most file systems. File systems using the <code>maxIO</code> performance
|
|
528
575
|
* mode can scale to higher levels of aggregate throughput and operations per second with a
|
|
@@ -534,6 +581,7 @@ export interface CreateFileSystemRequest {
|
|
|
534
581
|
*/
|
|
535
582
|
PerformanceMode?: PerformanceMode | string;
|
|
536
583
|
/**
|
|
584
|
+
* @public
|
|
537
585
|
* <p>A Boolean value that, if true, creates an encrypted file system. When creating an
|
|
538
586
|
* encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key).
|
|
539
587
|
* If you don't specify a KMS key, then the default KMS key for
|
|
@@ -542,6 +590,7 @@ export interface CreateFileSystemRequest {
|
|
|
542
590
|
*/
|
|
543
591
|
Encrypted?: boolean;
|
|
544
592
|
/**
|
|
593
|
+
* @public
|
|
545
594
|
* <p>The ID of the KMS key that you want to use to protect the encrypted file
|
|
546
595
|
* system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following
|
|
547
596
|
* formats:</p>
|
|
@@ -572,6 +621,7 @@ export interface CreateFileSystemRequest {
|
|
|
572
621
|
*/
|
|
573
622
|
KmsKeyId?: string;
|
|
574
623
|
/**
|
|
624
|
+
* @public
|
|
575
625
|
* <p>Specifies the throughput mode for the file system. The mode can be <code>bursting</code>,
|
|
576
626
|
* <code>provisioned</code>, or <code>elastic</code>. If you set <code>ThroughputMode</code> to
|
|
577
627
|
* <code>provisioned</code>, you must also set a value for
|
|
@@ -584,6 +634,7 @@ export interface CreateFileSystemRequest {
|
|
|
584
634
|
*/
|
|
585
635
|
ThroughputMode?: ThroughputMode | string;
|
|
586
636
|
/**
|
|
637
|
+
* @public
|
|
587
638
|
* <p>The throughput, measured in
|
|
588
639
|
* MiB/s,
|
|
589
640
|
* that you want to provision for a file system that you're creating. Valid values are
|
|
@@ -593,6 +644,7 @@ export interface CreateFileSystemRequest {
|
|
|
593
644
|
*/
|
|
594
645
|
ProvisionedThroughputInMibps?: number;
|
|
595
646
|
/**
|
|
647
|
+
* @public
|
|
596
648
|
* <p>Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services
|
|
597
649
|
* Availability Zone in which to create the file system. Use the format <code>us-east-1a</code>
|
|
598
650
|
* to specify the Availability Zone. For
|
|
@@ -604,6 +656,7 @@ export interface CreateFileSystemRequest {
|
|
|
604
656
|
*/
|
|
605
657
|
AvailabilityZoneName?: string;
|
|
606
658
|
/**
|
|
659
|
+
* @public
|
|
607
660
|
* <p>Specifies whether automatic backups are enabled on the file system that you are creating.
|
|
608
661
|
* Set the value to <code>true</code> to enable automatic backups. If you are creating a file
|
|
609
662
|
* system that uses One Zone storage classes, automatic backups are enabled by default. For more
|
|
@@ -617,6 +670,7 @@ export interface CreateFileSystemRequest {
|
|
|
617
670
|
*/
|
|
618
671
|
Backup?: boolean;
|
|
619
672
|
/**
|
|
673
|
+
* @public
|
|
620
674
|
* <p>Use to create one or more tags associated with the file system. Each
|
|
621
675
|
* tag is a user-defined key-value pair. Name your file system on creation by including a
|
|
622
676
|
* <code>"Key":"Name","Value":"\{value\}"</code> key-value pair. Each key must be unique. For more
|
|
@@ -634,11 +688,13 @@ export declare class FileSystemAlreadyExists extends __BaseException {
|
|
|
634
688
|
readonly name: "FileSystemAlreadyExists";
|
|
635
689
|
readonly $fault: "client";
|
|
636
690
|
/**
|
|
691
|
+
* @public
|
|
637
692
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
638
693
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
639
694
|
*/
|
|
640
695
|
ErrorCode: string | undefined;
|
|
641
696
|
/**
|
|
697
|
+
* @public
|
|
642
698
|
* <p>The error message contains a generic description of the error
|
|
643
699
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
644
700
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -664,20 +720,24 @@ export declare class FileSystemAlreadyExists extends __BaseException {
|
|
|
664
720
|
*/
|
|
665
721
|
export interface FileSystemSize {
|
|
666
722
|
/**
|
|
723
|
+
* @public
|
|
667
724
|
* <p>The latest known metered size (in bytes) of data stored in the file system.</p>
|
|
668
725
|
*/
|
|
669
726
|
Value: number | undefined;
|
|
670
727
|
/**
|
|
728
|
+
* @public
|
|
671
729
|
* <p>The time at which the size of data, returned in the <code>Value</code> field, was
|
|
672
730
|
* determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.</p>
|
|
673
731
|
*/
|
|
674
732
|
Timestamp?: Date;
|
|
675
733
|
/**
|
|
734
|
+
* @public
|
|
676
735
|
* <p>The latest known metered size (in bytes) of data stored in the Infrequent Access
|
|
677
736
|
* storage class.</p>
|
|
678
737
|
*/
|
|
679
738
|
ValueInIA?: number;
|
|
680
739
|
/**
|
|
740
|
+
* @public
|
|
681
741
|
* <p>The latest known metered size (in bytes) of data stored in the Standard storage
|
|
682
742
|
* class.</p>
|
|
683
743
|
*/
|
|
@@ -689,18 +749,22 @@ export interface FileSystemSize {
|
|
|
689
749
|
*/
|
|
690
750
|
export interface FileSystemDescription {
|
|
691
751
|
/**
|
|
752
|
+
* @public
|
|
692
753
|
* <p>The Amazon Web Services account that created the file system.</p>
|
|
693
754
|
*/
|
|
694
755
|
OwnerId: string | undefined;
|
|
695
756
|
/**
|
|
757
|
+
* @public
|
|
696
758
|
* <p>The opaque string specified in the request.</p>
|
|
697
759
|
*/
|
|
698
760
|
CreationToken: string | undefined;
|
|
699
761
|
/**
|
|
762
|
+
* @public
|
|
700
763
|
* <p>The ID of the file system, assigned by Amazon EFS.</p>
|
|
701
764
|
*/
|
|
702
765
|
FileSystemId: string | undefined;
|
|
703
766
|
/**
|
|
767
|
+
* @public
|
|
704
768
|
* <p>The Amazon Resource Name (ARN) for the EFS file system, in the format
|
|
705
769
|
* <code>arn:aws:elasticfilesystem:<i>region</i>:<i>account-id</i>:file-system/<i>file-system-id</i>
|
|
706
770
|
* </code>.
|
|
@@ -709,25 +773,30 @@ export interface FileSystemDescription {
|
|
|
709
773
|
*/
|
|
710
774
|
FileSystemArn?: string;
|
|
711
775
|
/**
|
|
776
|
+
* @public
|
|
712
777
|
* <p>The time that the file system was created, in seconds (since
|
|
713
778
|
* 1970-01-01T00:00:00Z).</p>
|
|
714
779
|
*/
|
|
715
780
|
CreationTime: Date | undefined;
|
|
716
781
|
/**
|
|
782
|
+
* @public
|
|
717
783
|
* <p>The lifecycle phase of the file system.</p>
|
|
718
784
|
*/
|
|
719
785
|
LifeCycleState: LifeCycleState | string | undefined;
|
|
720
786
|
/**
|
|
787
|
+
* @public
|
|
721
788
|
* <p>You can add tags to a file system, including a <code>Name</code> tag. For more
|
|
722
789
|
* information, see <a>CreateFileSystem</a>. If the file system has a <code>Name</code> tag, Amazon EFS returns
|
|
723
790
|
* the value in this field. </p>
|
|
724
791
|
*/
|
|
725
792
|
Name?: string;
|
|
726
793
|
/**
|
|
794
|
+
* @public
|
|
727
795
|
* <p>The current number of mount targets that the file system has. For more information, see <a>CreateMountTarget</a>.</p>
|
|
728
796
|
*/
|
|
729
797
|
NumberOfMountTargets: number | undefined;
|
|
730
798
|
/**
|
|
799
|
+
* @public
|
|
731
800
|
* <p>The latest known metered size (in bytes) of data stored in the file system, in its
|
|
732
801
|
* <code>Value</code> field, and the time at which that size was determined in its
|
|
733
802
|
* <code>Timestamp</code> field. The <code>Timestamp</code> value is the integer number of
|
|
@@ -740,18 +809,22 @@ export interface FileSystemDescription {
|
|
|
740
809
|
*/
|
|
741
810
|
SizeInBytes: FileSystemSize | undefined;
|
|
742
811
|
/**
|
|
812
|
+
* @public
|
|
743
813
|
* <p>The performance mode of the file system.</p>
|
|
744
814
|
*/
|
|
745
815
|
PerformanceMode: PerformanceMode | string | undefined;
|
|
746
816
|
/**
|
|
817
|
+
* @public
|
|
747
818
|
* <p>A Boolean value that, if true, indicates that the file system is encrypted.</p>
|
|
748
819
|
*/
|
|
749
820
|
Encrypted?: boolean;
|
|
750
821
|
/**
|
|
822
|
+
* @public
|
|
751
823
|
* <p>The ID of an KMS key used to protect the encrypted file system.</p>
|
|
752
824
|
*/
|
|
753
825
|
KmsKeyId?: string;
|
|
754
826
|
/**
|
|
827
|
+
* @public
|
|
755
828
|
* <p>Displays the file system's throughput mode. For more information, see
|
|
756
829
|
* <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes">Throughput modes</a>
|
|
757
830
|
* in the <i>Amazon EFS User Guide</i>.
|
|
@@ -759,23 +832,27 @@ export interface FileSystemDescription {
|
|
|
759
832
|
*/
|
|
760
833
|
ThroughputMode?: ThroughputMode | string;
|
|
761
834
|
/**
|
|
835
|
+
* @public
|
|
762
836
|
* <p>The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for
|
|
763
837
|
* file systems using <code>ThroughputMode</code> set to <code>provisioned</code>.</p>
|
|
764
838
|
*/
|
|
765
839
|
ProvisionedThroughputInMibps?: number;
|
|
766
840
|
/**
|
|
841
|
+
* @public
|
|
767
842
|
* <p>Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only
|
|
768
843
|
* for file systems using One Zone storage classes. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage classes</a>
|
|
769
844
|
* in the <i>Amazon EFS User Guide</i>.</p>
|
|
770
845
|
*/
|
|
771
846
|
AvailabilityZoneName?: string;
|
|
772
847
|
/**
|
|
848
|
+
* @public
|
|
773
849
|
* <p>The unique and consistent identifier of the Availability Zone in which the file system's
|
|
774
850
|
* One Zone storage classes exist. For example, <code>use1-az1</code> is an Availability Zone ID
|
|
775
851
|
* for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.</p>
|
|
776
852
|
*/
|
|
777
853
|
AvailabilityZoneId?: string;
|
|
778
854
|
/**
|
|
855
|
+
* @public
|
|
779
856
|
* <p>The tags associated with the file system, presented as an array of <code>Tag</code>
|
|
780
857
|
* objects.</p>
|
|
781
858
|
*/
|
|
@@ -790,11 +867,13 @@ export declare class FileSystemLimitExceeded extends __BaseException {
|
|
|
790
867
|
readonly name: "FileSystemLimitExceeded";
|
|
791
868
|
readonly $fault: "client";
|
|
792
869
|
/**
|
|
870
|
+
* @public
|
|
793
871
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
794
872
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
795
873
|
*/
|
|
796
874
|
ErrorCode: string | undefined;
|
|
797
875
|
/**
|
|
876
|
+
* @public
|
|
798
877
|
* <p>The error message contains a generic description of the error
|
|
799
878
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
800
879
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -819,11 +898,13 @@ export declare class InsufficientThroughputCapacity extends __BaseException {
|
|
|
819
898
|
readonly name: "InsufficientThroughputCapacity";
|
|
820
899
|
readonly $fault: "server";
|
|
821
900
|
/**
|
|
901
|
+
* @public
|
|
822
902
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
823
903
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
824
904
|
*/
|
|
825
905
|
ErrorCode: string | undefined;
|
|
826
906
|
/**
|
|
907
|
+
* @public
|
|
827
908
|
* <p>The error message contains a generic description of the error
|
|
828
909
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
829
910
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -845,11 +926,13 @@ export declare class ThroughputLimitExceeded extends __BaseException {
|
|
|
845
926
|
readonly name: "ThroughputLimitExceeded";
|
|
846
927
|
readonly $fault: "client";
|
|
847
928
|
/**
|
|
929
|
+
* @public
|
|
848
930
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
849
931
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
850
932
|
*/
|
|
851
933
|
ErrorCode: string | undefined;
|
|
852
934
|
/**
|
|
935
|
+
* @public
|
|
853
936
|
* <p>The error message contains a generic description of the error
|
|
854
937
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
855
938
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -870,11 +953,13 @@ export declare class UnsupportedAvailabilityZone extends __BaseException {
|
|
|
870
953
|
readonly name: "UnsupportedAvailabilityZone";
|
|
871
954
|
readonly $fault: "client";
|
|
872
955
|
/**
|
|
956
|
+
* @public
|
|
873
957
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
874
958
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
875
959
|
*/
|
|
876
960
|
ErrorCode: string | undefined;
|
|
877
961
|
/**
|
|
962
|
+
* @public
|
|
878
963
|
* <p>The error message contains a generic description of the error
|
|
879
964
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
880
965
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -893,19 +978,23 @@ export declare class UnsupportedAvailabilityZone extends __BaseException {
|
|
|
893
978
|
*/
|
|
894
979
|
export interface CreateMountTargetRequest {
|
|
895
980
|
/**
|
|
981
|
+
* @public
|
|
896
982
|
* <p>The ID of the file system for which to create the mount target.</p>
|
|
897
983
|
*/
|
|
898
984
|
FileSystemId: string | undefined;
|
|
899
985
|
/**
|
|
986
|
+
* @public
|
|
900
987
|
* <p>The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet
|
|
901
988
|
* that is associated with the file system's Availability Zone.</p>
|
|
902
989
|
*/
|
|
903
990
|
SubnetId: string | undefined;
|
|
904
991
|
/**
|
|
992
|
+
* @public
|
|
905
993
|
* <p>Valid IPv4 address within the address range of the specified subnet.</p>
|
|
906
994
|
*/
|
|
907
995
|
IpAddress?: string;
|
|
908
996
|
/**
|
|
997
|
+
* @public
|
|
909
998
|
* <p>Up to five VPC security group IDs, of the form <code>sg-xxxxxxxx</code>. These must be
|
|
910
999
|
* for the same VPC as subnet specified.</p>
|
|
911
1000
|
*/
|
|
@@ -920,11 +1009,13 @@ export declare class IpAddressInUse extends __BaseException {
|
|
|
920
1009
|
readonly name: "IpAddressInUse";
|
|
921
1010
|
readonly $fault: "client";
|
|
922
1011
|
/**
|
|
1012
|
+
* @public
|
|
923
1013
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
924
1014
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
925
1015
|
*/
|
|
926
1016
|
ErrorCode: string | undefined;
|
|
927
1017
|
/**
|
|
1018
|
+
* @public
|
|
928
1019
|
* <p>The error message contains a generic description of the error
|
|
929
1020
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
930
1021
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -946,11 +1037,13 @@ export declare class MountTargetConflict extends __BaseException {
|
|
|
946
1037
|
readonly name: "MountTargetConflict";
|
|
947
1038
|
readonly $fault: "client";
|
|
948
1039
|
/**
|
|
1040
|
+
* @public
|
|
949
1041
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
950
1042
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
951
1043
|
*/
|
|
952
1044
|
ErrorCode: string | undefined;
|
|
953
1045
|
/**
|
|
1046
|
+
* @public
|
|
954
1047
|
* <p>The error message contains a generic description of the error
|
|
955
1048
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
956
1049
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -969,46 +1062,56 @@ export declare class MountTargetConflict extends __BaseException {
|
|
|
969
1062
|
*/
|
|
970
1063
|
export interface MountTargetDescription {
|
|
971
1064
|
/**
|
|
1065
|
+
* @public
|
|
972
1066
|
* <p>Amazon Web Services account ID that owns the resource.</p>
|
|
973
1067
|
*/
|
|
974
1068
|
OwnerId?: string;
|
|
975
1069
|
/**
|
|
1070
|
+
* @public
|
|
976
1071
|
* <p>System-assigned mount target ID.</p>
|
|
977
1072
|
*/
|
|
978
1073
|
MountTargetId: string | undefined;
|
|
979
1074
|
/**
|
|
1075
|
+
* @public
|
|
980
1076
|
* <p>The ID of the file system for which the mount target is intended.</p>
|
|
981
1077
|
*/
|
|
982
1078
|
FileSystemId: string | undefined;
|
|
983
1079
|
/**
|
|
1080
|
+
* @public
|
|
984
1081
|
* <p>The ID of the mount target's subnet.</p>
|
|
985
1082
|
*/
|
|
986
1083
|
SubnetId: string | undefined;
|
|
987
1084
|
/**
|
|
1085
|
+
* @public
|
|
988
1086
|
* <p>Lifecycle state of the mount target.</p>
|
|
989
1087
|
*/
|
|
990
1088
|
LifeCycleState: LifeCycleState | string | undefined;
|
|
991
1089
|
/**
|
|
1090
|
+
* @public
|
|
992
1091
|
* <p>Address at which the file system can be mounted by using the mount target.</p>
|
|
993
1092
|
*/
|
|
994
1093
|
IpAddress?: string;
|
|
995
1094
|
/**
|
|
1095
|
+
* @public
|
|
996
1096
|
* <p>The ID of the network interface that Amazon EFS created when it created the mount
|
|
997
1097
|
* target.</p>
|
|
998
1098
|
*/
|
|
999
1099
|
NetworkInterfaceId?: string;
|
|
1000
1100
|
/**
|
|
1101
|
+
* @public
|
|
1001
1102
|
* <p>The unique and consistent identifier of the Availability Zone that the mount target resides in.
|
|
1002
1103
|
* For example, <code>use1-az1</code> is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account.</p>
|
|
1003
1104
|
*/
|
|
1004
1105
|
AvailabilityZoneId?: string;
|
|
1005
1106
|
/**
|
|
1107
|
+
* @public
|
|
1006
1108
|
* <p>The name of the Availability Zone in which the mount target is located. Availability Zones are
|
|
1007
1109
|
* independently mapped to names for each Amazon Web Services account. For example, the Availability Zone
|
|
1008
1110
|
* <code>us-east-1a</code> for your Amazon Web Services account might not be the same location as <code>us-east-1a</code> for another Amazon Web Services account.</p>
|
|
1009
1111
|
*/
|
|
1010
1112
|
AvailabilityZoneName?: string;
|
|
1011
1113
|
/**
|
|
1114
|
+
* @public
|
|
1012
1115
|
* <p>The virtual private cloud (VPC) ID that the mount target is configured in.</p>
|
|
1013
1116
|
*/
|
|
1014
1117
|
VpcId?: string;
|
|
@@ -1026,11 +1129,13 @@ export declare class NetworkInterfaceLimitExceeded extends __BaseException {
|
|
|
1026
1129
|
readonly name: "NetworkInterfaceLimitExceeded";
|
|
1027
1130
|
readonly $fault: "client";
|
|
1028
1131
|
/**
|
|
1132
|
+
* @public
|
|
1029
1133
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1030
1134
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1031
1135
|
*/
|
|
1032
1136
|
ErrorCode: string | undefined;
|
|
1033
1137
|
/**
|
|
1138
|
+
* @public
|
|
1034
1139
|
* <p>The error message contains a generic description of the error
|
|
1035
1140
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1036
1141
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1052,11 +1157,13 @@ export declare class NoFreeAddressesInSubnet extends __BaseException {
|
|
|
1052
1157
|
readonly name: "NoFreeAddressesInSubnet";
|
|
1053
1158
|
readonly $fault: "client";
|
|
1054
1159
|
/**
|
|
1160
|
+
* @public
|
|
1055
1161
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1056
1162
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1057
1163
|
*/
|
|
1058
1164
|
ErrorCode: string | undefined;
|
|
1059
1165
|
/**
|
|
1166
|
+
* @public
|
|
1060
1167
|
* <p>The error message contains a generic description of the error
|
|
1061
1168
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1062
1169
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1078,11 +1185,13 @@ export declare class SecurityGroupLimitExceeded extends __BaseException {
|
|
|
1078
1185
|
readonly name: "SecurityGroupLimitExceeded";
|
|
1079
1186
|
readonly $fault: "client";
|
|
1080
1187
|
/**
|
|
1188
|
+
* @public
|
|
1081
1189
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1082
1190
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1083
1191
|
*/
|
|
1084
1192
|
ErrorCode: string | undefined;
|
|
1085
1193
|
/**
|
|
1194
|
+
* @public
|
|
1086
1195
|
* <p>The error message contains a generic description of the error
|
|
1087
1196
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1088
1197
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1104,11 +1213,13 @@ export declare class SecurityGroupNotFound extends __BaseException {
|
|
|
1104
1213
|
readonly name: "SecurityGroupNotFound";
|
|
1105
1214
|
readonly $fault: "client";
|
|
1106
1215
|
/**
|
|
1216
|
+
* @public
|
|
1107
1217
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1108
1218
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1109
1219
|
*/
|
|
1110
1220
|
ErrorCode: string | undefined;
|
|
1111
1221
|
/**
|
|
1222
|
+
* @public
|
|
1112
1223
|
* <p>The error message contains a generic description of the error
|
|
1113
1224
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1114
1225
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1130,11 +1241,13 @@ export declare class SubnetNotFound extends __BaseException {
|
|
|
1130
1241
|
readonly name: "SubnetNotFound";
|
|
1131
1242
|
readonly $fault: "client";
|
|
1132
1243
|
/**
|
|
1244
|
+
* @public
|
|
1133
1245
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1134
1246
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1135
1247
|
*/
|
|
1136
1248
|
ErrorCode: string | undefined;
|
|
1137
1249
|
/**
|
|
1250
|
+
* @public
|
|
1138
1251
|
* <p>The error message contains a generic description of the error
|
|
1139
1252
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1140
1253
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1153,16 +1266,19 @@ export declare class SubnetNotFound extends __BaseException {
|
|
|
1153
1266
|
*/
|
|
1154
1267
|
export interface DestinationToCreate {
|
|
1155
1268
|
/**
|
|
1269
|
+
* @public
|
|
1156
1270
|
* <p>To create a file system that uses Regional storage, specify the Amazon Web Services Region
|
|
1157
1271
|
* in which to create the destination file system.</p>
|
|
1158
1272
|
*/
|
|
1159
1273
|
Region?: string;
|
|
1160
1274
|
/**
|
|
1275
|
+
* @public
|
|
1161
1276
|
* <p>To create a file system that uses EFS One Zone storage, specify the name of the
|
|
1162
1277
|
* Availability Zone in which to create the destination file system.</p>
|
|
1163
1278
|
*/
|
|
1164
1279
|
AvailabilityZoneName?: string;
|
|
1165
1280
|
/**
|
|
1281
|
+
* @public
|
|
1166
1282
|
* <p>Specifies the Key Management Service (KMS) key that you want to use to
|
|
1167
1283
|
* encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,
|
|
1168
1284
|
* <code>/aws/elasticfilesystem</code>. This ID can be in one of the following formats:</p>
|
|
@@ -1192,11 +1308,13 @@ export interface DestinationToCreate {
|
|
|
1192
1308
|
*/
|
|
1193
1309
|
export interface CreateReplicationConfigurationRequest {
|
|
1194
1310
|
/**
|
|
1311
|
+
* @public
|
|
1195
1312
|
* <p>Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be
|
|
1196
1313
|
* a source or destination file system in another replication configuration.</p>
|
|
1197
1314
|
*/
|
|
1198
1315
|
SourceFileSystemId: string | undefined;
|
|
1199
1316
|
/**
|
|
1317
|
+
* @public
|
|
1200
1318
|
* <p>An array of destination configuration objects. Only one destination configuration object is supported.</p>
|
|
1201
1319
|
*/
|
|
1202
1320
|
Destinations: DestinationToCreate[] | undefined;
|
|
@@ -1223,6 +1341,7 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat
|
|
|
1223
1341
|
*/
|
|
1224
1342
|
export interface Destination {
|
|
1225
1343
|
/**
|
|
1344
|
+
* @public
|
|
1226
1345
|
* <p>Describes the status of the destination Amazon EFS file system.</p>
|
|
1227
1346
|
* <ul>
|
|
1228
1347
|
* <li>
|
|
@@ -1244,14 +1363,17 @@ export interface Destination {
|
|
|
1244
1363
|
*/
|
|
1245
1364
|
Status: ReplicationStatus | string | undefined;
|
|
1246
1365
|
/**
|
|
1366
|
+
* @public
|
|
1247
1367
|
* <p>The ID of the destination Amazon EFS file system.</p>
|
|
1248
1368
|
*/
|
|
1249
1369
|
FileSystemId: string | undefined;
|
|
1250
1370
|
/**
|
|
1371
|
+
* @public
|
|
1251
1372
|
* <p>The Amazon Web Services Region in which the destination file system is located.</p>
|
|
1252
1373
|
*/
|
|
1253
1374
|
Region: string | undefined;
|
|
1254
1375
|
/**
|
|
1376
|
+
* @public
|
|
1255
1377
|
* <p>The time when the most recent sync was successfully completed on the destination file
|
|
1256
1378
|
* system. Any changes to data on the source file system that occurred before this time have been
|
|
1257
1379
|
* successfully replicated to the destination file system. Any changes that occurred after this
|
|
@@ -1264,27 +1386,33 @@ export interface Destination {
|
|
|
1264
1386
|
*/
|
|
1265
1387
|
export interface ReplicationConfigurationDescription {
|
|
1266
1388
|
/**
|
|
1389
|
+
* @public
|
|
1267
1390
|
* <p>The ID of the source Amazon EFS file system that is being replicated.</p>
|
|
1268
1391
|
*/
|
|
1269
1392
|
SourceFileSystemId: string | undefined;
|
|
1270
1393
|
/**
|
|
1394
|
+
* @public
|
|
1271
1395
|
* <p>The Amazon Web Services Region in which the source Amazon EFS file system is located.</p>
|
|
1272
1396
|
*/
|
|
1273
1397
|
SourceFileSystemRegion: string | undefined;
|
|
1274
1398
|
/**
|
|
1399
|
+
* @public
|
|
1275
1400
|
* <p>The Amazon Resource Name (ARN) of the current source file system in the replication
|
|
1276
1401
|
* configuration.</p>
|
|
1277
1402
|
*/
|
|
1278
1403
|
SourceFileSystemArn: string | undefined;
|
|
1279
1404
|
/**
|
|
1405
|
+
* @public
|
|
1280
1406
|
* <p>The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.</p>
|
|
1281
1407
|
*/
|
|
1282
1408
|
OriginalSourceFileSystemArn: string | undefined;
|
|
1283
1409
|
/**
|
|
1410
|
+
* @public
|
|
1284
1411
|
* <p>Describes when the replication configuration was created.</p>
|
|
1285
1412
|
*/
|
|
1286
1413
|
CreationTime: Date | undefined;
|
|
1287
1414
|
/**
|
|
1415
|
+
* @public
|
|
1288
1416
|
* <p>An array of destination objects. Only one destination object is supported.</p>
|
|
1289
1417
|
*/
|
|
1290
1418
|
Destinations: Destination[] | undefined;
|
|
@@ -1298,10 +1426,12 @@ export declare class ReplicationNotFound extends __BaseException {
|
|
|
1298
1426
|
readonly name: "ReplicationNotFound";
|
|
1299
1427
|
readonly $fault: "client";
|
|
1300
1428
|
/**
|
|
1429
|
+
* @public
|
|
1301
1430
|
* <p>ReplicationNotFound</p>
|
|
1302
1431
|
*/
|
|
1303
1432
|
ErrorCode?: string;
|
|
1304
1433
|
/**
|
|
1434
|
+
* @public
|
|
1305
1435
|
* <p>The error message contains a generic description of the error
|
|
1306
1436
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1307
1437
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1322,11 +1452,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
1322
1452
|
readonly name: "ValidationException";
|
|
1323
1453
|
readonly $fault: "client";
|
|
1324
1454
|
/**
|
|
1455
|
+
* @public
|
|
1325
1456
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1326
1457
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1327
1458
|
*/
|
|
1328
1459
|
ErrorCode: string | undefined;
|
|
1329
1460
|
/**
|
|
1461
|
+
* @public
|
|
1330
1462
|
* <p>The error message contains a generic description of the error
|
|
1331
1463
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1332
1464
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1345,11 +1477,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
1345
1477
|
*/
|
|
1346
1478
|
export interface CreateTagsRequest {
|
|
1347
1479
|
/**
|
|
1480
|
+
* @public
|
|
1348
1481
|
* <p>The ID of the file system whose tags you want to modify (String). This operation modifies
|
|
1349
1482
|
* the tags only, not the file system.</p>
|
|
1350
1483
|
*/
|
|
1351
1484
|
FileSystemId: string | undefined;
|
|
1352
1485
|
/**
|
|
1486
|
+
* @public
|
|
1353
1487
|
* <p>An array of <code>Tag</code> objects to add. Each <code>Tag</code> object is a key-value
|
|
1354
1488
|
* pair. </p>
|
|
1355
1489
|
*/
|
|
@@ -1360,6 +1494,7 @@ export interface CreateTagsRequest {
|
|
|
1360
1494
|
*/
|
|
1361
1495
|
export interface DeleteAccessPointRequest {
|
|
1362
1496
|
/**
|
|
1497
|
+
* @public
|
|
1363
1498
|
* <p>The ID of the access point that you want to delete.</p>
|
|
1364
1499
|
*/
|
|
1365
1500
|
AccessPointId: string | undefined;
|
|
@@ -1370,6 +1505,7 @@ export interface DeleteAccessPointRequest {
|
|
|
1370
1505
|
*/
|
|
1371
1506
|
export interface DeleteFileSystemRequest {
|
|
1372
1507
|
/**
|
|
1508
|
+
* @public
|
|
1373
1509
|
* <p>The ID of the file system you want to delete.</p>
|
|
1374
1510
|
*/
|
|
1375
1511
|
FileSystemId: string | undefined;
|
|
@@ -1382,11 +1518,13 @@ export declare class FileSystemInUse extends __BaseException {
|
|
|
1382
1518
|
readonly name: "FileSystemInUse";
|
|
1383
1519
|
readonly $fault: "client";
|
|
1384
1520
|
/**
|
|
1521
|
+
* @public
|
|
1385
1522
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1386
1523
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1387
1524
|
*/
|
|
1388
1525
|
ErrorCode: string | undefined;
|
|
1389
1526
|
/**
|
|
1527
|
+
* @public
|
|
1390
1528
|
* <p>The error message contains a generic description of the error
|
|
1391
1529
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1392
1530
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1404,6 +1542,7 @@ export declare class FileSystemInUse extends __BaseException {
|
|
|
1404
1542
|
*/
|
|
1405
1543
|
export interface DeleteFileSystemPolicyRequest {
|
|
1406
1544
|
/**
|
|
1545
|
+
* @public
|
|
1407
1546
|
* <p>Specifies the EFS file system for which to delete the <code>FileSystemPolicy</code>.</p>
|
|
1408
1547
|
*/
|
|
1409
1548
|
FileSystemId: string | undefined;
|
|
@@ -1414,6 +1553,7 @@ export interface DeleteFileSystemPolicyRequest {
|
|
|
1414
1553
|
*/
|
|
1415
1554
|
export interface DeleteMountTargetRequest {
|
|
1416
1555
|
/**
|
|
1556
|
+
* @public
|
|
1417
1557
|
* <p>The ID of the mount target to delete (String).</p>
|
|
1418
1558
|
*/
|
|
1419
1559
|
MountTargetId: string | undefined;
|
|
@@ -1427,11 +1567,13 @@ export declare class DependencyTimeout extends __BaseException {
|
|
|
1427
1567
|
readonly name: "DependencyTimeout";
|
|
1428
1568
|
readonly $fault: "server";
|
|
1429
1569
|
/**
|
|
1570
|
+
* @public
|
|
1430
1571
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1431
1572
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1432
1573
|
*/
|
|
1433
1574
|
ErrorCode: string | undefined;
|
|
1434
1575
|
/**
|
|
1576
|
+
* @public
|
|
1435
1577
|
* <p>The error message contains a generic description of the error
|
|
1436
1578
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1437
1579
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1453,11 +1595,13 @@ export declare class MountTargetNotFound extends __BaseException {
|
|
|
1453
1595
|
readonly name: "MountTargetNotFound";
|
|
1454
1596
|
readonly $fault: "client";
|
|
1455
1597
|
/**
|
|
1598
|
+
* @public
|
|
1456
1599
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1457
1600
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1458
1601
|
*/
|
|
1459
1602
|
ErrorCode: string | undefined;
|
|
1460
1603
|
/**
|
|
1604
|
+
* @public
|
|
1461
1605
|
* <p>The error message contains a generic description of the error
|
|
1462
1606
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1463
1607
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1475,6 +1619,7 @@ export declare class MountTargetNotFound extends __BaseException {
|
|
|
1475
1619
|
*/
|
|
1476
1620
|
export interface DeleteReplicationConfigurationRequest {
|
|
1477
1621
|
/**
|
|
1622
|
+
* @public
|
|
1478
1623
|
* <p>The ID of the source file system in the replication configuration.</p>
|
|
1479
1624
|
*/
|
|
1480
1625
|
SourceFileSystemId: string | undefined;
|
|
@@ -1485,10 +1630,12 @@ export interface DeleteReplicationConfigurationRequest {
|
|
|
1485
1630
|
*/
|
|
1486
1631
|
export interface DeleteTagsRequest {
|
|
1487
1632
|
/**
|
|
1633
|
+
* @public
|
|
1488
1634
|
* <p>The ID of the file system whose tags you want to delete (String).</p>
|
|
1489
1635
|
*/
|
|
1490
1636
|
FileSystemId: string | undefined;
|
|
1491
1637
|
/**
|
|
1638
|
+
* @public
|
|
1492
1639
|
* <p>A list of tag keys to delete.</p>
|
|
1493
1640
|
*/
|
|
1494
1641
|
TagKeys: string[] | undefined;
|
|
@@ -1498,22 +1645,26 @@ export interface DeleteTagsRequest {
|
|
|
1498
1645
|
*/
|
|
1499
1646
|
export interface DescribeAccessPointsRequest {
|
|
1500
1647
|
/**
|
|
1648
|
+
* @public
|
|
1501
1649
|
* <p>(Optional) When retrieving all access points for a file system,
|
|
1502
1650
|
* you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response.
|
|
1503
1651
|
* The default value is 100. </p>
|
|
1504
1652
|
*/
|
|
1505
1653
|
MaxResults?: number;
|
|
1506
1654
|
/**
|
|
1655
|
+
* @public
|
|
1507
1656
|
* <p>
|
|
1508
1657
|
* <code>NextToken</code> is present if the response is paginated. You can use
|
|
1509
1658
|
* <code>NextMarker</code> in the subsequent request to fetch the next page of access point descriptions.</p>
|
|
1510
1659
|
*/
|
|
1511
1660
|
NextToken?: string;
|
|
1512
1661
|
/**
|
|
1662
|
+
* @public
|
|
1513
1663
|
* <p>(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <code>FileSystemId</code>.</p>
|
|
1514
1664
|
*/
|
|
1515
1665
|
AccessPointId?: string;
|
|
1516
1666
|
/**
|
|
1667
|
+
* @public
|
|
1517
1668
|
* <p>(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access points for that file system; mutually exclusive with <code>AccessPointId</code>.</p>
|
|
1518
1669
|
*/
|
|
1519
1670
|
FileSystemId?: string;
|
|
@@ -1523,10 +1674,12 @@ export interface DescribeAccessPointsRequest {
|
|
|
1523
1674
|
*/
|
|
1524
1675
|
export interface DescribeAccessPointsResponse {
|
|
1525
1676
|
/**
|
|
1677
|
+
* @public
|
|
1526
1678
|
* <p>An array of access point descriptions.</p>
|
|
1527
1679
|
*/
|
|
1528
1680
|
AccessPoints?: AccessPointDescription[];
|
|
1529
1681
|
/**
|
|
1682
|
+
* @public
|
|
1530
1683
|
* <p>Present if there are more access points than returned in the response.
|
|
1531
1684
|
* You can use the NextMarker in the subsequent request to fetch the additional descriptions.</p>
|
|
1532
1685
|
*/
|
|
@@ -1537,11 +1690,13 @@ export interface DescribeAccessPointsResponse {
|
|
|
1537
1690
|
*/
|
|
1538
1691
|
export interface DescribeAccountPreferencesRequest {
|
|
1539
1692
|
/**
|
|
1693
|
+
* @public
|
|
1540
1694
|
* <p>(Optional) You can use <code>NextToken</code> in a subsequent request to fetch the next page of
|
|
1541
1695
|
* Amazon Web Services account preferences if the response payload was paginated.</p>
|
|
1542
1696
|
*/
|
|
1543
1697
|
NextToken?: string;
|
|
1544
1698
|
/**
|
|
1699
|
+
* @public
|
|
1545
1700
|
* <p>(Optional) When retrieving account preferences,
|
|
1546
1701
|
* you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response.
|
|
1547
1702
|
* The default value is 100. </p>
|
|
@@ -1578,10 +1733,12 @@ export type Resource = (typeof Resource)[keyof typeof Resource];
|
|
|
1578
1733
|
*/
|
|
1579
1734
|
export interface ResourceIdPreference {
|
|
1580
1735
|
/**
|
|
1736
|
+
* @public
|
|
1581
1737
|
* <p>Identifies the EFS resource ID preference, either <code>LONG_ID</code> (17 characters) or <code>SHORT_ID</code> (8 characters).</p>
|
|
1582
1738
|
*/
|
|
1583
1739
|
ResourceIdType?: ResourceIdType | string;
|
|
1584
1740
|
/**
|
|
1741
|
+
* @public
|
|
1585
1742
|
* <p>Identifies the Amazon EFS resources to which the ID preference setting applies, <code>FILE_SYSTEM</code> and <code>MOUNT_TARGET</code>.</p>
|
|
1586
1743
|
*/
|
|
1587
1744
|
Resources?: (Resource | string)[];
|
|
@@ -1591,10 +1748,12 @@ export interface ResourceIdPreference {
|
|
|
1591
1748
|
*/
|
|
1592
1749
|
export interface DescribeAccountPreferencesResponse {
|
|
1593
1750
|
/**
|
|
1751
|
+
* @public
|
|
1594
1752
|
* <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>
|
|
1595
1753
|
*/
|
|
1596
1754
|
ResourceIdPreference?: ResourceIdPreference;
|
|
1597
1755
|
/**
|
|
1756
|
+
* @public
|
|
1598
1757
|
* <p>Present if there are more records than returned in the response.
|
|
1599
1758
|
* You can use the <code>NextToken</code> in the subsequent request to fetch the additional descriptions.</p>
|
|
1600
1759
|
*/
|
|
@@ -1605,6 +1764,7 @@ export interface DescribeAccountPreferencesResponse {
|
|
|
1605
1764
|
*/
|
|
1606
1765
|
export interface DescribeBackupPolicyRequest {
|
|
1607
1766
|
/**
|
|
1767
|
+
* @public
|
|
1608
1768
|
* <p>Specifies which EFS file system to retrieve the <code>BackupPolicy</code> for.</p>
|
|
1609
1769
|
*/
|
|
1610
1770
|
FileSystemId: string | undefined;
|
|
@@ -1617,11 +1777,13 @@ export declare class PolicyNotFound extends __BaseException {
|
|
|
1617
1777
|
readonly name: "PolicyNotFound";
|
|
1618
1778
|
readonly $fault: "client";
|
|
1619
1779
|
/**
|
|
1780
|
+
* @public
|
|
1620
1781
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1621
1782
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1622
1783
|
*/
|
|
1623
1784
|
ErrorCode?: string;
|
|
1624
1785
|
/**
|
|
1786
|
+
* @public
|
|
1625
1787
|
* <p>The error message contains a generic description of the error
|
|
1626
1788
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1627
1789
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1639,6 +1801,7 @@ export declare class PolicyNotFound extends __BaseException {
|
|
|
1639
1801
|
*/
|
|
1640
1802
|
export interface DescribeFileSystemPolicyRequest {
|
|
1641
1803
|
/**
|
|
1804
|
+
* @public
|
|
1642
1805
|
* <p>Specifies which EFS file system to retrieve the <code>FileSystemPolicy</code> for.</p>
|
|
1643
1806
|
*/
|
|
1644
1807
|
FileSystemId: string | undefined;
|
|
@@ -1648,10 +1811,12 @@ export interface DescribeFileSystemPolicyRequest {
|
|
|
1648
1811
|
*/
|
|
1649
1812
|
export interface FileSystemPolicyDescription {
|
|
1650
1813
|
/**
|
|
1814
|
+
* @public
|
|
1651
1815
|
* <p>Specifies the EFS file system to which the <code>FileSystemPolicy</code> applies.</p>
|
|
1652
1816
|
*/
|
|
1653
1817
|
FileSystemId?: string;
|
|
1654
1818
|
/**
|
|
1819
|
+
* @public
|
|
1655
1820
|
* <p>The JSON formatted <code>FileSystemPolicy</code> for the EFS file system.</p>
|
|
1656
1821
|
*/
|
|
1657
1822
|
Policy?: string;
|
|
@@ -1662,23 +1827,27 @@ export interface FileSystemPolicyDescription {
|
|
|
1662
1827
|
*/
|
|
1663
1828
|
export interface DescribeFileSystemsRequest {
|
|
1664
1829
|
/**
|
|
1830
|
+
* @public
|
|
1665
1831
|
* <p>(Optional) Specifies the maximum number of file systems to return in the response
|
|
1666
1832
|
* (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.
|
|
1667
1833
|
* </p>
|
|
1668
1834
|
*/
|
|
1669
1835
|
MaxItems?: number;
|
|
1670
1836
|
/**
|
|
1837
|
+
* @public
|
|
1671
1838
|
* <p>(Optional) Opaque pagination token returned from a previous
|
|
1672
1839
|
* <code>DescribeFileSystems</code> operation (String). If present, specifies to continue the
|
|
1673
1840
|
* list from where the returning call had left off. </p>
|
|
1674
1841
|
*/
|
|
1675
1842
|
Marker?: string;
|
|
1676
1843
|
/**
|
|
1844
|
+
* @public
|
|
1677
1845
|
* <p>(Optional) Restricts the list to the file system with this creation token (String). You
|
|
1678
1846
|
* specify a creation token when you create an Amazon EFS file system.</p>
|
|
1679
1847
|
*/
|
|
1680
1848
|
CreationToken?: string;
|
|
1681
1849
|
/**
|
|
1850
|
+
* @public
|
|
1682
1851
|
* <p>(Optional) ID of the file system whose description you want to retrieve
|
|
1683
1852
|
* (String).</p>
|
|
1684
1853
|
*/
|
|
@@ -1689,14 +1858,17 @@ export interface DescribeFileSystemsRequest {
|
|
|
1689
1858
|
*/
|
|
1690
1859
|
export interface DescribeFileSystemsResponse {
|
|
1691
1860
|
/**
|
|
1861
|
+
* @public
|
|
1692
1862
|
* <p>Present if provided by caller in the request (String).</p>
|
|
1693
1863
|
*/
|
|
1694
1864
|
Marker?: string;
|
|
1695
1865
|
/**
|
|
1866
|
+
* @public
|
|
1696
1867
|
* <p>An array of file system descriptions.</p>
|
|
1697
1868
|
*/
|
|
1698
1869
|
FileSystems?: FileSystemDescription[];
|
|
1699
1870
|
/**
|
|
1871
|
+
* @public
|
|
1700
1872
|
* <p>Present if there are more file systems than returned in the response (String). You can
|
|
1701
1873
|
* use the <code>NextMarker</code> in the subsequent request to fetch the descriptions.</p>
|
|
1702
1874
|
*/
|
|
@@ -1707,6 +1879,7 @@ export interface DescribeFileSystemsResponse {
|
|
|
1707
1879
|
*/
|
|
1708
1880
|
export interface DescribeLifecycleConfigurationRequest {
|
|
1709
1881
|
/**
|
|
1882
|
+
* @public
|
|
1710
1883
|
* <p>The ID of the file system whose <code>LifecycleConfiguration</code> object you want to
|
|
1711
1884
|
* retrieve (String).</p>
|
|
1712
1885
|
*/
|
|
@@ -1757,6 +1930,7 @@ export type TransitionToPrimaryStorageClassRules = (typeof TransitionToPrimarySt
|
|
|
1757
1930
|
*/
|
|
1758
1931
|
export interface LifecyclePolicy {
|
|
1759
1932
|
/**
|
|
1933
|
+
* @public
|
|
1760
1934
|
* <p>
|
|
1761
1935
|
* Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata
|
|
1762
1936
|
* operations such as listing the contents of a directory don't count as file access
|
|
@@ -1764,6 +1938,7 @@ export interface LifecyclePolicy {
|
|
|
1764
1938
|
*/
|
|
1765
1939
|
TransitionToIA?: TransitionToIARules | string;
|
|
1766
1940
|
/**
|
|
1941
|
+
* @public
|
|
1767
1942
|
* <p>Describes when to transition a file from IA storage to primary storage. Metadata
|
|
1768
1943
|
* operations such as listing the contents of a directory don't count as file access
|
|
1769
1944
|
* events.</p>
|
|
@@ -1775,6 +1950,7 @@ export interface LifecyclePolicy {
|
|
|
1775
1950
|
*/
|
|
1776
1951
|
export interface LifecycleConfigurationDescription {
|
|
1777
1952
|
/**
|
|
1953
|
+
* @public
|
|
1778
1954
|
* <p>An array of lifecycle management policies. EFS supports a maximum of one
|
|
1779
1955
|
* policy per file system.</p>
|
|
1780
1956
|
*/
|
|
@@ -1786,28 +1962,33 @@ export interface LifecycleConfigurationDescription {
|
|
|
1786
1962
|
*/
|
|
1787
1963
|
export interface DescribeMountTargetsRequest {
|
|
1788
1964
|
/**
|
|
1965
|
+
* @public
|
|
1789
1966
|
* <p>(Optional) Maximum number of mount targets to return in the response. Currently, this
|
|
1790
1967
|
* number is automatically set to
|
|
1791
1968
|
* 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.</p>
|
|
1792
1969
|
*/
|
|
1793
1970
|
MaxItems?: number;
|
|
1794
1971
|
/**
|
|
1972
|
+
* @public
|
|
1795
1973
|
* <p>(Optional) Opaque pagination token returned from a previous
|
|
1796
1974
|
* <code>DescribeMountTargets</code> operation (String). If present, it specifies to continue
|
|
1797
1975
|
* the list from where the previous returning call left off.</p>
|
|
1798
1976
|
*/
|
|
1799
1977
|
Marker?: string;
|
|
1800
1978
|
/**
|
|
1979
|
+
* @public
|
|
1801
1980
|
* <p>(Optional) ID of the file system whose mount targets you want to list (String). It must
|
|
1802
1981
|
* be included in your request if an <code>AccessPointId</code> or <code>MountTargetId</code> is not included. Accepts either a file system ID or ARN as input.</p>
|
|
1803
1982
|
*/
|
|
1804
1983
|
FileSystemId?: string;
|
|
1805
1984
|
/**
|
|
1985
|
+
* @public
|
|
1806
1986
|
* <p>(Optional) ID of the mount target that you want to have described (String). It must be
|
|
1807
1987
|
* included in your request if <code>FileSystemId</code> is not included. Accepts either a mount target ID or ARN as input.</p>
|
|
1808
1988
|
*/
|
|
1809
1989
|
MountTargetId?: string;
|
|
1810
1990
|
/**
|
|
1991
|
+
* @public
|
|
1811
1992
|
* <p>(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a
|
|
1812
1993
|
* <code>FileSystemId</code> or <code>MountTargetId</code> is not included in your request. Accepts either an access point ID or ARN as input.</p>
|
|
1813
1994
|
*/
|
|
@@ -1819,16 +2000,19 @@ export interface DescribeMountTargetsRequest {
|
|
|
1819
2000
|
*/
|
|
1820
2001
|
export interface DescribeMountTargetsResponse {
|
|
1821
2002
|
/**
|
|
2003
|
+
* @public
|
|
1822
2004
|
* <p>If the request included the <code>Marker</code>, the response returns that value in
|
|
1823
2005
|
* this field.</p>
|
|
1824
2006
|
*/
|
|
1825
2007
|
Marker?: string;
|
|
1826
2008
|
/**
|
|
2009
|
+
* @public
|
|
1827
2010
|
* <p>Returns the file system's mount targets as an array of
|
|
1828
2011
|
* <code>MountTargetDescription</code> objects.</p>
|
|
1829
2012
|
*/
|
|
1830
2013
|
MountTargets?: MountTargetDescription[];
|
|
1831
2014
|
/**
|
|
2015
|
+
* @public
|
|
1832
2016
|
* <p>If a value is present, there are more mount targets to return. In a subsequent request,
|
|
1833
2017
|
* you can provide <code>Marker</code> in your request with this value to retrieve the next set
|
|
1834
2018
|
* of mount targets.</p>
|
|
@@ -1841,6 +2025,7 @@ export interface DescribeMountTargetsResponse {
|
|
|
1841
2025
|
*/
|
|
1842
2026
|
export interface DescribeMountTargetSecurityGroupsRequest {
|
|
1843
2027
|
/**
|
|
2028
|
+
* @public
|
|
1844
2029
|
* <p>The ID of the mount target whose security groups you want to retrieve.</p>
|
|
1845
2030
|
*/
|
|
1846
2031
|
MountTargetId: string | undefined;
|
|
@@ -1850,6 +2035,7 @@ export interface DescribeMountTargetSecurityGroupsRequest {
|
|
|
1850
2035
|
*/
|
|
1851
2036
|
export interface DescribeMountTargetSecurityGroupsResponse {
|
|
1852
2037
|
/**
|
|
2038
|
+
* @public
|
|
1853
2039
|
* <p>An array of security groups.</p>
|
|
1854
2040
|
*/
|
|
1855
2041
|
SecurityGroups: string[] | undefined;
|
|
@@ -1863,11 +2049,13 @@ export declare class IncorrectMountTargetState extends __BaseException {
|
|
|
1863
2049
|
readonly name: "IncorrectMountTargetState";
|
|
1864
2050
|
readonly $fault: "client";
|
|
1865
2051
|
/**
|
|
2052
|
+
* @public
|
|
1866
2053
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1867
2054
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1868
2055
|
*/
|
|
1869
2056
|
ErrorCode: string | undefined;
|
|
1870
2057
|
/**
|
|
2058
|
+
* @public
|
|
1871
2059
|
* <p>The error message contains a generic description of the error
|
|
1872
2060
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1873
2061
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1885,11 +2073,13 @@ export declare class IncorrectMountTargetState extends __BaseException {
|
|
|
1885
2073
|
*/
|
|
1886
2074
|
export interface DescribeReplicationConfigurationsRequest {
|
|
1887
2075
|
/**
|
|
2076
|
+
* @public
|
|
1888
2077
|
* <p>You can retrieve the replication configuration for a specific file system by providing its
|
|
1889
2078
|
* file system ID.</p>
|
|
1890
2079
|
*/
|
|
1891
2080
|
FileSystemId?: string;
|
|
1892
2081
|
/**
|
|
2082
|
+
* @public
|
|
1893
2083
|
* <p>
|
|
1894
2084
|
* <code>NextToken</code> is present if the response is paginated. You can use
|
|
1895
2085
|
* <code>NextToken</code> in a subsequent request to fetch the next page of
|
|
@@ -1897,6 +2087,7 @@ export interface DescribeReplicationConfigurationsRequest {
|
|
|
1897
2087
|
*/
|
|
1898
2088
|
NextToken?: string;
|
|
1899
2089
|
/**
|
|
2090
|
+
* @public
|
|
1900
2091
|
* <p>(Optional) To limit the number of objects returned in a response, you can specify the
|
|
1901
2092
|
* <code>MaxItems</code> parameter. The default value is 100. </p>
|
|
1902
2093
|
*/
|
|
@@ -1907,10 +2098,12 @@ export interface DescribeReplicationConfigurationsRequest {
|
|
|
1907
2098
|
*/
|
|
1908
2099
|
export interface DescribeReplicationConfigurationsResponse {
|
|
1909
2100
|
/**
|
|
2101
|
+
* @public
|
|
1910
2102
|
* <p>The collection of replication configurations that is returned.</p>
|
|
1911
2103
|
*/
|
|
1912
2104
|
Replications?: ReplicationConfigurationDescription[];
|
|
1913
2105
|
/**
|
|
2106
|
+
* @public
|
|
1914
2107
|
* <p>You can use the <code>NextToken</code> from the previous response in a subsequent
|
|
1915
2108
|
* request to fetch the additional descriptions.</p>
|
|
1916
2109
|
*/
|
|
@@ -1922,18 +2115,21 @@ export interface DescribeReplicationConfigurationsResponse {
|
|
|
1922
2115
|
*/
|
|
1923
2116
|
export interface DescribeTagsRequest {
|
|
1924
2117
|
/**
|
|
2118
|
+
* @public
|
|
1925
2119
|
* <p>(Optional) The maximum number of file system tags to return in the response. Currently,
|
|
1926
2120
|
* this number is automatically set to
|
|
1927
2121
|
* 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.</p>
|
|
1928
2122
|
*/
|
|
1929
2123
|
MaxItems?: number;
|
|
1930
2124
|
/**
|
|
2125
|
+
* @public
|
|
1931
2126
|
* <p>(Optional) An opaque pagination token returned from a previous
|
|
1932
2127
|
* <code>DescribeTags</code> operation (String). If present, it specifies to continue the list
|
|
1933
2128
|
* from where the previous call left off.</p>
|
|
1934
2129
|
*/
|
|
1935
2130
|
Marker?: string;
|
|
1936
2131
|
/**
|
|
2132
|
+
* @public
|
|
1937
2133
|
* <p>The ID of the file system whose tag set you want to retrieve.</p>
|
|
1938
2134
|
*/
|
|
1939
2135
|
FileSystemId: string | undefined;
|
|
@@ -1944,16 +2140,19 @@ export interface DescribeTagsRequest {
|
|
|
1944
2140
|
*/
|
|
1945
2141
|
export interface DescribeTagsResponse {
|
|
1946
2142
|
/**
|
|
2143
|
+
* @public
|
|
1947
2144
|
* <p>If the request included a <code>Marker</code>, the response returns that value in this
|
|
1948
2145
|
* field.</p>
|
|
1949
2146
|
*/
|
|
1950
2147
|
Marker?: string;
|
|
1951
2148
|
/**
|
|
2149
|
+
* @public
|
|
1952
2150
|
* <p>Returns tags associated with the file system as an array of <code>Tag</code> objects.
|
|
1953
2151
|
* </p>
|
|
1954
2152
|
*/
|
|
1955
2153
|
Tags: Tag[] | undefined;
|
|
1956
2154
|
/**
|
|
2155
|
+
* @public
|
|
1957
2156
|
* <p>If a value is present, there are more tags to return. In a subsequent request, you can
|
|
1958
2157
|
* provide the value of <code>NextMarker</code> as the value of the <code>Marker</code> parameter
|
|
1959
2158
|
* in your next request to retrieve the next set of tags.</p>
|
|
@@ -1970,11 +2169,13 @@ export declare class InvalidPolicyException extends __BaseException {
|
|
|
1970
2169
|
readonly name: "InvalidPolicyException";
|
|
1971
2170
|
readonly $fault: "client";
|
|
1972
2171
|
/**
|
|
2172
|
+
* @public
|
|
1973
2173
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
1974
2174
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
1975
2175
|
*/
|
|
1976
2176
|
ErrorCode?: string;
|
|
1977
2177
|
/**
|
|
2178
|
+
* @public
|
|
1978
2179
|
* <p>The error message contains a generic description of the error
|
|
1979
2180
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
1980
2181
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -1992,14 +2193,17 @@ export declare class InvalidPolicyException extends __BaseException {
|
|
|
1992
2193
|
*/
|
|
1993
2194
|
export interface ListTagsForResourceRequest {
|
|
1994
2195
|
/**
|
|
2196
|
+
* @public
|
|
1995
2197
|
* <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>
|
|
1996
2198
|
*/
|
|
1997
2199
|
ResourceId: string | undefined;
|
|
1998
2200
|
/**
|
|
2201
|
+
* @public
|
|
1999
2202
|
* <p>(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.</p>
|
|
2000
2203
|
*/
|
|
2001
2204
|
MaxResults?: number;
|
|
2002
2205
|
/**
|
|
2206
|
+
* @public
|
|
2003
2207
|
* <p>(Optional) You can use <code>NextToken</code> in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.</p>
|
|
2004
2208
|
*/
|
|
2005
2209
|
NextToken?: string;
|
|
@@ -2009,10 +2213,12 @@ export interface ListTagsForResourceRequest {
|
|
|
2009
2213
|
*/
|
|
2010
2214
|
export interface ListTagsForResourceResponse {
|
|
2011
2215
|
/**
|
|
2216
|
+
* @public
|
|
2012
2217
|
* <p>An array of the tags for the specified EFS resource.</p>
|
|
2013
2218
|
*/
|
|
2014
2219
|
Tags?: Tag[];
|
|
2015
2220
|
/**
|
|
2221
|
+
* @public
|
|
2016
2222
|
* <p>
|
|
2017
2223
|
* <code>NextToken</code> is present if the response payload is paginated. You can use <code>NextToken</code> in a subsequent request to fetch the next page of access point descriptions.</p>
|
|
2018
2224
|
*/
|
|
@@ -2024,10 +2230,12 @@ export interface ListTagsForResourceResponse {
|
|
|
2024
2230
|
*/
|
|
2025
2231
|
export interface ModifyMountTargetSecurityGroupsRequest {
|
|
2026
2232
|
/**
|
|
2233
|
+
* @public
|
|
2027
2234
|
* <p>The ID of the mount target whose security groups you want to modify.</p>
|
|
2028
2235
|
*/
|
|
2029
2236
|
MountTargetId: string | undefined;
|
|
2030
2237
|
/**
|
|
2238
|
+
* @public
|
|
2031
2239
|
* <p>An array of up to five VPC security group IDs.</p>
|
|
2032
2240
|
*/
|
|
2033
2241
|
SecurityGroups?: string[];
|
|
@@ -2037,6 +2245,7 @@ export interface ModifyMountTargetSecurityGroupsRequest {
|
|
|
2037
2245
|
*/
|
|
2038
2246
|
export interface PutAccountPreferencesRequest {
|
|
2039
2247
|
/**
|
|
2248
|
+
* @public
|
|
2040
2249
|
* <p>Specifies the EFS resource ID preference to set for the user's Amazon Web Services account,
|
|
2041
2250
|
* in the current Amazon Web Services Region, either <code>LONG_ID</code> (17 characters), or
|
|
2042
2251
|
* <code>SHORT_ID</code> (8 characters).</p>
|
|
@@ -2053,6 +2262,7 @@ export interface PutAccountPreferencesRequest {
|
|
|
2053
2262
|
*/
|
|
2054
2263
|
export interface PutAccountPreferencesResponse {
|
|
2055
2264
|
/**
|
|
2265
|
+
* @public
|
|
2056
2266
|
* <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>
|
|
2057
2267
|
*/
|
|
2058
2268
|
ResourceIdPreference?: ResourceIdPreference;
|
|
@@ -2062,10 +2272,12 @@ export interface PutAccountPreferencesResponse {
|
|
|
2062
2272
|
*/
|
|
2063
2273
|
export interface PutBackupPolicyRequest {
|
|
2064
2274
|
/**
|
|
2275
|
+
* @public
|
|
2065
2276
|
* <p>Specifies which EFS file system to update the backup policy for.</p>
|
|
2066
2277
|
*/
|
|
2067
2278
|
FileSystemId: string | undefined;
|
|
2068
2279
|
/**
|
|
2280
|
+
* @public
|
|
2069
2281
|
* <p>The backup policy included in the <code>PutBackupPolicy</code> request.</p>
|
|
2070
2282
|
*/
|
|
2071
2283
|
BackupPolicy: BackupPolicy | undefined;
|
|
@@ -2075,10 +2287,12 @@ export interface PutBackupPolicyRequest {
|
|
|
2075
2287
|
*/
|
|
2076
2288
|
export interface PutFileSystemPolicyRequest {
|
|
2077
2289
|
/**
|
|
2290
|
+
* @public
|
|
2078
2291
|
* <p>The ID of the EFS file system that you want to create or update the <code>FileSystemPolicy</code> for.</p>
|
|
2079
2292
|
*/
|
|
2080
2293
|
FileSystemId: string | undefined;
|
|
2081
2294
|
/**
|
|
2295
|
+
* @public
|
|
2082
2296
|
* <p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted policy definition.
|
|
2083
2297
|
* EFS file system policies have a 20,000 character limit.
|
|
2084
2298
|
* To find out more about the elements that make up a file system policy, see
|
|
@@ -2087,6 +2301,7 @@ export interface PutFileSystemPolicyRequest {
|
|
|
2087
2301
|
*/
|
|
2088
2302
|
Policy: string | undefined;
|
|
2089
2303
|
/**
|
|
2304
|
+
* @public
|
|
2090
2305
|
* <p>(Optional) A boolean that specifies whether or not to bypass the <code>FileSystemPolicy</code> lockout safety check. The lockout safety check
|
|
2091
2306
|
* determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future <code>PutFileSystemPolicy</code> requests on this file system.
|
|
2092
2307
|
* Set <code>BypassPolicyLockoutSafetyCheck</code> to <code>True</code> only when you intend to prevent
|
|
@@ -2101,11 +2316,13 @@ export interface PutFileSystemPolicyRequest {
|
|
|
2101
2316
|
*/
|
|
2102
2317
|
export interface PutLifecycleConfigurationRequest {
|
|
2103
2318
|
/**
|
|
2319
|
+
* @public
|
|
2104
2320
|
* <p>The ID of the file system for which you are creating the
|
|
2105
2321
|
* <code>LifecycleConfiguration</code> object (String).</p>
|
|
2106
2322
|
*/
|
|
2107
2323
|
FileSystemId: string | undefined;
|
|
2108
2324
|
/**
|
|
2325
|
+
* @public
|
|
2109
2326
|
* <p>An array of <code>LifecyclePolicy</code> objects that define the file system's
|
|
2110
2327
|
* <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object
|
|
2111
2328
|
* informs EFS lifecycle management and EFS Intelligent-Tiering of the following:</p>
|
|
@@ -2134,10 +2351,12 @@ export interface PutLifecycleConfigurationRequest {
|
|
|
2134
2351
|
*/
|
|
2135
2352
|
export interface TagResourceRequest {
|
|
2136
2353
|
/**
|
|
2354
|
+
* @public
|
|
2137
2355
|
* <p>The ID specifying the EFS resource that you want to create a tag for.</p>
|
|
2138
2356
|
*/
|
|
2139
2357
|
ResourceId: string | undefined;
|
|
2140
2358
|
/**
|
|
2359
|
+
* @public
|
|
2141
2360
|
* <p>An array of <code>Tag</code> objects to add. Each <code>Tag</code> object is a key-value
|
|
2142
2361
|
* pair.</p>
|
|
2143
2362
|
*/
|
|
@@ -2148,10 +2367,12 @@ export interface TagResourceRequest {
|
|
|
2148
2367
|
*/
|
|
2149
2368
|
export interface UntagResourceRequest {
|
|
2150
2369
|
/**
|
|
2370
|
+
* @public
|
|
2151
2371
|
* <p>Specifies the EFS resource that you want to remove tags from.</p>
|
|
2152
2372
|
*/
|
|
2153
2373
|
ResourceId: string | undefined;
|
|
2154
2374
|
/**
|
|
2375
|
+
* @public
|
|
2155
2376
|
* <p>The keys of the key-value tag pairs that you want to remove from the specified EFS
|
|
2156
2377
|
* resource.</p>
|
|
2157
2378
|
*/
|
|
@@ -2166,11 +2387,13 @@ export declare class TooManyRequests extends __BaseException {
|
|
|
2166
2387
|
readonly name: "TooManyRequests";
|
|
2167
2388
|
readonly $fault: "client";
|
|
2168
2389
|
/**
|
|
2390
|
+
* @public
|
|
2169
2391
|
* <p>The error code is a string that uniquely identifies an error condition.
|
|
2170
2392
|
* It is meant to be read and understood by programs that detect and handle errors by type. </p>
|
|
2171
2393
|
*/
|
|
2172
2394
|
ErrorCode: string | undefined;
|
|
2173
2395
|
/**
|
|
2396
|
+
* @public
|
|
2174
2397
|
* <p>The error message contains a generic description of the error
|
|
2175
2398
|
* condition in English. It is intended for a human audience. Simple programs display the message directly
|
|
2176
2399
|
* to the end user if they encounter an error condition they don't know how or don't care to handle.
|
|
@@ -2188,10 +2411,12 @@ export declare class TooManyRequests extends __BaseException {
|
|
|
2188
2411
|
*/
|
|
2189
2412
|
export interface UpdateFileSystemRequest {
|
|
2190
2413
|
/**
|
|
2414
|
+
* @public
|
|
2191
2415
|
* <p>The ID of the file system that you want to update.</p>
|
|
2192
2416
|
*/
|
|
2193
2417
|
FileSystemId: string | undefined;
|
|
2194
2418
|
/**
|
|
2419
|
+
* @public
|
|
2195
2420
|
* <p>(Optional) Updates the file system's throughput mode. If you're not
|
|
2196
2421
|
* updating your throughput mode, you don't need to provide this value in your
|
|
2197
2422
|
* request. If you are changing the <code>ThroughputMode</code> to <code>provisioned</code>,
|
|
@@ -2199,6 +2424,7 @@ export interface UpdateFileSystemRequest {
|
|
|
2199
2424
|
*/
|
|
2200
2425
|
ThroughputMode?: ThroughputMode | string;
|
|
2201
2426
|
/**
|
|
2427
|
+
* @public
|
|
2202
2428
|
* <p>(Optional) Sets the amount of provisioned throughput, in MiB/s, for the file
|
|
2203
2429
|
* system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also
|
|
2204
2430
|
* provide the amount of provisioned throughput. Required if <code>ThroughputMode</code> is changed
|