aws-sdk-efs 1.49.0 → 1.67.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +93 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-efs/client.rb +404 -90
- data/lib/aws-sdk-efs/client_api.rb +110 -0
- data/lib/aws-sdk-efs/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-efs/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-efs/endpoints.rb +436 -0
- data/lib/aws-sdk-efs/errors.rb +42 -0
- data/lib/aws-sdk-efs/plugins/endpoints.rb +128 -0
- data/lib/aws-sdk-efs/types.rb +638 -391
- data/lib/aws-sdk-efs.rb +5 -1
- metadata +8 -4
data/lib/aws-sdk-efs/types.rb
CHANGED
@@ -10,13 +10,23 @@
|
|
10
10
|
module Aws::EFS
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Returned if the access point you are trying to create already
|
14
|
-
# with the creation token you provided in the request.
|
13
|
+
# Returned if the access point that you are trying to create already
|
14
|
+
# exists, with the creation token you provided in the request.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] error_code
|
17
|
+
# The error code is a string that uniquely identifies an error
|
18
|
+
# condition. It is meant to be read and understood by programs that
|
19
|
+
# detect and handle errors by type.
|
17
20
|
# @return [String]
|
18
21
|
#
|
19
22
|
# @!attribute [rw] message
|
23
|
+
# The error message contains a generic description of the error
|
24
|
+
# condition in English. It is intended for a human audience. Simple
|
25
|
+
# programs display the message directly to the end user if they
|
26
|
+
# encounter an error condition they don't know how or don't care to
|
27
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
28
|
+
# and proper internationalization are more likely to ignore the error
|
29
|
+
# message.
|
20
30
|
# @return [String]
|
21
31
|
#
|
22
32
|
# @!attribute [rw] access_point_id
|
@@ -73,7 +83,7 @@ module Aws::EFS
|
|
73
83
|
# @return [Types::RootDirectory]
|
74
84
|
#
|
75
85
|
# @!attribute [rw] owner_id
|
76
|
-
#
|
86
|
+
# Identifies the Amazon Web Services account that owns the access
|
77
87
|
# point resource.
|
78
88
|
# @return [String]
|
79
89
|
#
|
@@ -99,12 +109,28 @@ module Aws::EFS
|
|
99
109
|
end
|
100
110
|
|
101
111
|
# Returned if the Amazon Web Services account has already created the
|
102
|
-
# maximum number of access points allowed per file system.
|
112
|
+
# maximum number of access points allowed per file system. For more
|
113
|
+
# informaton, see
|
114
|
+
# [https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region][1].
|
115
|
+
#
|
116
|
+
#
|
117
|
+
#
|
118
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region
|
103
119
|
#
|
104
120
|
# @!attribute [rw] error_code
|
121
|
+
# The error code is a string that uniquely identifies an error
|
122
|
+
# condition. It is meant to be read and understood by programs that
|
123
|
+
# detect and handle errors by type.
|
105
124
|
# @return [String]
|
106
125
|
#
|
107
126
|
# @!attribute [rw] message
|
127
|
+
# The error message contains a generic description of the error
|
128
|
+
# condition in English. It is intended for a human audience. Simple
|
129
|
+
# programs display the message directly to the end user if they
|
130
|
+
# encounter an error condition they don't know how or don't care to
|
131
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
132
|
+
# and proper internationalization are more likely to ignore the error
|
133
|
+
# message.
|
108
134
|
# @return [String]
|
109
135
|
#
|
110
136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/AccessPointLimitExceeded AWS API Documentation
|
@@ -120,9 +146,19 @@ module Aws::EFS
|
|
120
146
|
# requester's Amazon Web Services account.
|
121
147
|
#
|
122
148
|
# @!attribute [rw] error_code
|
149
|
+
# The error code is a string that uniquely identifies an error
|
150
|
+
# condition. It is meant to be read and understood by programs that
|
151
|
+
# detect and handle errors by type.
|
123
152
|
# @return [String]
|
124
153
|
#
|
125
154
|
# @!attribute [rw] message
|
155
|
+
# The error message contains a generic description of the error
|
156
|
+
# condition in English. It is intended for a human audience. Simple
|
157
|
+
# programs display the message directly to the end user if they
|
158
|
+
# encounter an error condition they don't know how or don't care to
|
159
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
160
|
+
# and proper internationalization are more likely to ignore the error
|
161
|
+
# message.
|
126
162
|
# @return [String]
|
127
163
|
#
|
128
164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/AccessPointNotFound AWS API Documentation
|
@@ -136,17 +172,27 @@ module Aws::EFS
|
|
136
172
|
|
137
173
|
# Returned if the Availability Zone that was specified for a mount
|
138
174
|
# target is different from the Availability Zone that was specified for
|
139
|
-
# One Zone storage
|
140
|
-
#
|
175
|
+
# One Zone storage. For more information, see [Regional and One Zone
|
176
|
+
# storage redundancy][1].
|
141
177
|
#
|
142
178
|
#
|
143
179
|
#
|
144
180
|
# [1]: https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html
|
145
181
|
#
|
146
182
|
# @!attribute [rw] error_code
|
183
|
+
# The error code is a string that uniquely identifies an error
|
184
|
+
# condition. It is meant to be read and understood by programs that
|
185
|
+
# detect and handle errors by type.
|
147
186
|
# @return [String]
|
148
187
|
#
|
149
188
|
# @!attribute [rw] message
|
189
|
+
# The error message contains a generic description of the error
|
190
|
+
# condition in English. It is intended for a human audience. Simple
|
191
|
+
# programs display the message directly to the end user if they
|
192
|
+
# encounter an error condition they don't know how or don't care to
|
193
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
194
|
+
# and proper internationalization are more likely to ignore the error
|
195
|
+
# message.
|
150
196
|
# @return [String]
|
151
197
|
#
|
152
198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/AvailabilityZonesMismatch AWS API Documentation
|
@@ -167,13 +213,6 @@ module Aws::EFS
|
|
167
213
|
#
|
168
214
|
# [1]: https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups
|
169
215
|
#
|
170
|
-
# @note When making an API call, you may pass BackupPolicy
|
171
|
-
# data as a hash:
|
172
|
-
#
|
173
|
-
# {
|
174
|
-
# status: "ENABLED", # required, accepts ENABLED, ENABLING, DISABLED, DISABLING
|
175
|
-
# }
|
176
|
-
#
|
177
216
|
# @!attribute [rw] status
|
178
217
|
# Describes the status of the file system's backup policy.
|
179
218
|
#
|
@@ -183,7 +222,7 @@ module Aws::EFS
|
|
183
222
|
# * <b> <code>ENABLING</code> </b> - EFS is turning on automatic
|
184
223
|
# backups for the file system.
|
185
224
|
#
|
186
|
-
# * <b> <code>DISABLED</code> </b> -
|
225
|
+
# * <b> <code>DISABLED</code> </b> - Automatic back ups are turned off
|
187
226
|
# for the file system.
|
188
227
|
#
|
189
228
|
# * <b> <code>DISABLING</code> </b> - EFS is turning off automatic
|
@@ -200,7 +239,7 @@ module Aws::EFS
|
|
200
239
|
|
201
240
|
# @!attribute [rw] backup_policy
|
202
241
|
# Describes the file system's backup policy, indicating whether
|
203
|
-
# automatic backups are turned on or off
|
242
|
+
# automatic backups are turned on or off.
|
204
243
|
# @return [Types::BackupPolicy]
|
205
244
|
#
|
206
245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/BackupPolicyDescription AWS API Documentation
|
@@ -215,9 +254,19 @@ module Aws::EFS
|
|
215
254
|
# invalid parameter value or a missing required parameter.
|
216
255
|
#
|
217
256
|
# @!attribute [rw] error_code
|
257
|
+
# The error code is a string that uniquely identifies an error
|
258
|
+
# condition. It is meant to be read and understood by programs that
|
259
|
+
# detect and handle errors by type.
|
218
260
|
# @return [String]
|
219
261
|
#
|
220
262
|
# @!attribute [rw] message
|
263
|
+
# The error message contains a generic description of the error
|
264
|
+
# condition in English. It is intended for a human audience. Simple
|
265
|
+
# programs display the message directly to the end user if they
|
266
|
+
# encounter an error condition they don't know how or don't care to
|
267
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
268
|
+
# and proper internationalization are more likely to ignore the error
|
269
|
+
# message.
|
221
270
|
# @return [String]
|
222
271
|
#
|
223
272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/BadRequest AWS API Documentation
|
@@ -229,33 +278,6 @@ module Aws::EFS
|
|
229
278
|
include Aws::Structure
|
230
279
|
end
|
231
280
|
|
232
|
-
# @note When making an API call, you may pass CreateAccessPointRequest
|
233
|
-
# data as a hash:
|
234
|
-
#
|
235
|
-
# {
|
236
|
-
# client_token: "ClientToken", # required
|
237
|
-
# tags: [
|
238
|
-
# {
|
239
|
-
# key: "TagKey", # required
|
240
|
-
# value: "TagValue", # required
|
241
|
-
# },
|
242
|
-
# ],
|
243
|
-
# file_system_id: "FileSystemId", # required
|
244
|
-
# posix_user: {
|
245
|
-
# uid: 1, # required
|
246
|
-
# gid: 1, # required
|
247
|
-
# secondary_gids: [1],
|
248
|
-
# },
|
249
|
-
# root_directory: {
|
250
|
-
# path: "Path",
|
251
|
-
# creation_info: {
|
252
|
-
# owner_uid: 1, # required
|
253
|
-
# owner_gid: 1, # required
|
254
|
-
# permissions: "Permissions", # required
|
255
|
-
# },
|
256
|
-
# },
|
257
|
-
# }
|
258
|
-
#
|
259
281
|
# @!attribute [rw] client_token
|
260
282
|
# A string of up to 64 ASCII characters that Amazon EFS uses to ensure
|
261
283
|
# idempotent creation.
|
@@ -292,7 +314,7 @@ module Aws::EFS
|
|
292
314
|
# point can only access the root directory and below. If the
|
293
315
|
# `RootDirectory` > `Path` specified does not exist, EFS creates it
|
294
316
|
# and applies the `CreationInfo` settings when a client connects to an
|
295
|
-
# access point. When specifying a `RootDirectory`, you
|
317
|
+
# access point. When specifying a `RootDirectory`, you must provide
|
296
318
|
# the `Path`, and the `CreationInfo`.
|
297
319
|
#
|
298
320
|
# Amazon EFS creates a root directory only if you have provided the
|
@@ -314,26 +336,6 @@ module Aws::EFS
|
|
314
336
|
include Aws::Structure
|
315
337
|
end
|
316
338
|
|
317
|
-
# @note When making an API call, you may pass CreateFileSystemRequest
|
318
|
-
# data as a hash:
|
319
|
-
#
|
320
|
-
# {
|
321
|
-
# creation_token: "CreationToken", # required
|
322
|
-
# performance_mode: "generalPurpose", # accepts generalPurpose, maxIO
|
323
|
-
# encrypted: false,
|
324
|
-
# kms_key_id: "KmsKeyId",
|
325
|
-
# throughput_mode: "bursting", # accepts bursting, provisioned
|
326
|
-
# provisioned_throughput_in_mibps: 1.0,
|
327
|
-
# availability_zone_name: "AvailabilityZoneName",
|
328
|
-
# backup: false,
|
329
|
-
# tags: [
|
330
|
-
# {
|
331
|
-
# key: "TagKey", # required
|
332
|
-
# value: "TagValue", # required
|
333
|
-
# },
|
334
|
-
# ],
|
335
|
-
# }
|
336
|
-
#
|
337
339
|
# @!attribute [rw] creation_token
|
338
340
|
# A string of up to 64 ASCII characters. Amazon EFS uses this to
|
339
341
|
# ensure idempotent creation.
|
@@ -355,24 +357,25 @@ module Aws::EFS
|
|
355
357
|
# storage classes.
|
356
358
|
#
|
357
359
|
# </note>
|
360
|
+
#
|
361
|
+
# Default is `generalPurpose`.
|
358
362
|
# @return [String]
|
359
363
|
#
|
360
364
|
# @!attribute [rw] encrypted
|
361
365
|
# A Boolean value that, if true, creates an encrypted file system.
|
362
366
|
# When creating an encrypted file system, you have the option of
|
363
|
-
# specifying
|
364
|
-
#
|
365
|
-
# specify a CMK, then the default CMK for Amazon EFS,
|
367
|
+
# specifying an existing Key Management Service key (KMS key). If you
|
368
|
+
# don't specify a KMS key, then the default KMS key for Amazon EFS,
|
366
369
|
# `/aws/elasticfilesystem`, is used to protect the encrypted file
|
367
370
|
# system.
|
368
371
|
# @return [Boolean]
|
369
372
|
#
|
370
373
|
# @!attribute [rw] kms_key_id
|
371
|
-
# The ID of the KMS
|
372
|
-
# file system. This parameter is only
|
374
|
+
# The ID of the KMS key that you want to use to protect the encrypted
|
375
|
+
# file system. This parameter is required only if you want to use a
|
373
376
|
# non-default KMS key. If this parameter is not specified, the default
|
374
|
-
#
|
375
|
-
# formats:
|
377
|
+
# KMS key for Amazon EFS is used. You can specify a KMS key ID using
|
378
|
+
# the following formats:
|
376
379
|
#
|
377
380
|
# * Key ID - A unique identifier of the key, for example
|
378
381
|
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
@@ -386,23 +389,22 @@ module Aws::EFS
|
|
386
389
|
# * Key alias ARN - An ARN for a key alias, for example
|
387
390
|
# `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.
|
388
391
|
#
|
389
|
-
# If `KmsKeyId
|
390
|
-
# parameter
|
392
|
+
# If you use `KmsKeyId`, you must set the
|
393
|
+
# CreateFileSystemRequest$Encrypted parameter to true.
|
391
394
|
#
|
392
395
|
# EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS
|
393
|
-
# keys with EFS file systems.
|
396
|
+
# keys with Amazon EFS file systems.
|
394
397
|
# @return [String]
|
395
398
|
#
|
396
399
|
# @!attribute [rw] throughput_mode
|
397
|
-
# Specifies the throughput mode for the file system
|
398
|
-
# or `
|
399
|
-
# must also set a value for
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
# User Guide*.
|
400
|
+
# Specifies the throughput mode for the file system. The mode can be
|
401
|
+
# `bursting`, `provisioned`, or `elastic`. If you set `ThroughputMode`
|
402
|
+
# to `provisioned`, you must also set a value for
|
403
|
+
# `ProvisionedThroughputInMibps`. After you create the file system,
|
404
|
+
# you can decrease your file system's throughput in Provisioned
|
405
|
+
# Throughput mode or change between the throughput modes, with certain
|
406
|
+
# time restrictions. For more information, see [Specifying throughput
|
407
|
+
# with provisioned mode][1] in the *Amazon EFS User Guide*.
|
406
408
|
#
|
407
409
|
# Default is `bursting`.
|
408
410
|
#
|
@@ -412,12 +414,13 @@ module Aws::EFS
|
|
412
414
|
# @return [String]
|
413
415
|
#
|
414
416
|
# @!attribute [rw] provisioned_throughput_in_mibps
|
415
|
-
# The throughput, measured in
|
416
|
-
# file system that you're creating.
|
417
|
-
# if `ThroughputMode` is set to `provisioned`.
|
418
|
-
#
|
419
|
-
# Services Support. For more information,
|
420
|
-
# you can increase][1] in the *Amazon EFS
|
417
|
+
# The throughput, measured in mebibytes per second (MiBps), that you
|
418
|
+
# want to provision for a file system that you're creating. Required
|
419
|
+
# if `ThroughputMode` is set to `provisioned`. Valid values are 1-3414
|
420
|
+
# MiBps, with the upper limit depending on Region. To increase this
|
421
|
+
# limit, contact Amazon Web Services Support. For more information,
|
422
|
+
# see [Amazon EFS quotas that you can increase][1] in the *Amazon EFS
|
423
|
+
# User Guide*.
|
421
424
|
#
|
422
425
|
#
|
423
426
|
#
|
@@ -453,7 +456,7 @@ module Aws::EFS
|
|
453
456
|
# Default is `false`. However, if you specify an
|
454
457
|
# `AvailabilityZoneName`, the default is `true`.
|
455
458
|
#
|
456
|
-
# <note markdown="1"> Backup is not available in all Amazon Web Services
|
459
|
+
# <note markdown="1"> Backup is not available in all Amazon Web Services Regions where
|
457
460
|
# Amazon EFS is available.
|
458
461
|
#
|
459
462
|
# </note>
|
@@ -492,16 +495,6 @@ module Aws::EFS
|
|
492
495
|
include Aws::Structure
|
493
496
|
end
|
494
497
|
|
495
|
-
# @note When making an API call, you may pass CreateMountTargetRequest
|
496
|
-
# data as a hash:
|
497
|
-
#
|
498
|
-
# {
|
499
|
-
# file_system_id: "FileSystemId", # required
|
500
|
-
# subnet_id: "SubnetId", # required
|
501
|
-
# ip_address: "IpAddress",
|
502
|
-
# security_groups: ["SecurityGroup"],
|
503
|
-
# }
|
504
|
-
#
|
505
498
|
# @!attribute [rw] file_system_id
|
506
499
|
# The ID of the file system for which to create the mount target.
|
507
500
|
# @return [String]
|
@@ -532,19 +525,26 @@ module Aws::EFS
|
|
532
525
|
include Aws::Structure
|
533
526
|
end
|
534
527
|
|
535
|
-
#
|
536
|
-
#
|
528
|
+
# @!attribute [rw] source_file_system_id
|
529
|
+
# Specifies the Amazon EFS file system that you want to replicate.
|
530
|
+
# This file system cannot already be a source or destination file
|
531
|
+
# system in another replication configuration.
|
532
|
+
# @return [String]
|
537
533
|
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
# key: "TagKey", # required
|
543
|
-
# value: "TagValue", # required
|
544
|
-
# },
|
545
|
-
# ],
|
546
|
-
# }
|
534
|
+
# @!attribute [rw] destinations
|
535
|
+
# An array of destination configuration objects. Only one destination
|
536
|
+
# configuration object is supported.
|
537
|
+
# @return [Array<Types::DestinationToCreate>]
|
547
538
|
#
|
539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateReplicationConfigurationRequest AWS API Documentation
|
540
|
+
#
|
541
|
+
class CreateReplicationConfigurationRequest < Struct.new(
|
542
|
+
:source_file_system_id,
|
543
|
+
:destinations)
|
544
|
+
SENSITIVE = []
|
545
|
+
include Aws::Structure
|
546
|
+
end
|
547
|
+
|
548
548
|
# @!attribute [rw] file_system_id
|
549
549
|
# The ID of the file system whose tags you want to modify (String).
|
550
550
|
# This operation modifies the tags only, not the file system.
|
@@ -581,15 +581,6 @@ module Aws::EFS
|
|
581
581
|
# does not exist, attempts to mount the file system using the access
|
582
582
|
# point will fail.
|
583
583
|
#
|
584
|
-
# @note When making an API call, you may pass CreationInfo
|
585
|
-
# data as a hash:
|
586
|
-
#
|
587
|
-
# {
|
588
|
-
# owner_uid: 1, # required
|
589
|
-
# owner_gid: 1, # required
|
590
|
-
# permissions: "Permissions", # required
|
591
|
-
# }
|
592
|
-
#
|
593
584
|
# @!attribute [rw] owner_uid
|
594
585
|
# Specifies the POSIX user ID to apply to the `RootDirectory`. Accepts
|
595
586
|
# values from 0 to 2^32 (4294967295).
|
@@ -615,13 +606,6 @@ module Aws::EFS
|
|
615
606
|
include Aws::Structure
|
616
607
|
end
|
617
608
|
|
618
|
-
# @note When making an API call, you may pass DeleteAccessPointRequest
|
619
|
-
# data as a hash:
|
620
|
-
#
|
621
|
-
# {
|
622
|
-
# access_point_id: "AccessPointId", # required
|
623
|
-
# }
|
624
|
-
#
|
625
609
|
# @!attribute [rw] access_point_id
|
626
610
|
# The ID of the access point that you want to delete.
|
627
611
|
# @return [String]
|
@@ -634,13 +618,6 @@ module Aws::EFS
|
|
634
618
|
include Aws::Structure
|
635
619
|
end
|
636
620
|
|
637
|
-
# @note When making an API call, you may pass DeleteFileSystemPolicyRequest
|
638
|
-
# data as a hash:
|
639
|
-
#
|
640
|
-
# {
|
641
|
-
# file_system_id: "FileSystemId", # required
|
642
|
-
# }
|
643
|
-
#
|
644
621
|
# @!attribute [rw] file_system_id
|
645
622
|
# Specifies the EFS file system for which to delete the
|
646
623
|
# `FileSystemPolicy`.
|
@@ -654,13 +631,6 @@ module Aws::EFS
|
|
654
631
|
include Aws::Structure
|
655
632
|
end
|
656
633
|
|
657
|
-
# @note When making an API call, you may pass DeleteFileSystemRequest
|
658
|
-
# data as a hash:
|
659
|
-
#
|
660
|
-
# {
|
661
|
-
# file_system_id: "FileSystemId", # required
|
662
|
-
# }
|
663
|
-
#
|
664
634
|
# @!attribute [rw] file_system_id
|
665
635
|
# The ID of the file system you want to delete.
|
666
636
|
# @return [String]
|
@@ -673,13 +643,6 @@ module Aws::EFS
|
|
673
643
|
include Aws::Structure
|
674
644
|
end
|
675
645
|
|
676
|
-
# @note When making an API call, you may pass DeleteMountTargetRequest
|
677
|
-
# data as a hash:
|
678
|
-
#
|
679
|
-
# {
|
680
|
-
# mount_target_id: "MountTargetId", # required
|
681
|
-
# }
|
682
|
-
#
|
683
646
|
# @!attribute [rw] mount_target_id
|
684
647
|
# The ID of the mount target to delete (String).
|
685
648
|
# @return [String]
|
@@ -692,14 +655,18 @@ module Aws::EFS
|
|
692
655
|
include Aws::Structure
|
693
656
|
end
|
694
657
|
|
695
|
-
#
|
696
|
-
#
|
658
|
+
# @!attribute [rw] source_file_system_id
|
659
|
+
# The ID of the source file system in the replication configuration.
|
660
|
+
# @return [String]
|
697
661
|
#
|
698
|
-
#
|
699
|
-
# file_system_id: "FileSystemId", # required
|
700
|
-
# tag_keys: ["TagKey"], # required
|
701
|
-
# }
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteReplicationConfigurationRequest AWS API Documentation
|
702
663
|
#
|
664
|
+
class DeleteReplicationConfigurationRequest < Struct.new(
|
665
|
+
:source_file_system_id)
|
666
|
+
SENSITIVE = []
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
703
670
|
# @!attribute [rw] file_system_id
|
704
671
|
# The ID of the file system whose tags you want to delete (String).
|
705
672
|
# @return [String]
|
@@ -721,9 +688,19 @@ module Aws::EFS
|
|
721
688
|
# should try the call again.
|
722
689
|
#
|
723
690
|
# @!attribute [rw] error_code
|
691
|
+
# The error code is a string that uniquely identifies an error
|
692
|
+
# condition. It is meant to be read and understood by programs that
|
693
|
+
# detect and handle errors by type.
|
724
694
|
# @return [String]
|
725
695
|
#
|
726
696
|
# @!attribute [rw] message
|
697
|
+
# The error message contains a generic description of the error
|
698
|
+
# condition in English. It is intended for a human audience. Simple
|
699
|
+
# programs display the message directly to the end user if they
|
700
|
+
# encounter an error condition they don't know how or don't care to
|
701
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
702
|
+
# and proper internationalization are more likely to ignore the error
|
703
|
+
# message.
|
727
704
|
# @return [String]
|
728
705
|
#
|
729
706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DependencyTimeout AWS API Documentation
|
@@ -735,16 +712,6 @@ module Aws::EFS
|
|
735
712
|
include Aws::Structure
|
736
713
|
end
|
737
714
|
|
738
|
-
# @note When making an API call, you may pass DescribeAccessPointsRequest
|
739
|
-
# data as a hash:
|
740
|
-
#
|
741
|
-
# {
|
742
|
-
# max_results: 1,
|
743
|
-
# next_token: "Token",
|
744
|
-
# access_point_id: "AccessPointId",
|
745
|
-
# file_system_id: "FileSystemId",
|
746
|
-
# }
|
747
|
-
#
|
748
715
|
# @!attribute [rw] max_results
|
749
716
|
# (Optional) When retrieving all access points for a file system, you
|
750
717
|
# can optionally specify the `MaxItems` parameter to limit the number
|
@@ -798,14 +765,6 @@ module Aws::EFS
|
|
798
765
|
include Aws::Structure
|
799
766
|
end
|
800
767
|
|
801
|
-
# @note When making an API call, you may pass DescribeAccountPreferencesRequest
|
802
|
-
# data as a hash:
|
803
|
-
#
|
804
|
-
# {
|
805
|
-
# next_token: "Token",
|
806
|
-
# max_results: 1,
|
807
|
-
# }
|
808
|
-
#
|
809
768
|
# @!attribute [rw] next_token
|
810
769
|
# (Optional) You can use `NextToken` in a subsequent request to fetch
|
811
770
|
# the next page of Amazon Web Services account preferences if the
|
@@ -848,13 +807,6 @@ module Aws::EFS
|
|
848
807
|
include Aws::Structure
|
849
808
|
end
|
850
809
|
|
851
|
-
# @note When making an API call, you may pass DescribeBackupPolicyRequest
|
852
|
-
# data as a hash:
|
853
|
-
#
|
854
|
-
# {
|
855
|
-
# file_system_id: "FileSystemId", # required
|
856
|
-
# }
|
857
|
-
#
|
858
810
|
# @!attribute [rw] file_system_id
|
859
811
|
# Specifies which EFS file system to retrieve the `BackupPolicy` for.
|
860
812
|
# @return [String]
|
@@ -867,13 +819,6 @@ module Aws::EFS
|
|
867
819
|
include Aws::Structure
|
868
820
|
end
|
869
821
|
|
870
|
-
# @note When making an API call, you may pass DescribeFileSystemPolicyRequest
|
871
|
-
# data as a hash:
|
872
|
-
#
|
873
|
-
# {
|
874
|
-
# file_system_id: "FileSystemId", # required
|
875
|
-
# }
|
876
|
-
#
|
877
822
|
# @!attribute [rw] file_system_id
|
878
823
|
# Specifies which EFS file system to retrieve the `FileSystemPolicy`
|
879
824
|
# for.
|
@@ -887,16 +832,6 @@ module Aws::EFS
|
|
887
832
|
include Aws::Structure
|
888
833
|
end
|
889
834
|
|
890
|
-
# @note When making an API call, you may pass DescribeFileSystemsRequest
|
891
|
-
# data as a hash:
|
892
|
-
#
|
893
|
-
# {
|
894
|
-
# max_items: 1,
|
895
|
-
# marker: "Marker",
|
896
|
-
# creation_token: "CreationToken",
|
897
|
-
# file_system_id: "FileSystemId",
|
898
|
-
# }
|
899
|
-
#
|
900
835
|
# @!attribute [rw] max_items
|
901
836
|
# (Optional) Specifies the maximum number of file systems to return in
|
902
837
|
# the response (integer). This number is automatically set to 100. The
|
@@ -956,13 +891,6 @@ module Aws::EFS
|
|
956
891
|
include Aws::Structure
|
957
892
|
end
|
958
893
|
|
959
|
-
# @note When making an API call, you may pass DescribeLifecycleConfigurationRequest
|
960
|
-
# data as a hash:
|
961
|
-
#
|
962
|
-
# {
|
963
|
-
# file_system_id: "FileSystemId", # required
|
964
|
-
# }
|
965
|
-
#
|
966
894
|
# @!attribute [rw] file_system_id
|
967
895
|
# The ID of the file system whose `LifecycleConfiguration` object you
|
968
896
|
# want to retrieve (String).
|
@@ -976,13 +904,6 @@ module Aws::EFS
|
|
976
904
|
include Aws::Structure
|
977
905
|
end
|
978
906
|
|
979
|
-
# @note When making an API call, you may pass DescribeMountTargetSecurityGroupsRequest
|
980
|
-
# data as a hash:
|
981
|
-
#
|
982
|
-
# {
|
983
|
-
# mount_target_id: "MountTargetId", # required
|
984
|
-
# }
|
985
|
-
#
|
986
907
|
# @!attribute [rw] mount_target_id
|
987
908
|
# The ID of the mount target whose security groups you want to
|
988
909
|
# retrieve.
|
@@ -1008,17 +929,6 @@ module Aws::EFS
|
|
1008
929
|
include Aws::Structure
|
1009
930
|
end
|
1010
931
|
|
1011
|
-
# @note When making an API call, you may pass DescribeMountTargetsRequest
|
1012
|
-
# data as a hash:
|
1013
|
-
#
|
1014
|
-
# {
|
1015
|
-
# max_items: 1,
|
1016
|
-
# marker: "Marker",
|
1017
|
-
# file_system_id: "FileSystemId",
|
1018
|
-
# mount_target_id: "MountTargetId",
|
1019
|
-
# access_point_id: "AccessPointId",
|
1020
|
-
# }
|
1021
|
-
#
|
1022
932
|
# @!attribute [rw] max_items
|
1023
933
|
# (Optional) Maximum number of mount targets to return in the
|
1024
934
|
# response. Currently, this number is automatically set to 10, and
|
@@ -1091,15 +1001,50 @@ module Aws::EFS
|
|
1091
1001
|
include Aws::Structure
|
1092
1002
|
end
|
1093
1003
|
|
1094
|
-
#
|
1095
|
-
#
|
1004
|
+
# @!attribute [rw] file_system_id
|
1005
|
+
# You can retrieve the replication configuration for a specific file
|
1006
|
+
# system by providing its file system ID.
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
1009
|
+
# @!attribute [rw] next_token
|
1010
|
+
# `NextToken` is present if the response is paginated. You can use
|
1011
|
+
# `NextToken` in a subsequent request to fetch the next page of
|
1012
|
+
# output.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] max_results
|
1016
|
+
# (Optional) To limit the number of objects returned in a response,
|
1017
|
+
# you can specify the `MaxItems` parameter. The default value is 100.
|
1018
|
+
# @return [Integer]
|
1019
|
+
#
|
1020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeReplicationConfigurationsRequest AWS API Documentation
|
1021
|
+
#
|
1022
|
+
class DescribeReplicationConfigurationsRequest < Struct.new(
|
1023
|
+
:file_system_id,
|
1024
|
+
:next_token,
|
1025
|
+
:max_results)
|
1026
|
+
SENSITIVE = []
|
1027
|
+
include Aws::Structure
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# @!attribute [rw] replications
|
1031
|
+
# The collection of replication configurations that is returned.
|
1032
|
+
# @return [Array<Types::ReplicationConfigurationDescription>]
|
1033
|
+
#
|
1034
|
+
# @!attribute [rw] next_token
|
1035
|
+
# You can use the `NextToken` from the previous response in a
|
1036
|
+
# subsequent request to fetch the additional descriptions.
|
1037
|
+
# @return [String]
|
1096
1038
|
#
|
1097
|
-
#
|
1098
|
-
# max_items: 1,
|
1099
|
-
# marker: "Marker",
|
1100
|
-
# file_system_id: "FileSystemId", # required
|
1101
|
-
# }
|
1039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeReplicationConfigurationsResponse AWS API Documentation
|
1102
1040
|
#
|
1041
|
+
class DescribeReplicationConfigurationsResponse < Struct.new(
|
1042
|
+
:replications,
|
1043
|
+
:next_token)
|
1044
|
+
SENSITIVE = []
|
1045
|
+
include Aws::Structure
|
1046
|
+
end
|
1047
|
+
|
1103
1048
|
# @!attribute [rw] max_items
|
1104
1049
|
# (Optional) The maximum number of file system tags to return in the
|
1105
1050
|
# response. Currently, this number is automatically set to 100, and
|
@@ -1154,13 +1099,123 @@ module Aws::EFS
|
|
1154
1099
|
include Aws::Structure
|
1155
1100
|
end
|
1156
1101
|
|
1102
|
+
# Describes the destination file system in the replication
|
1103
|
+
# configuration.
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] status
|
1106
|
+
# Describes the status of the destination Amazon EFS file system.
|
1107
|
+
#
|
1108
|
+
# * The `Paused` state occurs as a result of opting out of the source
|
1109
|
+
# or destination Region after the replication configuration was
|
1110
|
+
# created. To resume replication for the file system, you need to
|
1111
|
+
# again opt in to the Amazon Web Services Region. For more
|
1112
|
+
# information, see [Managing Amazon Web Services Regions][1] in the
|
1113
|
+
# *Amazon Web Services General Reference Guide*.
|
1114
|
+
#
|
1115
|
+
# * The `Error` state occurs when either the source or the destination
|
1116
|
+
# file system (or both) is in a failed state and is unrecoverable.
|
1117
|
+
# For more information, see [Monitoring replication status][2] in
|
1118
|
+
# the *Amazon EFS User Guide*. You must delete the replication
|
1119
|
+
# configuration, and then restore the most recent backup of the
|
1120
|
+
# failed file system (either the source or the destination) to a new
|
1121
|
+
# file system.
|
1122
|
+
#
|
1123
|
+
#
|
1124
|
+
#
|
1125
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
|
1126
|
+
# [2]: https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html
|
1127
|
+
# @return [String]
|
1128
|
+
#
|
1129
|
+
# @!attribute [rw] file_system_id
|
1130
|
+
# The ID of the destination Amazon EFS file system.
|
1131
|
+
# @return [String]
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] region
|
1134
|
+
# The Amazon Web Services Region in which the destination file system
|
1135
|
+
# is located.
|
1136
|
+
# @return [String]
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] last_replicated_timestamp
|
1139
|
+
# The time when the most recent sync was successfully completed on the
|
1140
|
+
# destination file system. Any changes to data on the source file
|
1141
|
+
# system that occurred before this time have been successfully
|
1142
|
+
# replicated to the destination file system. Any changes that occurred
|
1143
|
+
# after this time might not be fully replicated.
|
1144
|
+
# @return [Time]
|
1145
|
+
#
|
1146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/Destination AWS API Documentation
|
1147
|
+
#
|
1148
|
+
class Destination < Struct.new(
|
1149
|
+
:status,
|
1150
|
+
:file_system_id,
|
1151
|
+
:region,
|
1152
|
+
:last_replicated_timestamp)
|
1153
|
+
SENSITIVE = []
|
1154
|
+
include Aws::Structure
|
1155
|
+
end
|
1156
|
+
|
1157
|
+
# Describes the destination file system to create in the replication
|
1158
|
+
# configuration.
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] region
|
1161
|
+
# To create a file system that uses Regional storage, specify the
|
1162
|
+
# Amazon Web Services Region in which to create the destination file
|
1163
|
+
# system.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] availability_zone_name
|
1167
|
+
# To create a file system that uses EFS One Zone storage, specify the
|
1168
|
+
# name of the Availability Zone in which to create the destination
|
1169
|
+
# file system.
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1172
|
+
# @!attribute [rw] kms_key_id
|
1173
|
+
# Specifies the Key Management Service (KMS) key that you want to use
|
1174
|
+
# to encrypt the destination file system. If you do not specify a KMS
|
1175
|
+
# key, Amazon EFS uses your default KMS key for Amazon EFS,
|
1176
|
+
# `/aws/elasticfilesystem`. This ID can be in one of the following
|
1177
|
+
# formats:
|
1178
|
+
#
|
1179
|
+
# * Key ID - The unique identifier of the key, for example
|
1180
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
1181
|
+
#
|
1182
|
+
# * ARN - The Amazon Resource Name (ARN) for the key, for example
|
1183
|
+
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
1184
|
+
#
|
1185
|
+
# * Key alias - A previously created display name for a key, for
|
1186
|
+
# example `alias/projectKey1`.
|
1187
|
+
#
|
1188
|
+
# * Key alias ARN - The ARN for a key alias, for example
|
1189
|
+
# `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.
|
1190
|
+
# @return [String]
|
1191
|
+
#
|
1192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DestinationToCreate AWS API Documentation
|
1193
|
+
#
|
1194
|
+
class DestinationToCreate < Struct.new(
|
1195
|
+
:region,
|
1196
|
+
:availability_zone_name,
|
1197
|
+
:kms_key_id)
|
1198
|
+
SENSITIVE = []
|
1199
|
+
include Aws::Structure
|
1200
|
+
end
|
1201
|
+
|
1157
1202
|
# Returned if the file system you are trying to create already exists,
|
1158
1203
|
# with the creation token you provided.
|
1159
1204
|
#
|
1160
1205
|
# @!attribute [rw] error_code
|
1206
|
+
# The error code is a string that uniquely identifies an error
|
1207
|
+
# condition. It is meant to be read and understood by programs that
|
1208
|
+
# detect and handle errors by type.
|
1161
1209
|
# @return [String]
|
1162
1210
|
#
|
1163
1211
|
# @!attribute [rw] message
|
1212
|
+
# The error message contains a generic description of the error
|
1213
|
+
# condition in English. It is intended for a human audience. Simple
|
1214
|
+
# programs display the message directly to the end user if they
|
1215
|
+
# encounter an error condition they don't know how or don't care to
|
1216
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1217
|
+
# and proper internationalization are more likely to ignore the error
|
1218
|
+
# message.
|
1164
1219
|
# @return [String]
|
1165
1220
|
#
|
1166
1221
|
# @!attribute [rw] file_system_id
|
@@ -1179,9 +1234,7 @@ module Aws::EFS
|
|
1179
1234
|
# A description of the file system.
|
1180
1235
|
#
|
1181
1236
|
# @!attribute [rw] owner_id
|
1182
|
-
# The Amazon Web Services account that created the file system.
|
1183
|
-
# file system was created by an IAM user, the parent account to which
|
1184
|
-
# the user belongs is the owner.
|
1237
|
+
# The Amazon Web Services account that created the file system.
|
1185
1238
|
# @return [String]
|
1186
1239
|
#
|
1187
1240
|
# @!attribute [rw] creation_token
|
@@ -1243,8 +1296,7 @@ module Aws::EFS
|
|
1243
1296
|
# @return [Boolean]
|
1244
1297
|
#
|
1245
1298
|
# @!attribute [rw] kms_key_id
|
1246
|
-
# The ID of an
|
1247
|
-
# was used to protect the encrypted file system.
|
1299
|
+
# The ID of an KMS key used to protect the encrypted file system.
|
1248
1300
|
# @return [String]
|
1249
1301
|
#
|
1250
1302
|
# @!attribute [rw] throughput_mode
|
@@ -1257,7 +1309,7 @@ module Aws::EFS
|
|
1257
1309
|
# @return [String]
|
1258
1310
|
#
|
1259
1311
|
# @!attribute [rw] provisioned_throughput_in_mibps
|
1260
|
-
# The amount of provisioned throughput, measured in
|
1312
|
+
# The amount of provisioned throughput, measured in MiBps, for the
|
1261
1313
|
# file system. Valid for file systems using `ThroughputMode` set to
|
1262
1314
|
# `provisioned`.
|
1263
1315
|
# @return [Float]
|
@@ -1313,9 +1365,19 @@ module Aws::EFS
|
|
1313
1365
|
# Returned if a file system has mount targets.
|
1314
1366
|
#
|
1315
1367
|
# @!attribute [rw] error_code
|
1368
|
+
# The error code is a string that uniquely identifies an error
|
1369
|
+
# condition. It is meant to be read and understood by programs that
|
1370
|
+
# detect and handle errors by type.
|
1316
1371
|
# @return [String]
|
1317
1372
|
#
|
1318
1373
|
# @!attribute [rw] message
|
1374
|
+
# The error message contains a generic description of the error
|
1375
|
+
# condition in English. It is intended for a human audience. Simple
|
1376
|
+
# programs display the message directly to the end user if they
|
1377
|
+
# encounter an error condition they don't know how or don't care to
|
1378
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1379
|
+
# and proper internationalization are more likely to ignore the error
|
1380
|
+
# message.
|
1319
1381
|
# @return [String]
|
1320
1382
|
#
|
1321
1383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemInUse AWS API Documentation
|
@@ -1331,9 +1393,19 @@ module Aws::EFS
|
|
1331
1393
|
# maximum number of file systems allowed per account.
|
1332
1394
|
#
|
1333
1395
|
# @!attribute [rw] error_code
|
1396
|
+
# The error code is a string that uniquely identifies an error
|
1397
|
+
# condition. It is meant to be read and understood by programs that
|
1398
|
+
# detect and handle errors by type.
|
1334
1399
|
# @return [String]
|
1335
1400
|
#
|
1336
1401
|
# @!attribute [rw] message
|
1402
|
+
# The error message contains a generic description of the error
|
1403
|
+
# condition in English. It is intended for a human audience. Simple
|
1404
|
+
# programs display the message directly to the end user if they
|
1405
|
+
# encounter an error condition they don't know how or don't care to
|
1406
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1407
|
+
# and proper internationalization are more likely to ignore the error
|
1408
|
+
# message.
|
1337
1409
|
# @return [String]
|
1338
1410
|
#
|
1339
1411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemLimitExceeded AWS API Documentation
|
@@ -1349,9 +1421,19 @@ module Aws::EFS
|
|
1349
1421
|
# requester's Amazon Web Services account.
|
1350
1422
|
#
|
1351
1423
|
# @!attribute [rw] error_code
|
1424
|
+
# The error code is a string that uniquely identifies an error
|
1425
|
+
# condition. It is meant to be read and understood by programs that
|
1426
|
+
# detect and handle errors by type.
|
1352
1427
|
# @return [String]
|
1353
1428
|
#
|
1354
1429
|
# @!attribute [rw] message
|
1430
|
+
# The error message contains a generic description of the error
|
1431
|
+
# condition in English. It is intended for a human audience. Simple
|
1432
|
+
# programs display the message directly to the end user if they
|
1433
|
+
# encounter an error condition they don't know how or don't care to
|
1434
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1435
|
+
# and proper internationalization are more likely to ignore the error
|
1436
|
+
# message.
|
1355
1437
|
# @return [String]
|
1356
1438
|
#
|
1357
1439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemNotFound AWS API Documentation
|
@@ -1426,9 +1508,19 @@ module Aws::EFS
|
|
1426
1508
|
# Returned if the file system's lifecycle state is not "available".
|
1427
1509
|
#
|
1428
1510
|
# @!attribute [rw] error_code
|
1511
|
+
# The error code is a string that uniquely identifies an error
|
1512
|
+
# condition. It is meant to be read and understood by programs that
|
1513
|
+
# detect and handle errors by type.
|
1429
1514
|
# @return [String]
|
1430
1515
|
#
|
1431
1516
|
# @!attribute [rw] message
|
1517
|
+
# The error message contains a generic description of the error
|
1518
|
+
# condition in English. It is intended for a human audience. Simple
|
1519
|
+
# programs display the message directly to the end user if they
|
1520
|
+
# encounter an error condition they don't know how or don't care to
|
1521
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1522
|
+
# and proper internationalization are more likely to ignore the error
|
1523
|
+
# message.
|
1432
1524
|
# @return [String]
|
1433
1525
|
#
|
1434
1526
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/IncorrectFileSystemLifeCycleState AWS API Documentation
|
@@ -1444,9 +1536,19 @@ module Aws::EFS
|
|
1444
1536
|
# operation.
|
1445
1537
|
#
|
1446
1538
|
# @!attribute [rw] error_code
|
1539
|
+
# The error code is a string that uniquely identifies an error
|
1540
|
+
# condition. It is meant to be read and understood by programs that
|
1541
|
+
# detect and handle errors by type.
|
1447
1542
|
# @return [String]
|
1448
1543
|
#
|
1449
1544
|
# @!attribute [rw] message
|
1545
|
+
# The error message contains a generic description of the error
|
1546
|
+
# condition in English. It is intended for a human audience. Simple
|
1547
|
+
# programs display the message directly to the end user if they
|
1548
|
+
# encounter an error condition they don't know how or don't care to
|
1549
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1550
|
+
# and proper internationalization are more likely to ignore the error
|
1551
|
+
# message.
|
1450
1552
|
# @return [String]
|
1451
1553
|
#
|
1452
1554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/IncorrectMountTargetState AWS API Documentation
|
@@ -1462,13 +1564,23 @@ module Aws::EFS
|
|
1462
1564
|
# throughput. This value might be returned when you try to create a file
|
1463
1565
|
# system in provisioned throughput mode, when you attempt to increase
|
1464
1566
|
# the provisioned throughput of an existing file system, or when you
|
1465
|
-
# attempt to change an existing file system from
|
1466
|
-
#
|
1567
|
+
# attempt to change an existing file system from Bursting Throughput to
|
1568
|
+
# Provisioned Throughput mode. Try again later.
|
1467
1569
|
#
|
1468
1570
|
# @!attribute [rw] error_code
|
1571
|
+
# The error code is a string that uniquely identifies an error
|
1572
|
+
# condition. It is meant to be read and understood by programs that
|
1573
|
+
# detect and handle errors by type.
|
1469
1574
|
# @return [String]
|
1470
1575
|
#
|
1471
1576
|
# @!attribute [rw] message
|
1577
|
+
# The error message contains a generic description of the error
|
1578
|
+
# condition in English. It is intended for a human audience. Simple
|
1579
|
+
# programs display the message directly to the end user if they
|
1580
|
+
# encounter an error condition they don't know how or don't care to
|
1581
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1582
|
+
# and proper internationalization are more likely to ignore the error
|
1583
|
+
# message.
|
1472
1584
|
# @return [String]
|
1473
1585
|
#
|
1474
1586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/InsufficientThroughputCapacity AWS API Documentation
|
@@ -1483,9 +1595,19 @@ module Aws::EFS
|
|
1483
1595
|
# Returned if an error occurred on the server side.
|
1484
1596
|
#
|
1485
1597
|
# @!attribute [rw] error_code
|
1598
|
+
# The error code is a string that uniquely identifies an error
|
1599
|
+
# condition. It is meant to be read and understood by programs that
|
1600
|
+
# detect and handle errors by type.
|
1486
1601
|
# @return [String]
|
1487
1602
|
#
|
1488
1603
|
# @!attribute [rw] message
|
1604
|
+
# The error message contains a generic description of the error
|
1605
|
+
# condition in English. It is intended for a human audience. Simple
|
1606
|
+
# programs display the message directly to the end user if they
|
1607
|
+
# encounter an error condition they don't know how or don't care to
|
1608
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1609
|
+
# and proper internationalization are more likely to ignore the error
|
1610
|
+
# message.
|
1489
1611
|
# @return [String]
|
1490
1612
|
#
|
1491
1613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/InternalServerError AWS API Documentation
|
@@ -1497,15 +1619,25 @@ module Aws::EFS
|
|
1497
1619
|
include Aws::Structure
|
1498
1620
|
end
|
1499
1621
|
|
1500
|
-
# Returned if the `FileSystemPolicy` is
|
1501
|
-
#
|
1622
|
+
# Returned if the `FileSystemPolicy` is malformed or contains an error
|
1623
|
+
# such as a parameter value that is not valid or a missing required
|
1502
1624
|
# parameter. Returned in the case of a policy lockout safety check
|
1503
1625
|
# error.
|
1504
1626
|
#
|
1505
1627
|
# @!attribute [rw] error_code
|
1628
|
+
# The error code is a string that uniquely identifies an error
|
1629
|
+
# condition. It is meant to be read and understood by programs that
|
1630
|
+
# detect and handle errors by type.
|
1506
1631
|
# @return [String]
|
1507
1632
|
#
|
1508
1633
|
# @!attribute [rw] message
|
1634
|
+
# The error message contains a generic description of the error
|
1635
|
+
# condition in English. It is intended for a human audience. Simple
|
1636
|
+
# programs display the message directly to the end user if they
|
1637
|
+
# encounter an error condition they don't know how or don't care to
|
1638
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1639
|
+
# and proper internationalization are more likely to ignore the error
|
1640
|
+
# message.
|
1509
1641
|
# @return [String]
|
1510
1642
|
#
|
1511
1643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/InvalidPolicyException AWS API Documentation
|
@@ -1521,9 +1653,19 @@ module Aws::EFS
|
|
1521
1653
|
# use in the subnet.
|
1522
1654
|
#
|
1523
1655
|
# @!attribute [rw] error_code
|
1656
|
+
# The error code is a string that uniquely identifies an error
|
1657
|
+
# condition. It is meant to be read and understood by programs that
|
1658
|
+
# detect and handle errors by type.
|
1524
1659
|
# @return [String]
|
1525
1660
|
#
|
1526
1661
|
# @!attribute [rw] message
|
1662
|
+
# The error message contains a generic description of the error
|
1663
|
+
# condition in English. It is intended for a human audience. Simple
|
1664
|
+
# programs display the message directly to the end user if they
|
1665
|
+
# encounter an error condition they don't know how or don't care to
|
1666
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1667
|
+
# and proper internationalization are more likely to ignore the error
|
1668
|
+
# message.
|
1527
1669
|
# @return [String]
|
1528
1670
|
#
|
1529
1671
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/IpAddressInUse AWS API Documentation
|
@@ -1549,7 +1691,7 @@ module Aws::EFS
|
|
1549
1691
|
end
|
1550
1692
|
|
1551
1693
|
# Describes a policy used by EFS lifecycle management and EFS
|
1552
|
-
#
|
1694
|
+
# Intelligent-Tiering that specifies when to transition files into and
|
1553
1695
|
# out of the file system's Infrequent Access (IA) storage class. For
|
1554
1696
|
# more information, see [EFS Intelligent‐Tiering and EFS Lifecycle
|
1555
1697
|
# Management][1].
|
@@ -1557,8 +1699,8 @@ module Aws::EFS
|
|
1557
1699
|
# <note markdown="1"> When using the `put-lifecycle-configuration` CLI command or the
|
1558
1700
|
# `PutLifecycleConfiguration` API action, Amazon EFS requires that each
|
1559
1701
|
# `LifecyclePolicy` object have only a single transition. This means
|
1560
|
-
# that in a request body, `LifecyclePolicies`
|
1561
|
-
#
|
1702
|
+
# that in a request body, `LifecyclePolicies` must be structured as an
|
1703
|
+
# array of `LifecyclePolicy` objects, one object for each transition,
|
1562
1704
|
# `TransitionToIA`, `TransitionToPrimaryStorageClass`. For more
|
1563
1705
|
# information, see the request examples in PutLifecycleConfiguration.
|
1564
1706
|
#
|
@@ -1568,14 +1710,6 @@ module Aws::EFS
|
|
1568
1710
|
#
|
1569
1711
|
# [1]: https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html
|
1570
1712
|
#
|
1571
|
-
# @note When making an API call, you may pass LifecyclePolicy
|
1572
|
-
# data as a hash:
|
1573
|
-
#
|
1574
|
-
# {
|
1575
|
-
# transition_to_ia: "AFTER_7_DAYS", # accepts AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS
|
1576
|
-
# transition_to_primary_storage_class: "AFTER_1_ACCESS", # accepts AFTER_1_ACCESS
|
1577
|
-
# }
|
1578
|
-
#
|
1579
1713
|
# @!attribute [rw] transition_to_ia
|
1580
1714
|
# Describes the period of time that a file is not accessed, after
|
1581
1715
|
# which it transitions to IA storage. Metadata operations such as
|
@@ -1598,15 +1732,6 @@ module Aws::EFS
|
|
1598
1732
|
include Aws::Structure
|
1599
1733
|
end
|
1600
1734
|
|
1601
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1602
|
-
# data as a hash:
|
1603
|
-
#
|
1604
|
-
# {
|
1605
|
-
# resource_id: "ResourceId", # required
|
1606
|
-
# max_results: 1,
|
1607
|
-
# next_token: "Token",
|
1608
|
-
# }
|
1609
|
-
#
|
1610
1735
|
# @!attribute [rw] resource_id
|
1611
1736
|
# Specifies the EFS resource you want to retrieve tags for. You can
|
1612
1737
|
# retrieve tags for EFS file systems and access points using this API
|
@@ -1653,14 +1778,6 @@ module Aws::EFS
|
|
1653
1778
|
include Aws::Structure
|
1654
1779
|
end
|
1655
1780
|
|
1656
|
-
# @note When making an API call, you may pass ModifyMountTargetSecurityGroupsRequest
|
1657
|
-
# data as a hash:
|
1658
|
-
#
|
1659
|
-
# {
|
1660
|
-
# mount_target_id: "MountTargetId", # required
|
1661
|
-
# security_groups: ["SecurityGroup"],
|
1662
|
-
# }
|
1663
|
-
#
|
1664
1781
|
# @!attribute [rw] mount_target_id
|
1665
1782
|
# The ID of the mount target whose security groups you want to modify.
|
1666
1783
|
# @return [String]
|
@@ -1682,9 +1799,19 @@ module Aws::EFS
|
|
1682
1799
|
# restrictions based on the file system's existing mount targets.
|
1683
1800
|
#
|
1684
1801
|
# @!attribute [rw] error_code
|
1802
|
+
# The error code is a string that uniquely identifies an error
|
1803
|
+
# condition. It is meant to be read and understood by programs that
|
1804
|
+
# detect and handle errors by type.
|
1685
1805
|
# @return [String]
|
1686
1806
|
#
|
1687
1807
|
# @!attribute [rw] message
|
1808
|
+
# The error message contains a generic description of the error
|
1809
|
+
# condition in English. It is intended for a human audience. Simple
|
1810
|
+
# programs display the message directly to the end user if they
|
1811
|
+
# encounter an error condition they don't know how or don't care to
|
1812
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1813
|
+
# and proper internationalization are more likely to ignore the error
|
1814
|
+
# message.
|
1688
1815
|
# @return [String]
|
1689
1816
|
#
|
1690
1817
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/MountTargetConflict AWS API Documentation
|
@@ -1770,9 +1897,19 @@ module Aws::EFS
|
|
1770
1897
|
# the caller's Amazon Web Services account.
|
1771
1898
|
#
|
1772
1899
|
# @!attribute [rw] error_code
|
1900
|
+
# The error code is a string that uniquely identifies an error
|
1901
|
+
# condition. It is meant to be read and understood by programs that
|
1902
|
+
# detect and handle errors by type.
|
1773
1903
|
# @return [String]
|
1774
1904
|
#
|
1775
1905
|
# @!attribute [rw] message
|
1906
|
+
# The error message contains a generic description of the error
|
1907
|
+
# condition in English. It is intended for a human audience. Simple
|
1908
|
+
# programs display the message directly to the end user if they
|
1909
|
+
# encounter an error condition they don't know how or don't care to
|
1910
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1911
|
+
# and proper internationalization are more likely to ignore the error
|
1912
|
+
# message.
|
1776
1913
|
# @return [String]
|
1777
1914
|
#
|
1778
1915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/MountTargetNotFound AWS API Documentation
|
@@ -1785,20 +1922,30 @@ module Aws::EFS
|
|
1785
1922
|
end
|
1786
1923
|
|
1787
1924
|
# The calling account has reached the limit for elastic network
|
1788
|
-
# interfaces for the specific Amazon Web Services Region.
|
1789
|
-
#
|
1790
|
-
#
|
1791
|
-
#
|
1792
|
-
#
|
1925
|
+
# interfaces for the specific Amazon Web Services Region. Either delete
|
1926
|
+
# some network interfaces or request that the account quota be raised.
|
1927
|
+
# For more information, see [Amazon VPC Quotas][1] in the *Amazon VPC
|
1928
|
+
# User Guide* (see the **Network interfaces per Region** entry in the
|
1929
|
+
# **Network interfaces** table).
|
1793
1930
|
#
|
1794
1931
|
#
|
1795
1932
|
#
|
1796
1933
|
# [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html
|
1797
1934
|
#
|
1798
1935
|
# @!attribute [rw] error_code
|
1936
|
+
# The error code is a string that uniquely identifies an error
|
1937
|
+
# condition. It is meant to be read and understood by programs that
|
1938
|
+
# detect and handle errors by type.
|
1799
1939
|
# @return [String]
|
1800
1940
|
#
|
1801
1941
|
# @!attribute [rw] message
|
1942
|
+
# The error message contains a generic description of the error
|
1943
|
+
# condition in English. It is intended for a human audience. Simple
|
1944
|
+
# programs display the message directly to the end user if they
|
1945
|
+
# encounter an error condition they don't know how or don't care to
|
1946
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1947
|
+
# and proper internationalization are more likely to ignore the error
|
1948
|
+
# message.
|
1802
1949
|
# @return [String]
|
1803
1950
|
#
|
1804
1951
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/NetworkInterfaceLimitExceeded AWS API Documentation
|
@@ -1814,9 +1961,19 @@ module Aws::EFS
|
|
1814
1961
|
# no free IP addresses in the subnet.
|
1815
1962
|
#
|
1816
1963
|
# @!attribute [rw] error_code
|
1964
|
+
# The error code is a string that uniquely identifies an error
|
1965
|
+
# condition. It is meant to be read and understood by programs that
|
1966
|
+
# detect and handle errors by type.
|
1817
1967
|
# @return [String]
|
1818
1968
|
#
|
1819
1969
|
# @!attribute [rw] message
|
1970
|
+
# The error message contains a generic description of the error
|
1971
|
+
# condition in English. It is intended for a human audience. Simple
|
1972
|
+
# programs display the message directly to the end user if they
|
1973
|
+
# encounter an error condition they don't know how or don't care to
|
1974
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
1975
|
+
# and proper internationalization are more likely to ignore the error
|
1976
|
+
# message.
|
1820
1977
|
# @return [String]
|
1821
1978
|
#
|
1822
1979
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/NoFreeAddressesInSubnet AWS API Documentation
|
@@ -1832,9 +1989,19 @@ module Aws::EFS
|
|
1832
1989
|
# file system specified.
|
1833
1990
|
#
|
1834
1991
|
# @!attribute [rw] error_code
|
1992
|
+
# The error code is a string that uniquely identifies an error
|
1993
|
+
# condition. It is meant to be read and understood by programs that
|
1994
|
+
# detect and handle errors by type.
|
1835
1995
|
# @return [String]
|
1836
1996
|
#
|
1837
1997
|
# @!attribute [rw] message
|
1998
|
+
# The error message contains a generic description of the error
|
1999
|
+
# condition in English. It is intended for a human audience. Simple
|
2000
|
+
# programs display the message directly to the end user if they
|
2001
|
+
# encounter an error condition they don't know how or don't care to
|
2002
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2003
|
+
# and proper internationalization are more likely to ignore the error
|
2004
|
+
# message.
|
1838
2005
|
# @return [String]
|
1839
2006
|
#
|
1840
2007
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PolicyNotFound AWS API Documentation
|
@@ -1850,15 +2017,6 @@ module Aws::EFS
|
|
1850
2017
|
# secondary group IDs, on the access point that is used for all file
|
1851
2018
|
# system operations performed by NFS clients using the access point.
|
1852
2019
|
#
|
1853
|
-
# @note When making an API call, you may pass PosixUser
|
1854
|
-
# data as a hash:
|
1855
|
-
#
|
1856
|
-
# {
|
1857
|
-
# uid: 1, # required
|
1858
|
-
# gid: 1, # required
|
1859
|
-
# secondary_gids: [1],
|
1860
|
-
# }
|
1861
|
-
#
|
1862
2020
|
# @!attribute [rw] uid
|
1863
2021
|
# The POSIX user ID used for all file system operations using this
|
1864
2022
|
# access point.
|
@@ -1884,13 +2042,6 @@ module Aws::EFS
|
|
1884
2042
|
include Aws::Structure
|
1885
2043
|
end
|
1886
2044
|
|
1887
|
-
# @note When making an API call, you may pass PutAccountPreferencesRequest
|
1888
|
-
# data as a hash:
|
1889
|
-
#
|
1890
|
-
# {
|
1891
|
-
# resource_id_type: "LONG_ID", # required, accepts LONG_ID, SHORT_ID
|
1892
|
-
# }
|
1893
|
-
#
|
1894
2045
|
# @!attribute [rw] resource_id_type
|
1895
2046
|
# Specifies the EFS resource ID preference to set for the user's
|
1896
2047
|
# Amazon Web Services account, in the current Amazon Web Services
|
@@ -1899,7 +2050,7 @@ module Aws::EFS
|
|
1899
2050
|
#
|
1900
2051
|
# <note markdown="1"> Starting in October, 2021, you will receive an error when setting
|
1901
2052
|
# the account preference to `SHORT_ID`. Contact Amazon Web Services
|
1902
|
-
# support if you receive an error and
|
2053
|
+
# support if you receive an error and must use short IDs for file
|
1903
2054
|
# system and mount target resources.
|
1904
2055
|
#
|
1905
2056
|
# </note>
|
@@ -1927,16 +2078,6 @@ module Aws::EFS
|
|
1927
2078
|
include Aws::Structure
|
1928
2079
|
end
|
1929
2080
|
|
1930
|
-
# @note When making an API call, you may pass PutBackupPolicyRequest
|
1931
|
-
# data as a hash:
|
1932
|
-
#
|
1933
|
-
# {
|
1934
|
-
# file_system_id: "FileSystemId", # required
|
1935
|
-
# backup_policy: { # required
|
1936
|
-
# status: "ENABLED", # required, accepts ENABLED, ENABLING, DISABLED, DISABLING
|
1937
|
-
# },
|
1938
|
-
# }
|
1939
|
-
#
|
1940
2081
|
# @!attribute [rw] file_system_id
|
1941
2082
|
# Specifies which EFS file system to update the backup policy for.
|
1942
2083
|
# @return [String]
|
@@ -1954,15 +2095,6 @@ module Aws::EFS
|
|
1954
2095
|
include Aws::Structure
|
1955
2096
|
end
|
1956
2097
|
|
1957
|
-
# @note When making an API call, you may pass PutFileSystemPolicyRequest
|
1958
|
-
# data as a hash:
|
1959
|
-
#
|
1960
|
-
# {
|
1961
|
-
# file_system_id: "FileSystemId", # required
|
1962
|
-
# policy: "Policy", # required
|
1963
|
-
# bypass_policy_lockout_safety_check: false,
|
1964
|
-
# }
|
1965
|
-
#
|
1966
2098
|
# @!attribute [rw] file_system_id
|
1967
2099
|
# The ID of the EFS file system that you want to create or update the
|
1968
2100
|
# `FileSystemPolicy` for.
|
@@ -1980,15 +2112,15 @@ module Aws::EFS
|
|
1980
2112
|
# @return [String]
|
1981
2113
|
#
|
1982
2114
|
# @!attribute [rw] bypass_policy_lockout_safety_check
|
1983
|
-
# (Optional) A
|
1984
|
-
# `FileSystemPolicy` lockout safety check. The
|
1985
|
-
#
|
1986
|
-
# principal making the request
|
1987
|
-
# `PutFileSystemPolicy` requests on
|
2115
|
+
# (Optional) A boolean that specifies whether or not to bypass the
|
2116
|
+
# `FileSystemPolicy` lockout safety check. The lockout safety check
|
2117
|
+
# determines whether the policy in the request will lock out, or
|
2118
|
+
# prevent, the IAM principal that is making the request from making
|
2119
|
+
# future `PutFileSystemPolicy` requests on this file system. Set
|
1988
2120
|
# `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to
|
1989
|
-
# prevent the principal that is making the request from making
|
1990
|
-
# subsequent `PutFileSystemPolicy`
|
1991
|
-
# default value is False
|
2121
|
+
# prevent the IAM principal that is making the request from making
|
2122
|
+
# subsequent `PutFileSystemPolicy` requests on this file system. The
|
2123
|
+
# default value is `False`.
|
1992
2124
|
# @return [Boolean]
|
1993
2125
|
#
|
1994
2126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PutFileSystemPolicyRequest AWS API Documentation
|
@@ -2001,19 +2133,6 @@ module Aws::EFS
|
|
2001
2133
|
include Aws::Structure
|
2002
2134
|
end
|
2003
2135
|
|
2004
|
-
# @note When making an API call, you may pass PutLifecycleConfigurationRequest
|
2005
|
-
# data as a hash:
|
2006
|
-
#
|
2007
|
-
# {
|
2008
|
-
# file_system_id: "FileSystemId", # required
|
2009
|
-
# lifecycle_policies: [ # required
|
2010
|
-
# {
|
2011
|
-
# transition_to_ia: "AFTER_7_DAYS", # accepts AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS
|
2012
|
-
# transition_to_primary_storage_class: "AFTER_1_ACCESS", # accepts AFTER_1_ACCESS
|
2013
|
-
# },
|
2014
|
-
# ],
|
2015
|
-
# }
|
2016
|
-
#
|
2017
2136
|
# @!attribute [rw] file_system_id
|
2018
2137
|
# The ID of the file system for which you are creating the
|
2019
2138
|
# `LifecycleConfiguration` object (String).
|
@@ -2022,7 +2141,7 @@ module Aws::EFS
|
|
2022
2141
|
# @!attribute [rw] lifecycle_policies
|
2023
2142
|
# An array of `LifecyclePolicy` objects that define the file system's
|
2024
2143
|
# `LifecycleConfiguration` object. A `LifecycleConfiguration` object
|
2025
|
-
# informs EFS lifecycle management and
|
2144
|
+
# informs EFS lifecycle management and EFS Intelligent-Tiering of the
|
2026
2145
|
# following:
|
2027
2146
|
#
|
2028
2147
|
# * When to move files in the file system from primary storage to the
|
@@ -2033,11 +2152,10 @@ module Aws::EFS
|
|
2033
2152
|
# <note markdown="1"> When using the `put-lifecycle-configuration` CLI command or the
|
2034
2153
|
# `PutLifecycleConfiguration` API action, Amazon EFS requires that
|
2035
2154
|
# each `LifecyclePolicy` object have only a single transition. This
|
2036
|
-
# means that in a request body, `LifecyclePolicies`
|
2037
|
-
#
|
2038
|
-
#
|
2039
|
-
#
|
2040
|
-
# following section for more information.
|
2155
|
+
# means that in a request body, `LifecyclePolicies` must be structured
|
2156
|
+
# as an array of `LifecyclePolicy` objects, one object for each
|
2157
|
+
# transition, `TransitionToIA`, `TransitionToPrimaryStorageClass`. See
|
2158
|
+
# the example requests in the following section for more information.
|
2041
2159
|
#
|
2042
2160
|
# </note>
|
2043
2161
|
# @return [Array<Types::LifecyclePolicy>]
|
@@ -2051,6 +2169,76 @@ module Aws::EFS
|
|
2051
2169
|
include Aws::Structure
|
2052
2170
|
end
|
2053
2171
|
|
2172
|
+
# Describes the replication configuration for a specific file system.
|
2173
|
+
#
|
2174
|
+
# @!attribute [rw] source_file_system_id
|
2175
|
+
# The ID of the source Amazon EFS file system that is being
|
2176
|
+
# replicated.
|
2177
|
+
# @return [String]
|
2178
|
+
#
|
2179
|
+
# @!attribute [rw] source_file_system_region
|
2180
|
+
# The Amazon Web Services Region in which the source Amazon EFS file
|
2181
|
+
# system is located.
|
2182
|
+
# @return [String]
|
2183
|
+
#
|
2184
|
+
# @!attribute [rw] source_file_system_arn
|
2185
|
+
# The Amazon Resource Name (ARN) of the current source file system in
|
2186
|
+
# the replication configuration.
|
2187
|
+
# @return [String]
|
2188
|
+
#
|
2189
|
+
# @!attribute [rw] original_source_file_system_arn
|
2190
|
+
# The Amazon Resource Name (ARN) of the original source Amazon EFS
|
2191
|
+
# file system in the replication configuration.
|
2192
|
+
# @return [String]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] creation_time
|
2195
|
+
# Describes when the replication configuration was created.
|
2196
|
+
# @return [Time]
|
2197
|
+
#
|
2198
|
+
# @!attribute [rw] destinations
|
2199
|
+
# An array of destination objects. Only one destination object is
|
2200
|
+
# supported.
|
2201
|
+
# @return [Array<Types::Destination>]
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription AWS API Documentation
|
2204
|
+
#
|
2205
|
+
class ReplicationConfigurationDescription < Struct.new(
|
2206
|
+
:source_file_system_id,
|
2207
|
+
:source_file_system_region,
|
2208
|
+
:source_file_system_arn,
|
2209
|
+
:original_source_file_system_arn,
|
2210
|
+
:creation_time,
|
2211
|
+
:destinations)
|
2212
|
+
SENSITIVE = []
|
2213
|
+
include Aws::Structure
|
2214
|
+
end
|
2215
|
+
|
2216
|
+
# Returned if the specified file system does not have a replication
|
2217
|
+
# configuration.
|
2218
|
+
#
|
2219
|
+
# @!attribute [rw] error_code
|
2220
|
+
# ReplicationNotFound
|
2221
|
+
# @return [String]
|
2222
|
+
#
|
2223
|
+
# @!attribute [rw] message
|
2224
|
+
# The error message contains a generic description of the error
|
2225
|
+
# condition in English. It is intended for a human audience. Simple
|
2226
|
+
# programs display the message directly to the end user if they
|
2227
|
+
# encounter an error condition they don't know how or don't care to
|
2228
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2229
|
+
# and proper internationalization are more likely to ignore the error
|
2230
|
+
# message.
|
2231
|
+
# @return [String]
|
2232
|
+
#
|
2233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ReplicationNotFound AWS API Documentation
|
2234
|
+
#
|
2235
|
+
class ReplicationNotFound < Struct.new(
|
2236
|
+
:error_code,
|
2237
|
+
:message)
|
2238
|
+
SENSITIVE = []
|
2239
|
+
include Aws::Structure
|
2240
|
+
end
|
2241
|
+
|
2054
2242
|
# Describes the resource type and its ID preference for the user's
|
2055
2243
|
# Amazon Web Services account, in the current Amazon Web Services
|
2056
2244
|
# Region.
|
@@ -2081,18 +2269,6 @@ module Aws::EFS
|
|
2081
2269
|
# access data in the access point's `RootDirectory` and it's
|
2082
2270
|
# subdirectories.
|
2083
2271
|
#
|
2084
|
-
# @note When making an API call, you may pass RootDirectory
|
2085
|
-
# data as a hash:
|
2086
|
-
#
|
2087
|
-
# {
|
2088
|
-
# path: "Path",
|
2089
|
-
# creation_info: {
|
2090
|
-
# owner_uid: 1, # required
|
2091
|
-
# owner_gid: 1, # required
|
2092
|
-
# permissions: "Permissions", # required
|
2093
|
-
# },
|
2094
|
-
# }
|
2095
|
-
#
|
2096
2272
|
# @!attribute [rw] path
|
2097
2273
|
# Specifies the path on the EFS file system to expose as the root
|
2098
2274
|
# directory to NFS clients using the access point to access the EFS
|
@@ -2127,9 +2303,19 @@ module Aws::EFS
|
|
2127
2303
|
# greater than five.
|
2128
2304
|
#
|
2129
2305
|
# @!attribute [rw] error_code
|
2306
|
+
# The error code is a string that uniquely identifies an error
|
2307
|
+
# condition. It is meant to be read and understood by programs that
|
2308
|
+
# detect and handle errors by type.
|
2130
2309
|
# @return [String]
|
2131
2310
|
#
|
2132
2311
|
# @!attribute [rw] message
|
2312
|
+
# The error message contains a generic description of the error
|
2313
|
+
# condition in English. It is intended for a human audience. Simple
|
2314
|
+
# programs display the message directly to the end user if they
|
2315
|
+
# encounter an error condition they don't know how or don't care to
|
2316
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2317
|
+
# and proper internationalization are more likely to ignore the error
|
2318
|
+
# message.
|
2133
2319
|
# @return [String]
|
2134
2320
|
#
|
2135
2321
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/SecurityGroupLimitExceeded AWS API Documentation
|
@@ -2142,12 +2328,22 @@ module Aws::EFS
|
|
2142
2328
|
end
|
2143
2329
|
|
2144
2330
|
# Returned if one of the specified security groups doesn't exist in the
|
2145
|
-
# subnet's VPC.
|
2331
|
+
# subnet's virtual private cloud (VPC).
|
2146
2332
|
#
|
2147
2333
|
# @!attribute [rw] error_code
|
2334
|
+
# The error code is a string that uniquely identifies an error
|
2335
|
+
# condition. It is meant to be read and understood by programs that
|
2336
|
+
# detect and handle errors by type.
|
2148
2337
|
# @return [String]
|
2149
2338
|
#
|
2150
2339
|
# @!attribute [rw] message
|
2340
|
+
# The error message contains a generic description of the error
|
2341
|
+
# condition in English. It is intended for a human audience. Simple
|
2342
|
+
# programs display the message directly to the end user if they
|
2343
|
+
# encounter an error condition they don't know how or don't care to
|
2344
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2345
|
+
# and proper internationalization are more likely to ignore the error
|
2346
|
+
# message.
|
2151
2347
|
# @return [String]
|
2152
2348
|
#
|
2153
2349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/SecurityGroupNotFound AWS API Documentation
|
@@ -2163,9 +2359,19 @@ module Aws::EFS
|
|
2163
2359
|
# request.
|
2164
2360
|
#
|
2165
2361
|
# @!attribute [rw] error_code
|
2362
|
+
# The error code is a string that uniquely identifies an error
|
2363
|
+
# condition. It is meant to be read and understood by programs that
|
2364
|
+
# detect and handle errors by type.
|
2166
2365
|
# @return [String]
|
2167
2366
|
#
|
2168
2367
|
# @!attribute [rw] message
|
2368
|
+
# The error message contains a generic description of the error
|
2369
|
+
# condition in English. It is intended for a human audience. Simple
|
2370
|
+
# programs display the message directly to the end user if they
|
2371
|
+
# encounter an error condition they don't know how or don't care to
|
2372
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2373
|
+
# and proper internationalization are more likely to ignore the error
|
2374
|
+
# message.
|
2169
2375
|
# @return [String]
|
2170
2376
|
#
|
2171
2377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/SubnetNotFound AWS API Documentation
|
@@ -2181,14 +2387,6 @@ module Aws::EFS
|
|
2181
2387
|
# space, and numbers that can be represented in UTF-8, and the following
|
2182
2388
|
# characters:` + - = . _ : /`.
|
2183
2389
|
#
|
2184
|
-
# @note When making an API call, you may pass Tag
|
2185
|
-
# data as a hash:
|
2186
|
-
#
|
2187
|
-
# {
|
2188
|
-
# key: "TagKey", # required
|
2189
|
-
# value: "TagValue", # required
|
2190
|
-
# }
|
2191
|
-
#
|
2192
2390
|
# @!attribute [rw] key
|
2193
2391
|
# The tag key (String). The key can't start with `aws:`.
|
2194
2392
|
# @return [String]
|
@@ -2206,19 +2404,6 @@ module Aws::EFS
|
|
2206
2404
|
include Aws::Structure
|
2207
2405
|
end
|
2208
2406
|
|
2209
|
-
# @note When making an API call, you may pass TagResourceRequest
|
2210
|
-
# data as a hash:
|
2211
|
-
#
|
2212
|
-
# {
|
2213
|
-
# resource_id: "ResourceId", # required
|
2214
|
-
# tags: [ # required
|
2215
|
-
# {
|
2216
|
-
# key: "TagKey", # required
|
2217
|
-
# value: "TagValue", # required
|
2218
|
-
# },
|
2219
|
-
# ],
|
2220
|
-
# }
|
2221
|
-
#
|
2222
2407
|
# @!attribute [rw] resource_id
|
2223
2408
|
# The ID specifying the EFS resource that you want to create a tag
|
2224
2409
|
# for.
|
@@ -2238,14 +2423,57 @@ module Aws::EFS
|
|
2238
2423
|
include Aws::Structure
|
2239
2424
|
end
|
2240
2425
|
|
2426
|
+
# Returned when the `CreateAccessPoint` API action is called too quickly
|
2427
|
+
# and the number of Access Points on the file system is nearing the
|
2428
|
+
# [limit of 120][1].
|
2429
|
+
#
|
2430
|
+
#
|
2431
|
+
#
|
2432
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region
|
2433
|
+
#
|
2434
|
+
# @!attribute [rw] error_code
|
2435
|
+
# The error code is a string that uniquely identifies an error
|
2436
|
+
# condition. It is meant to be read and understood by programs that
|
2437
|
+
# detect and handle errors by type.
|
2438
|
+
# @return [String]
|
2439
|
+
#
|
2440
|
+
# @!attribute [rw] message
|
2441
|
+
# The error message contains a generic description of the error
|
2442
|
+
# condition in English. It is intended for a human audience. Simple
|
2443
|
+
# programs display the message directly to the end user if they
|
2444
|
+
# encounter an error condition they don't know how or don't care to
|
2445
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2446
|
+
# and proper internationalization are more likely to ignore the error
|
2447
|
+
# message.
|
2448
|
+
# @return [String]
|
2449
|
+
#
|
2450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ThrottlingException AWS API Documentation
|
2451
|
+
#
|
2452
|
+
class ThrottlingException < Struct.new(
|
2453
|
+
:error_code,
|
2454
|
+
:message)
|
2455
|
+
SENSITIVE = []
|
2456
|
+
include Aws::Structure
|
2457
|
+
end
|
2458
|
+
|
2241
2459
|
# Returned if the throughput mode or amount of provisioned throughput
|
2242
2460
|
# can't be changed because the throughput limit of 1024 MiB/s has been
|
2243
2461
|
# reached.
|
2244
2462
|
#
|
2245
2463
|
# @!attribute [rw] error_code
|
2464
|
+
# The error code is a string that uniquely identifies an error
|
2465
|
+
# condition. It is meant to be read and understood by programs that
|
2466
|
+
# detect and handle errors by type.
|
2246
2467
|
# @return [String]
|
2247
2468
|
#
|
2248
2469
|
# @!attribute [rw] message
|
2470
|
+
# The error message contains a generic description of the error
|
2471
|
+
# condition in English. It is intended for a human audience. Simple
|
2472
|
+
# programs display the message directly to the end user if they
|
2473
|
+
# encounter an error condition they don't know how or don't care to
|
2474
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2475
|
+
# and proper internationalization are more likely to ignore the error
|
2476
|
+
# message.
|
2249
2477
|
# @return [String]
|
2250
2478
|
#
|
2251
2479
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ThroughputLimitExceeded AWS API Documentation
|
@@ -2257,13 +2485,23 @@ module Aws::EFS
|
|
2257
2485
|
include Aws::Structure
|
2258
2486
|
end
|
2259
2487
|
|
2260
|
-
# Returned if you don’t wait at least 24 hours before changing
|
2261
|
-
# throughput mode, or decreasing the Provisioned Throughput value.
|
2488
|
+
# Returned if you don’t wait at least 24 hours before either changing
|
2489
|
+
# the throughput mode, or decreasing the Provisioned Throughput value.
|
2262
2490
|
#
|
2263
2491
|
# @!attribute [rw] error_code
|
2492
|
+
# The error code is a string that uniquely identifies an error
|
2493
|
+
# condition. It is meant to be read and understood by programs that
|
2494
|
+
# detect and handle errors by type.
|
2264
2495
|
# @return [String]
|
2265
2496
|
#
|
2266
2497
|
# @!attribute [rw] message
|
2498
|
+
# The error message contains a generic description of the error
|
2499
|
+
# condition in English. It is intended for a human audience. Simple
|
2500
|
+
# programs display the message directly to the end user if they
|
2501
|
+
# encounter an error condition they don't know how or don't care to
|
2502
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2503
|
+
# and proper internationalization are more likely to ignore the error
|
2504
|
+
# message.
|
2267
2505
|
# @return [String]
|
2268
2506
|
#
|
2269
2507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/TooManyRequests AWS API Documentation
|
@@ -2279,9 +2517,19 @@ module Aws::EFS
|
|
2279
2517
|
# the specified Availability Zone.
|
2280
2518
|
#
|
2281
2519
|
# @!attribute [rw] error_code
|
2520
|
+
# The error code is a string that uniquely identifies an error
|
2521
|
+
# condition. It is meant to be read and understood by programs that
|
2522
|
+
# detect and handle errors by type.
|
2282
2523
|
# @return [String]
|
2283
2524
|
#
|
2284
2525
|
# @!attribute [rw] message
|
2526
|
+
# The error message contains a generic description of the error
|
2527
|
+
# condition in English. It is intended for a human audience. Simple
|
2528
|
+
# programs display the message directly to the end user if they
|
2529
|
+
# encounter an error condition they don't know how or don't care to
|
2530
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2531
|
+
# and proper internationalization are more likely to ignore the error
|
2532
|
+
# message.
|
2285
2533
|
# @return [String]
|
2286
2534
|
#
|
2287
2535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UnsupportedAvailabilityZone AWS API Documentation
|
@@ -2293,14 +2541,6 @@ module Aws::EFS
|
|
2293
2541
|
include Aws::Structure
|
2294
2542
|
end
|
2295
2543
|
|
2296
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
2297
|
-
# data as a hash:
|
2298
|
-
#
|
2299
|
-
# {
|
2300
|
-
# resource_id: "ResourceId", # required
|
2301
|
-
# tag_keys: ["TagKey"], # required
|
2302
|
-
# }
|
2303
|
-
#
|
2304
2544
|
# @!attribute [rw] resource_id
|
2305
2545
|
# Specifies the EFS resource that you want to remove tags from.
|
2306
2546
|
# @return [String]
|
@@ -2319,15 +2559,6 @@ module Aws::EFS
|
|
2319
2559
|
include Aws::Structure
|
2320
2560
|
end
|
2321
2561
|
|
2322
|
-
# @note When making an API call, you may pass UpdateFileSystemRequest
|
2323
|
-
# data as a hash:
|
2324
|
-
#
|
2325
|
-
# {
|
2326
|
-
# file_system_id: "FileSystemId", # required
|
2327
|
-
# throughput_mode: "bursting", # accepts bursting, provisioned
|
2328
|
-
# provisioned_throughput_in_mibps: 1.0,
|
2329
|
-
# }
|
2330
|
-
#
|
2331
2562
|
# @!attribute [rw] file_system_id
|
2332
2563
|
# The ID of the file system that you want to update.
|
2333
2564
|
# @return [String]
|
@@ -2341,11 +2572,17 @@ module Aws::EFS
|
|
2341
2572
|
# @return [String]
|
2342
2573
|
#
|
2343
2574
|
# @!attribute [rw] provisioned_throughput_in_mibps
|
2344
|
-
# (Optional)
|
2345
|
-
#
|
2346
|
-
#
|
2347
|
-
#
|
2348
|
-
#
|
2575
|
+
# (Optional) The throughput, measured in mebibytes per second (MiBps),
|
2576
|
+
# that you want to provision for a file system that you're creating.
|
2577
|
+
# Required if `ThroughputMode` is set to `provisioned`. Valid values
|
2578
|
+
# are 1-3414 MiBps, with the upper limit depending on Region. To
|
2579
|
+
# increase this limit, contact Amazon Web Services Support. For more
|
2580
|
+
# information, see [Amazon EFS quotas that you can increase][1] in the
|
2581
|
+
# *Amazon EFS User Guide*.
|
2582
|
+
#
|
2583
|
+
#
|
2584
|
+
#
|
2585
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits
|
2349
2586
|
# @return [Float]
|
2350
2587
|
#
|
2351
2588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UpdateFileSystemRequest AWS API Documentation
|
@@ -2362,9 +2599,19 @@ module Aws::EFS
|
|
2362
2599
|
# Services Region in which the request was made.
|
2363
2600
|
#
|
2364
2601
|
# @!attribute [rw] error_code
|
2602
|
+
# The error code is a string that uniquely identifies an error
|
2603
|
+
# condition. It is meant to be read and understood by programs that
|
2604
|
+
# detect and handle errors by type.
|
2365
2605
|
# @return [String]
|
2366
2606
|
#
|
2367
2607
|
# @!attribute [rw] message
|
2608
|
+
# The error message contains a generic description of the error
|
2609
|
+
# condition in English. It is intended for a human audience. Simple
|
2610
|
+
# programs display the message directly to the end user if they
|
2611
|
+
# encounter an error condition they don't know how or don't care to
|
2612
|
+
# handle. Sophisticated programs with more exhaustive error handling
|
2613
|
+
# and proper internationalization are more likely to ignore the error
|
2614
|
+
# message.
|
2368
2615
|
# @return [String]
|
2369
2616
|
#
|
2370
2617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ValidationException AWS API Documentation
|