Amazon Elastic File System 2015-02-01
- Client: Aws\Efs\EfsClient
- Service ID: elasticfilesystem
- Version: 2015-02-01
This page describes the parameters and results for the operations of the Amazon Elastic File System (2015-02-01), and shows how to use the Aws\Efs\EfsClient object to call the described operations. This documentation is specific to the 2015-02-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateAccessPoint ( array $params = [] )
- Creates an EFS access point.
- CreateFileSystem ( array $params = [] )
- Creates a new, empty file system.
- CreateMountTarget ( array $params = [] )
- Creates a mount target for a file system.
- CreateReplicationConfiguration ( array $params = [] )
- Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system.
- CreateTags ( array $params = [] )
- DEPRECATED - CreateTags is deprecated and not maintained.
- DeleteAccessPoint ( array $params = [] )
- Deletes the specified access point.
- DeleteFileSystem ( array $params = [] )
- Deletes a file system, permanently severing access to its contents.
- DeleteFileSystemPolicy ( array $params = [] )
- Deletes the FileSystemPolicy for the specified file system.
- DeleteMountTarget ( array $params = [] )
- Deletes the specified mount target.
- DeleteReplicationConfiguration ( array $params = [] )
- Deletes a replication configuration.
- DeleteTags ( array $params = [] )
- DEPRECATED - DeleteTags is deprecated and not maintained.
- DescribeAccessPoints ( array $params = [] )
- Returns the description of a specific Amazon EFS access point if the AccessPointId is provided.
- DescribeAccountPreferences ( array $params = [] )
- Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
- DescribeBackupPolicy ( array $params = [] )
- Returns the backup policy for the specified EFS file system.
- DescribeFileSystemPolicy ( array $params = [] )
- Returns the FileSystemPolicy for the specified EFS file system.
- DescribeFileSystems ( array $params = [] )
- Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
- DescribeLifecycleConfiguration ( array $params = [] )
- Returns the current LifecycleConfiguration object for the specified Amazon EFS file system.
- DescribeMountTargetSecurityGroups ( array $params = [] )
- Returns the security groups currently in effect for a mount target.
- DescribeMountTargets ( array $params = [] )
- Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
- DescribeReplicationConfigurations ( array $params = [] )
- Retrieves the replication configuration for a specific file system.
- DescribeTags ( array $params = [] )
- DEPRECATED - The DescribeTags action is deprecated and not maintained.
- ListTagsForResource ( array $params = [] )
- Lists all tags for a top-level EFS resource.
- ModifyMountTargetSecurityGroups ( array $params = [] )
- Modifies the set of security groups in effect for a mount target.
- PutAccountPreferences ( array $params = [] )
- Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources.
- PutBackupPolicy ( array $params = [] )
- Updates the file system's backup policy.
- PutFileSystemPolicy ( array $params = [] )
- Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system.
- PutLifecycleConfiguration ( array $params = [] )
- Use this action to manage storage for your file system.
- TagResource ( array $params = [] )
- Creates a tag for an EFS resource.
- UntagResource ( array $params = [] )
- Removes tags from an EFS resource.
- UpdateFileSystem ( array $params = [] )
- Updates the throughput mode or the amount of provisioned throughput of an existing file system.
- UpdateFileSystemProtection ( array $params = [] )
- Updates protection on the file system.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeAccessPoints
- DescribeFileSystems
- DescribeMountTargets
- DescribeReplicationConfigurations
- DescribeTags
- ListTagsForResource
Operations
CreateAccessPoint
$result = $client->createAccessPoint
([/* ... */]); $promise = $client->createAccessPointAsync
([/* ... */]);
Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access points.
If multiple requests to create access points on the same file system are sent in quick succession, and the file system is near the limit of 1,000 access points, you may experience a throttling response for these requests. This is to ensure that the file system does not exceed the stated access point limit.
This operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource
action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource
action. For more information, see Granting permissions to tag resources during creation.
Parameter Syntax
$result = $client->createAccessPoint([ 'ClientToken' => '<string>', // REQUIRED 'FileSystemId' => '<string>', // REQUIRED 'PosixUser' => [ 'Gid' => <integer>, // REQUIRED 'SecondaryGids' => [<integer>, ...], 'Uid' => <integer>, // REQUIRED ], 'RootDirectory' => [ 'CreationInfo' => [ 'OwnerGid' => <integer>, // REQUIRED 'OwnerUid' => <integer>, // REQUIRED 'Permissions' => '<string>', // REQUIRED ], 'Path' => '<string>', ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ClientToken
-
- Required: Yes
- Type: string
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the EFS file system that the access point provides access to.
- PosixUser
-
- Type: PosixUser structure
The operating system user and group applied to all file system requests made using the access point.
- RootDirectory
-
- Type: RootDirectory structure
Specifies the directory on the EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the
RootDirectory
>Path
specified does not exist, Amazon EFS creates it and applies theCreationInfo
settings when a client connects to an access point. When specifying aRootDirectory
, you must provide thePath
, and theCreationInfo
.Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.
- Tags
-
- Type: Array of Tag structures
Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
Result Syntax
[ 'AccessPointArn' => '<string>', 'AccessPointId' => '<string>', 'ClientToken' => '<string>', 'FileSystemId' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'Name' => '<string>', 'OwnerId' => '<string>', 'PosixUser' => [ 'Gid' => <integer>, 'SecondaryGids' => [<integer>, ...], 'Uid' => <integer>, ], 'RootDirectory' => [ 'CreationInfo' => [ 'OwnerGid' => <integer>, 'OwnerUid' => <integer>, 'Permissions' => '<string>', ], 'Path' => '<string>', ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- AccessPointArn
-
- Type: string
The unique Amazon Resource Name (ARN) associated with the access point.
- AccessPointId
-
- Type: string
The ID of the access point, assigned by Amazon EFS.
- ClientToken
-
- Type: string
The opaque string specified in the request to ensure idempotent creation.
- FileSystemId
-
- Type: string
The ID of the EFS file system that the access point applies to.
- LifeCycleState
-
- Type: string
Identifies the lifecycle phase of the access point.
- Name
-
- Type: string
The name of the access point. This is the value of the
Name
tag. - OwnerId
-
- Type: string
Identifies the Amazon Web Services account that owns the access point resource.
- PosixUser
-
- Type: PosixUser structure
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 NFS clients using the access point.
- RootDirectory
-
- Type: RootDirectory structure
The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- Tags
-
- Type: Array of Tag structures
The tags associated with the access point, presented as an array of Tag objects.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- AccessPointAlreadyExists:
Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.
- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- AccessPointLimitExceeded:
Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
- ThrottlingException:
Returned when the
CreateAccessPoint
API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120.
CreateFileSystem
$result = $client->createFileSystem
([/* ... */]); $promise = $client->createFileSystemAsync
([/* ... */]);
Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:
-
Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state
creating
. -
Returns with the description of the created file system.
Otherwise, this operation returns a FileSystemAlreadyExists
error with the ID of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation token.
The idempotent operation allows you to retry a CreateFileSystem
call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists
error.
For more information, see Creating a file system in the Amazon EFS User Guide.
The CreateFileSystem
call returns while the file system's lifecycle state is still creating
. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.
This operation accepts an optional PerformanceMode
parameter that you choose for your file system. We recommend generalPurpose
performance mode for all file systems. File systems using the maxIO
mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or file systems that use Elastic throughput.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes.
You can set the throughput mode for the file system using the ThroughputMode
parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to available
, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the elasticfilesystem:CreateFileSystem
action.
File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional authorization on the elasticfilesystem:TagResource
action to verify if users have permissions to create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource
action. For more information, see Granting permissions to tag resources during creation.
Parameter Syntax
$result = $client->createFileSystem([ 'AvailabilityZoneName' => '<string>', 'Backup' => true || false, 'CreationToken' => '<string>', // REQUIRED 'Encrypted' => true || false, 'KmsKeyId' => '<string>', 'PerformanceMode' => 'generalPurpose|maxIO', 'ProvisionedThroughputInMibps' => <float>, 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'ThroughputMode' => 'bursting|provisioned|elastic', ]);
Parameter Details
Members
- AvailabilityZoneName
-
- Type: string
Used to create a One Zone file system. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format
us-east-1a
to specify the Availability Zone. For more information about One Zone file systems, see Using EFS storage classes in the Amazon EFS User Guide.One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
- Backup
-
- Type: boolean
Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to
true
to enable automatic backups. If you are creating a One Zone file system, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide.Default is
false
. However, if you specify anAvailabilityZoneName
, the default istrue
.Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
- CreationToken
-
- Required: Yes
- Type: string
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
- Encrypted
-
- Type: boolean
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying an existing Key Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system. - KmsKeyId
-
- Type: string
The ID of the KMS key that you want to use to protect the encrypted file 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 formats:
-
Key ID - A unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab
. -
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Key alias - A previously created display name for a key, for example
alias/projectKey1
. -
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If you use
KmsKeyId
, you must set the CreateFileSystemRequest$Encrypted parameter to true.EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.
- PerformanceMode
-
- Type: string
The Performance mode of the file system. We recommend
generalPurpose
performance mode for all file systems. File systems using themaxIO
performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. ThemaxIO
mode is not supported on One Zone file systems.Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is
generalPurpose
. - ProvisionedThroughputInMibps
-
- Type: double
The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if
ThroughputMode
is set toprovisioned
. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide. - Tags
-
- Type: Array of Tag structures
Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a
"Key":"Name","Value":"{value}"
key-value pair. Each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide. - ThroughputMode
-
- Type: string
Specifies the throughput mode for the file system. The mode can be
bursting
,provisioned
, orelastic
. If you setThroughputMode
toprovisioned
, you must also set a value forProvisionedThroughputInMibps
. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.Default is
bursting
.
Result Syntax
[ 'AvailabilityZoneId' => '<string>', 'AvailabilityZoneName' => '<string>', 'CreationTime' => <DateTime>, 'CreationToken' => '<string>', 'Encrypted' => true || false, 'FileSystemArn' => '<string>', 'FileSystemId' => '<string>', 'FileSystemProtection' => [ 'ReplicationOverwriteProtection' => 'ENABLED|DISABLED|REPLICATING', ], 'KmsKeyId' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'Name' => '<string>', 'NumberOfMountTargets' => <integer>, 'OwnerId' => '<string>', 'PerformanceMode' => 'generalPurpose|maxIO', 'ProvisionedThroughputInMibps' => <float>, 'SizeInBytes' => [ 'Timestamp' => <DateTime>, 'Value' => <integer>, 'ValueInArchive' => <integer>, 'ValueInIA' => <integer>, 'ValueInStandard' => <integer>, ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ThroughputMode' => 'bursting|provisioned|elastic', ]
Result Details
Members
- AvailabilityZoneId
-
- Type: string
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example,
use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account. - AvailabilityZoneName
-
- Type: string
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
- CreationToken
-
- Required: Yes
- Type: string
The opaque string specified in the request.
- Encrypted
-
- Type: boolean
A Boolean value that, if true, indicates that the file system is encrypted.
- FileSystemArn
-
- Type: string
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
. Example with sample data:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system, assigned by Amazon EFS.
- FileSystemProtection
-
- Type: FileSystemProtectionDescription structure
Describes the protection on the file system.
- KmsKeyId
-
- Type: string
The ID of an KMS key used to protect the encrypted file system.
- LifeCycleState
-
- Required: Yes
- Type: string
The lifecycle phase of the file system.
- Name
-
- Type: string
You can add tags to a file system, including a
Name
tag. For more information, see CreateFileSystem. If the file system has aName
tag, Amazon EFS returns the value in this field. - NumberOfMountTargets
-
- Required: Yes
- Type: int
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
- OwnerId
-
- Required: Yes
- Type: string
The Amazon Web Services account that created the file system.
- PerformanceMode
-
- Required: Yes
- Type: string
The Performance mode of the file system.
- ProvisionedThroughputInMibps
-
- Type: double
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set toprovisioned
. - SizeInBytes
-
- Required: Yes
- Type: FileSystemSize structure
The latest known metered size (in bytes) of data stored in the file system, in its
Value
field, and the time at which that size was determined in itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is,SizeInBytes
represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time. - Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags associated with the file system, presented as an array of
Tag
objects. - ThroughputMode
-
- Type: string
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemAlreadyExists:
Returned if the file system you are trying to create already exists, with the creation token you provided.
- FileSystemLimitExceeded:
Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
- InsufficientThroughputCapacity:
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
- ThroughputLimitExceeded:
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
- UnsupportedAvailabilityZone:
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
Examples
Example 1: To create a new file system
This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.
$result = $client->createFileSystem([ 'Backup' => 1, 'CreationToken' => 'tokenstring', 'Encrypted' => 1, 'PerformanceMode' => 'generalPurpose', 'Tags' => [ [ 'Key' => 'Name', 'Value' => 'MyFileSystem', ], ], ]);
Result syntax:
[ 'CreationTime' =>, 'CreationToken' => 'tokenstring', 'Encrypted' => 1, 'FileSystemId' => 'fs-01234567', 'LifeCycleState' => 'creating', 'NumberOfMountTargets' => 0, 'OwnerId' => '012345678912', 'PerformanceMode' => 'generalPurpose', 'SizeInBytes' => [ 'Value' => 0, ], 'Tags' => [ [ 'Key' => 'Name', 'Value' => 'MyFileSystem', ], ], ]
CreateMountTarget
$result = $client->createMountTarget
([/* ... */]); $promise = $client->createMountTargetAsync
([/* ... */]);
Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.
You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system.
You can create only one mount target for a One Zone file system. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName
and AvailabiltyZoneId
properties in the DescribeFileSystems response object to get this information. Use the subnetId
associated with the file system's Availability Zone when creating the mount target.
For more information, see Amazon EFS: How it Works.
To create a mount target for a file system, the file system's lifecycle state must be available
. For more information, see DescribeFileSystems.
In the request, provide the following:
-
The file system ID for which you are creating the mount target.
-
A subnet ID, which determines the following:
-
The VPC in which Amazon EFS creates the mount target
-
The Availability Zone in which Amazon EFS creates the mount target
-
The IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)
-
After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId
and an IpAddress
. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.
Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:
-
Must belong to the same VPC as the subnets of the existing mount targets
-
Must not be in the same Availability Zone as any of the subnets of the existing mount targets
If the request satisfies the requirements, Amazon EFS does the following:
-
Creates a new mount target in the specified subnet.
-
Also creates a new network interface in the subnet as follows:
-
If the request provides an
IpAddress
, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2CreateNetworkInterface
call does when a request does not specify a primary private IP address). -
If the request provides
SecurityGroups
, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. -
Assigns the description
Mount target fsmt-id for file system fs-id
wherefsmt-id
is the mount target ID, andfs-id
is theFileSystemId
. -
Sets the
requesterManaged
property of the network interface totrue
, and therequesterId
value toEFS
.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the
NetworkInterfaceId
field in the mount target's description to the network interface ID, and theIpAddress
field to its address. If network interface creation fails, the entireCreateMountTarget
operation fails. -
The CreateMountTarget
call returns only after creating the network interface, but while the mount target state is still creating
, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.
We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.
This operation requires permissions for the following action on the file system:
-
elasticfilesystem:CreateMountTarget
This operation also requires permissions for the following Amazon EC2 actions:
-
ec2:DescribeSubnets
-
ec2:DescribeNetworkInterfaces
-
ec2:CreateNetworkInterface
Parameter Syntax
$result = $client->createMountTarget([ 'FileSystemId' => '<string>', // REQUIRED 'IpAddress' => '<string>', 'SecurityGroups' => ['<string>', ...], 'SubnetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system for which to create the mount target.
- IpAddress
-
- Type: string
Valid IPv4 address within the address range of the specified subnet.
- SecurityGroups
-
- Type: Array of strings
Up to five VPC security group IDs, of the form
sg-xxxxxxxx
. These must be for the same VPC as subnet specified. - SubnetId
-
- Required: Yes
- Type: string
The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.
Result Syntax
[ 'AvailabilityZoneId' => '<string>', 'AvailabilityZoneName' => '<string>', 'FileSystemId' => '<string>', 'IpAddress' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'MountTargetId' => '<string>', 'NetworkInterfaceId' => '<string>', 'OwnerId' => '<string>', 'SubnetId' => '<string>', 'VpcId' => '<string>', ]
Result Details
Members
- AvailabilityZoneId
-
- Type: string
The unique and consistent identifier of the Availability Zone that the mount target resides in. For example,
use1-az1
is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services account. - AvailabilityZoneName
-
- Type: string
The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone
us-east-1a
for your Amazon Web Services account might not be the same location asus-east-1a
for another Amazon Web Services account. - FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system for which the mount target is intended.
- IpAddress
-
- Type: string
Address at which the file system can be mounted by using the mount target.
- LifeCycleState
-
- Required: Yes
- Type: string
Lifecycle state of the mount target.
- MountTargetId
-
- Required: Yes
- Type: string
System-assigned mount target ID.
- NetworkInterfaceId
-
- Type: string
The ID of the network interface that Amazon EFS created when it created the mount target.
- OwnerId
-
- Type: string
Amazon Web Services account ID that owns the resource.
- SubnetId
-
- Required: Yes
- Type: string
The ID of the mount target's subnet.
- VpcId
-
- Type: string
The virtual private cloud (VPC) ID that the mount target is configured in.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
- MountTargetConflict:
Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
- SubnetNotFound:
Returned if there is no subnet with ID
SubnetId
provided in the request.- NoFreeAddressesInSubnet:
Returned if
IpAddress
was not specified in the request and there are no free IP addresses in the subnet.- IpAddressInUse:
Returned if the request specified an
IpAddress
that is already in use in the subnet.- NetworkInterfaceLimitExceeded:
The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).
- SecurityGroupLimitExceeded:
Returned if the size of
SecurityGroups
specified in the request is greater than five.- SecurityGroupNotFound:
Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
- UnsupportedAvailabilityZone:
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
- AvailabilityZonesMismatch:
Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.
Examples
Example 1: To create a new mount target
This operation creates a new mount target for an EFS file system.
$result = $client->createMountTarget([ 'FileSystemId' => 'fs-01234567', 'SubnetId' => 'subnet-1234abcd', ]);
Result syntax:
[ 'FileSystemId' => 'fs-01234567', 'IpAddress' => '192.0.0.2', 'LifeCycleState' => 'creating', 'MountTargetId' => 'fsmt-12340abc', 'NetworkInterfaceId' => 'eni-cedf6789', 'OwnerId' => '012345678912', 'SubnetId' => 'subnet-1234abcd', ]
CreateReplicationConfiguration
$result = $client->createReplicationConfiguration
([/* ... */]); $promise = $client->createReplicationConfigurationAsync
([/* ... */]);
Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:
-
Source file system – The EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.
-
Amazon Web Services Region – The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. The Region must be enabled. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide.
-
Destination file system configuration – The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration.
Parameters for the replication configuration include:
-
File system ID – The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings. For existing file systems, the file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system.
-
Availability Zone – If you want the destination file system to use One Zone storage, you must specify the Availability Zone to create the file system in. For more information, see EFS file system types in the Amazon EFS User Guide.
-
Encryption – All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used.
After the file system is created, you cannot change the KMS key.
-
After the file system is created, you cannot change the KMS key.
For new destination file systems, the following properties are set by default:
-
Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed.
-
Throughput mode - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode.
-
Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable lifecycle management.
-
Automatic backups – Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting.
For more information, see Amazon EFS replication in the Amazon EFS User Guide.
Parameter Syntax
$result = $client->createReplicationConfiguration([ 'Destinations' => [ // REQUIRED [ 'AvailabilityZoneName' => '<string>', 'FileSystemId' => '<string>', 'KmsKeyId' => '<string>', 'Region' => '<string>', ], // ... ], 'SourceFileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Destinations
-
- Required: Yes
- Type: Array of DestinationToCreate structures
An array of destination configuration objects. Only one destination configuration object is supported.
- SourceFileSystemId
-
- Required: Yes
- Type: string
Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.
Result Syntax
[ 'CreationTime' => <DateTime>, 'Destinations' => [ [ 'FileSystemId' => '<string>', 'LastReplicatedTimestamp' => <DateTime>, 'Region' => '<string>', 'Status' => 'ENABLED|ENABLING|DELETING|ERROR|PAUSED|PAUSING', ], // ... ], 'OriginalSourceFileSystemArn' => '<string>', 'SourceFileSystemArn' => '<string>', 'SourceFileSystemId' => '<string>', 'SourceFileSystemRegion' => '<string>', ]
Result Details
Members
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Describes when the replication configuration was created.
- Destinations
-
- Required: Yes
- Type: Array of Destination structures
An array of destination objects. Only one destination object is supported.
- OriginalSourceFileSystemArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the original source EFS file system in the replication configuration.
- SourceFileSystemArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
- SourceFileSystemId
-
- Required: Yes
- Type: string
The ID of the source Amazon EFS file system that is being replicated.
- SourceFileSystemRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region in which the source EFS file system is located.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
- ValidationException:
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
- ReplicationNotFound:
Returned if the specified file system does not have a replication configuration.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- UnsupportedAvailabilityZone:
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
- FileSystemLimitExceeded:
Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
- InsufficientThroughputCapacity:
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
- ThroughputLimitExceeded:
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
- ConflictException:
Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
- InternalServerError:
Returned if an error occurred on the server side.
CreateTags
$result = $client->createTags
([/* ... */]); $promise = $client->createTagsAsync
([/* ... */]);
DEPRECATED - CreateTags
is deprecated and not maintained. To create tags for EFS resources, use the API action.
Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name
tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.
This operation requires permission for the elasticfilesystem:CreateTags
action.
Parameter Syntax
$result = $client->createTags([ 'FileSystemId' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
An array of
Tag
objects to add. EachTag
object is a key-value pair.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
Examples
Example 1: To create a new tag
This operation creates a new tag for an EFS file system.
$result = $client->createTags([ 'FileSystemId' => 'fs-01234567', 'Tags' => [ [ 'Key' => 'Name', 'Value' => 'MyFileSystem', ], ], ]);
DeleteAccessPoint
$result = $client->deleteAccessPoint
([/* ... */]); $promise = $client->deleteAccessPointAsync
([/* ... */]);
Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.
This operation requires permissions for the elasticfilesystem:DeleteAccessPoint
action.
Parameter Syntax
$result = $client->deleteAccessPoint([ 'AccessPointId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccessPointId
-
- Required: Yes
- Type: string
The ID of the access point that you want to delete.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- AccessPointNotFound:
Returned if the specified
AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
DeleteFileSystem
$result = $client->deleteFileSystem
([/* ... */]); $promise = $client->deleteFileSystemAsync
([/* ... */]);
Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.
You need to manually delete mount targets attached to a file system before you can delete an EFS file system. This step is performed for you when you use the Amazon Web Services console to delete a file system.
You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the replication configuration first.
You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
The DeleteFileSystem
call returns while the file system state is still deleting
. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound
error.
This operation requires permissions for the elasticfilesystem:DeleteFileSystem
action.
Parameter Syntax
$result = $client->deleteFileSystem([ 'FileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system you want to delete.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- FileSystemInUse:
Returned if a file system has mount targets.
Examples
Example 1: To delete a file system
This operation deletes an EFS file system.
$result = $client->deleteFileSystem([ 'FileSystemId' => 'fs-01234567', ]);
DeleteFileSystemPolicy
$result = $client->deleteFileSystemPolicy
([/* ... */]); $promise = $client->deleteFileSystemPolicyAsync
([/* ... */]);
Deletes the FileSystemPolicy
for the specified file system. The default FileSystemPolicy
goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS.
This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy
action.
Parameter Syntax
$result = $client->deleteFileSystemPolicy([ 'FileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
Specifies the EFS file system for which to delete the
FileSystemPolicy
.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
DeleteMountTarget
$result = $client->deleteMountTarget
([/* ... */]); $promise = $client->deleteMountTargetAsync
([/* ... */]);
Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.
This operation requires permissions for the following action on the file system:
-
elasticfilesystem:DeleteMountTarget
The DeleteMountTarget
call returns while the mount target state is still deleting
. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.
The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:
-
ec2:DeleteNetworkInterface
Parameter Syntax
$result = $client->deleteMountTarget([ 'MountTargetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MountTargetId
-
- Required: Yes
- Type: string
The ID of the mount target to delete (String).
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- DependencyTimeout:
The service timed out trying to fulfill the request, and the client should try the call again.
- MountTargetNotFound:
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
Examples
Example 1: To delete a mount target
This operation deletes a mount target.
$result = $client->deleteMountTarget([ 'MountTargetId' => 'fsmt-12340abc', ]);
DeleteReplicationConfiguration
$result = $client->deleteReplicationConfiguration
([/* ... */]); $promise = $client->deleteReplicationConfigurationAsync
([/* ... */]);
Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable
and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.
This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration
action.
Parameter Syntax
$result = $client->deleteReplicationConfiguration([ 'SourceFileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- SourceFileSystemId
-
- Required: Yes
- Type: string
The ID of the source file system in the replication configuration.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- ReplicationNotFound:
Returned if the specified file system does not have a replication configuration.
DeleteTags
$result = $client->deleteTags
([/* ... */]); $promise = $client->deleteTagsAsync
([/* ... */]);
DEPRECATED - DeleteTags
is deprecated and not maintained. To remove tags from EFS resources, use the API action.
Deletes the specified tags from a file system. If the DeleteTags
request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag restrictions in the Billing and Cost Management User Guide.
This operation requires permissions for the elasticfilesystem:DeleteTags
action.
Parameter Syntax
$result = $client->deleteTags([ 'FileSystemId' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system whose tags you want to delete (String).
- TagKeys
-
- Required: Yes
- Type: Array of strings
A list of tag keys to delete.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
Examples
Example 1: To delete tags for an EFS file system
This operation deletes tags for an EFS file system.
$result = $client->deleteTags([ 'FileSystemId' => 'fs-01234567', 'TagKeys' => [ 'Name', ], ]);
DescribeAccessPoints
$result = $client->describeAccessPoints
([/* ... */]); $promise = $client->describeAccessPointsAsync
([/* ... */]);
Returns the description of a specific Amazon EFS access point if the AccessPointId
is provided. If you provide an EFS FileSystemId
, it returns descriptions of all access points for that file system. You can provide either an AccessPointId
or a FileSystemId
in the request, but not both.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
Parameter Syntax
$result = $client->describeAccessPoints([ 'AccessPointId' => '<string>', 'FileSystemId' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AccessPointId
-
- Type: string
(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with
FileSystemId
. - FileSystemId
-
- Type: string
(Optional) If you provide a
FileSystemId
, EFS returns all access points for that file system; mutually exclusive withAccessPointId
. - MaxResults
-
- Type: int
(Optional) When retrieving all access points for a file system, you can optionally specify the
MaxItems
parameter to limit the number of objects returned in a response. The default value is 100. - NextToken
-
- Type: string
NextToken
is present if the response is paginated. You can useNextMarker
in the subsequent request to fetch the next page of access point descriptions.
Result Syntax
[ 'AccessPoints' => [ [ 'AccessPointArn' => '<string>', 'AccessPointId' => '<string>', 'ClientToken' => '<string>', 'FileSystemId' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'Name' => '<string>', 'OwnerId' => '<string>', 'PosixUser' => [ 'Gid' => <integer>, 'SecondaryGids' => [<integer>, ...], 'Uid' => <integer>, ], 'RootDirectory' => [ 'CreationInfo' => [ 'OwnerGid' => <integer>, 'OwnerUid' => <integer>, 'Permissions' => '<string>', ], 'Path' => '<string>', ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AccessPoints
-
- Type: Array of AccessPointDescription structures
An array of access point descriptions.
- NextToken
-
- Type: string
Present if there are more access points than returned in the response. You can use the NextMarker in the subsequent request to fetch the additional descriptions.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- AccessPointNotFound:
Returned if the specified
AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
DescribeAccountPreferences
$result = $client->describeAccountPreferences
([/* ... */]); $promise = $client->describeAccountPreferencesAsync
([/* ... */]);
Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
Parameter Syntax
$result = $client->describeAccountPreferences([ 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- MaxResults
-
- Type: int
(Optional) When retrieving account preferences, you can optionally specify the
MaxItems
parameter to limit the number of objects returned in a response. The default value is 100. - NextToken
-
- Type: string
(Optional) You can use
NextToken
in a subsequent request to fetch the next page of Amazon Web Services account preferences if the response payload was paginated.
Result Syntax
[ 'NextToken' => '<string>', 'ResourceIdPreference' => [ 'ResourceIdType' => 'LONG_ID|SHORT_ID', 'Resources' => ['<string>', ...], ], ]
Result Details
Members
- NextToken
-
- Type: string
Present if there are more records than returned in the response. You can use the
NextToken
in the subsequent request to fetch the additional descriptions. - ResourceIdPreference
-
- Type: ResourceIdPreference structure
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.
Errors
- InternalServerError:
Returned if an error occurred on the server side.
DescribeBackupPolicy
$result = $client->describeBackupPolicy
([/* ... */]); $promise = $client->describeBackupPolicyAsync
([/* ... */]);
Returns the backup policy for the specified EFS file system.
Parameter Syntax
$result = $client->describeBackupPolicy([ 'FileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
Specifies which EFS file system for which to retrieve the
BackupPolicy
.
Result Syntax
[ 'BackupPolicy' => [ 'Status' => 'ENABLED|ENABLING|DISABLED|DISABLING', ], ]
Result Details
Members
- BackupPolicy
-
- Type: BackupPolicy structure
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- InternalServerError:
Returned if an error occurred on the server side.
- PolicyNotFound:
Returned if the default file system policy is in effect for the EFS file system specified.
- ValidationException:
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
DescribeFileSystemPolicy
$result = $client->describeFileSystemPolicy
([/* ... */]); $promise = $client->describeFileSystemPolicyAsync
([/* ... */]);
Returns the FileSystemPolicy
for the specified EFS file system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
action.
Parameter Syntax
$result = $client->describeFileSystemPolicy([ 'FileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
Specifies which EFS file system to retrieve the
FileSystemPolicy
for.
Result Syntax
[ 'FileSystemId' => '<string>', 'Policy' => '<string>', ]
Result Details
Members
- FileSystemId
-
- Type: string
Specifies the EFS file system to which the
FileSystemPolicy
applies. - Policy
-
- Type: string
The JSON formatted
FileSystemPolicy
for the EFS file system.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- PolicyNotFound:
Returned if the default file system policy is in effect for the EFS file system specified.
DescribeFileSystems
$result = $client->describeFileSystems
([/* ... */]); $promise = $client->describeFileSystemsAsync
([/* ... */]);
Returns the description of a specific Amazon EFS file system if either the file system CreationToken
or the FileSystemId
is provided. Otherwise, it returns descriptions of all file systems owned by the caller's Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxItems
parameter to limit the number of descriptions in a response. This number is automatically set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker
, an opaque token, in the response. In this case, you should send a subsequent request with the Marker
request parameter set to the value of NextMarker
.
To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems
is called first without the Marker
and then the operation continues to call it with the Marker
parameter set to the value of the NextMarker
from the previous response until the response has no NextMarker
.
The order of file systems returned in the response of one DescribeFileSystems
call and the order of file systems returned across the responses of a multi-call iteration is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeFileSystems
action.
Parameter Syntax
$result = $client->describeFileSystems([ 'CreationToken' => '<string>', 'FileSystemId' => '<string>', 'Marker' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
- CreationToken
-
- Type: string
(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.
- FileSystemId
-
- Type: string
(Optional) ID of the file system whose description you want to retrieve (String).
- Marker
-
- Type: string
(Optional) Opaque pagination token returned from a previous
DescribeFileSystems
operation (String). If present, specifies to continue the list from where the returning call had left off. - MaxItems
-
- Type: int
(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.
Result Syntax
[ 'FileSystems' => [ [ 'AvailabilityZoneId' => '<string>', 'AvailabilityZoneName' => '<string>', 'CreationTime' => <DateTime>, 'CreationToken' => '<string>', 'Encrypted' => true || false, 'FileSystemArn' => '<string>', 'FileSystemId' => '<string>', 'FileSystemProtection' => [ 'ReplicationOverwriteProtection' => 'ENABLED|DISABLED|REPLICATING', ], 'KmsKeyId' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'Name' => '<string>', 'NumberOfMountTargets' => <integer>, 'OwnerId' => '<string>', 'PerformanceMode' => 'generalPurpose|maxIO', 'ProvisionedThroughputInMibps' => <float>, 'SizeInBytes' => [ 'Timestamp' => <DateTime>, 'Value' => <integer>, 'ValueInArchive' => <integer>, 'ValueInIA' => <integer>, 'ValueInStandard' => <integer>, ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ThroughputMode' => 'bursting|provisioned|elastic', ], // ... ], 'Marker' => '<string>', 'NextMarker' => '<string>', ]
Result Details
Members
- FileSystems
-
- Type: Array of FileSystemDescription structures
An array of file system descriptions.
- Marker
-
- Type: string
Present if provided by caller in the request (String).
- NextMarker
-
- Type: string
Present if there are more file systems than returned in the response (String). You can use the
NextMarker
in the subsequent request to fetch the descriptions.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
Examples
Example 1: To describe an EFS file system
This operation describes all of the EFS file systems in an account.
$result = $client->describeFileSystems([ ]);
Result syntax:
[ 'FileSystems' => [ [ 'CreationTime' =>, 'CreationToken' => 'tokenstring', 'FileSystemId' => 'fs-01234567', 'LifeCycleState' => 'available', 'Name' => 'MyFileSystem', 'NumberOfMountTargets' => 1, 'OwnerId' => '012345678912', 'PerformanceMode' => 'generalPurpose', 'SizeInBytes' => [ 'Value' => 6144, ], 'Tags' => [ [ 'Key' => 'Name', 'Value' => 'MyFileSystem', ], ], ], ], ]
DescribeLifecycleConfiguration
$result = $client->describeLifecycleConfiguration
([/* ... */]); $promise = $client->describeLifecycleConfigurationAsync
([/* ... */]);
Returns the current LifecycleConfiguration
object for the specified Amazon EFS file system. Lifecycle management uses the LifecycleConfiguration
object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration
object, the call returns an empty array in the response.
This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration
operation.
Parameter Syntax
$result = $client->describeLifecycleConfiguration([ 'FileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system whose
LifecycleConfiguration
object you want to retrieve (String).
Result Syntax
[ 'LifecyclePolicies' => [ [ 'TransitionToArchive' => 'AFTER_1_DAY|AFTER_7_DAYS|AFTER_14_DAYS|AFTER_30_DAYS|AFTER_60_DAYS|AFTER_90_DAYS|AFTER_180_DAYS|AFTER_270_DAYS|AFTER_365_DAYS', 'TransitionToIA' => 'AFTER_7_DAYS|AFTER_14_DAYS|AFTER_30_DAYS|AFTER_60_DAYS|AFTER_90_DAYS|AFTER_1_DAY|AFTER_180_DAYS|AFTER_270_DAYS|AFTER_365_DAYS', 'TransitionToPrimaryStorageClass' => 'AFTER_1_ACCESS', ], // ... ], ]
Result Details
Members
- LifecyclePolicies
-
- Type: Array of LifecyclePolicy structures
An array of lifecycle management policies. EFS supports a maximum of one policy per file system.
Errors
- InternalServerError:
Returned if an error occurred on the server side.
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
Examples
Example 1: To describe the lifecycle configuration for a file system
This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class.
$result = $client->describeLifecycleConfiguration([ 'FileSystemId' => 'fs-01234567', ]);
Result syntax:
[ 'LifecyclePolicies' => [ [ 'TransitionToIA' => 'AFTER_30_DAYS', ], ], ]
DescribeMountTargetSecurityGroups
$result = $client->describeMountTargetSecurityGroups
([/* ... */]); $promise = $client->describeMountTargetSecurityGroupsAsync
([/* ... */]);
Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted
.
This operation requires permissions for the following actions:
-
elasticfilesystem:DescribeMountTargetSecurityGroups
action on the mount target's file system. -
ec2:DescribeNetworkInterfaceAttribute
action on the mount target's network interface.
Parameter Syntax
$result = $client->describeMountTargetSecurityGroups([ 'MountTargetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MountTargetId
-
- Required: Yes
- Type: string
The ID of the mount target whose security groups you want to retrieve.
Result Syntax
[ 'SecurityGroups' => ['<string>', ...], ]
Result Details
Members
- SecurityGroups
-
- Required: Yes
- Type: Array of strings
An array of security groups.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- MountTargetNotFound:
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
- IncorrectMountTargetState:
Returned if the mount target is not in the correct state for the operation.
Examples
Example 1: To describe the security groups for a mount target
This operation describes all of the security groups for a file system's mount target.
$result = $client->describeMountTargetSecurityGroups([ 'MountTargetId' => 'fsmt-12340abc', ]);
Result syntax:
[ 'SecurityGroups' => [ 'sg-4567abcd', ], ]
DescribeMountTargets
$result = $client->describeMountTargets
([/* ... */]); $promise = $client->describeMountTargetsAsync
([/* ... */]);
Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeMountTargets
action, on either the file system ID that you specify in FileSystemId
, or on the file system of the mount target that you specify in MountTargetId
.
Parameter Syntax
$result = $client->describeMountTargets([ 'AccessPointId' => '<string>', 'FileSystemId' => '<string>', 'Marker' => '<string>', 'MaxItems' => <integer>, 'MountTargetId' => '<string>', ]);
Parameter Details
Members
- AccessPointId
-
- Type: string
(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a
FileSystemId
orMountTargetId
is not included in your request. Accepts either an access point ID or ARN as input. - FileSystemId
-
- Type: string
(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an
AccessPointId
orMountTargetId
is not included. Accepts either a file system ID or ARN as input. - Marker
-
- Type: string
(Optional) Opaque pagination token returned from a previous
DescribeMountTargets
operation (String). If present, it specifies to continue the list from where the previous returning call left off. - MaxItems
-
- Type: int
(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.
- MountTargetId
-
- Type: string
(Optional) ID of the mount target that you want to have described (String). It must be included in your request if
FileSystemId
is not included. Accepts either a mount target ID or ARN as input.
Result Syntax
[ 'Marker' => '<string>', 'MountTargets' => [ [ 'AvailabilityZoneId' => '<string>', 'AvailabilityZoneName' => '<string>', 'FileSystemId' => '<string>', 'IpAddress' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'MountTargetId' => '<string>', 'NetworkInterfaceId' => '<string>', 'OwnerId' => '<string>', 'SubnetId' => '<string>', 'VpcId' => '<string>', ], // ... ], 'NextMarker' => '<string>', ]
Result Details
Members
- Marker
-
- Type: string
If the request included the
Marker
, the response returns that value in this field. - MountTargets
-
- Type: Array of MountTargetDescription structures
Returns the file system's mount targets as an array of
MountTargetDescription
objects. - NextMarker
-
- Type: string
If a value is present, there are more mount targets to return. In a subsequent request, you can provide
Marker
in your request with this value to retrieve the next set of mount targets.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- MountTargetNotFound:
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
- AccessPointNotFound:
Returned if the specified
AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
Examples
Example 1: To describe the mount targets for a file system
This operation describes all of a file system's mount targets.
$result = $client->describeMountTargets([ 'FileSystemId' => 'fs-01234567', ]);
Result syntax:
[ 'MountTargets' => [ [ 'FileSystemId' => 'fs-01234567', 'IpAddress' => '192.0.0.2', 'LifeCycleState' => 'available', 'MountTargetId' => 'fsmt-12340abc', 'NetworkInterfaceId' => 'eni-cedf6789', 'OwnerId' => '012345678912', 'SubnetId' => 'subnet-1234abcd', ], ], ]
DescribeReplicationConfigurations
$result = $client->describeReplicationConfigurations
([/* ... */]); $promise = $client->describeReplicationConfigurationsAsync
([/* ... */]);
Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.
Parameter Syntax
$result = $client->describeReplicationConfigurations([ 'FileSystemId' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- FileSystemId
-
- Type: string
You can retrieve the replication configuration for a specific file system by providing its file system ID.
- MaxResults
-
- Type: int
(Optional) To limit the number of objects returned in a response, you can specify the
MaxItems
parameter. The default value is 100. - NextToken
-
- Type: string
NextToken
is present if the response is paginated. You can useNextToken
in a subsequent request to fetch the next page of output.
Result Syntax
[ 'NextToken' => '<string>', 'Replications' => [ [ 'CreationTime' => <DateTime>, 'Destinations' => [ [ 'FileSystemId' => '<string>', 'LastReplicatedTimestamp' => <DateTime>, 'Region' => '<string>', 'Status' => 'ENABLED|ENABLING|DELETING|ERROR|PAUSED|PAUSING', ], // ... ], 'OriginalSourceFileSystemArn' => '<string>', 'SourceFileSystemArn' => '<string>', 'SourceFileSystemId' => '<string>', 'SourceFileSystemRegion' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
You can use the
NextToken
from the previous response in a subsequent request to fetch the additional descriptions. - Replications
-
- Type: Array of ReplicationConfigurationDescription structures
The collection of replication configurations that is returned.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- InternalServerError:
Returned if an error occurred on the server side.
- ReplicationNotFound:
Returned if the specified file system does not have a replication configuration.
- ValidationException:
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
DescribeTags
$result = $client->describeTags
([/* ... */]); $promise = $client->describeTagsAsync
([/* ... */]);
DEPRECATED - The DescribeTags
action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource
API action.
Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags
call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeTags
action.
Parameter Syntax
$result = $client->describeTags([ 'FileSystemId' => '<string>', // REQUIRED 'Marker' => '<string>', 'MaxItems' => <integer>, ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system whose tag set you want to retrieve.
- Marker
-
- Type: string
(Optional) An opaque pagination token returned from a previous
DescribeTags
operation (String). If present, it specifies to continue the list from where the previous call left off. - MaxItems
-
- Type: int
(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.
Result Syntax
[ 'Marker' => '<string>', 'NextMarker' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Marker
-
- Type: string
If the request included a
Marker
, the response returns that value in this field. - NextMarker
-
- Type: string
If a value is present, there are more tags to return. In a subsequent request, you can provide the value of
NextMarker
as the value of theMarker
parameter in your next request to retrieve the next set of tags. - Tags
-
- Required: Yes
- Type: Array of Tag structures
Returns tags associated with the file system as an array of
Tag
objects.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
Examples
Example 1: To describe the tags for a file system
This operation describes all of a file system's tags.
$result = $client->describeTags([ 'FileSystemId' => 'fs-01234567', ]);
Result syntax:
[ 'Tags' => [ [ 'Key' => 'Name', 'Value' => 'MyFileSystem', ], ], ]
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
Parameter Syntax
$result = $client->listTagsForResource([ 'MaxResults' => <integer>, 'NextToken' => '<string>', 'ResourceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.
- NextToken
-
- Type: string
(Optional) You can use
NextToken
in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated. - ResourceId
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'NextToken' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
NextToken
is present if the response payload is paginated. You can useNextToken
in a subsequent request to fetch the next page of access point descriptions. - Tags
-
- Type: Array of Tag structures
An array of the tags for the specified EFS resource.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- AccessPointNotFound:
Returned if the specified
AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
ModifyMountTargetSecurityGroups
$result = $client->modifyMountTargetSecurityGroups
([/* ... */]); $promise = $client->modifyMountTargetSecurityGroupsAsync
([/* ... */]);
Modifies the set of security groups in effect for a mount target.
When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups
provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted
.
The operation requires permissions for the following actions:
-
elasticfilesystem:ModifyMountTargetSecurityGroups
action on the mount target's file system. -
ec2:ModifyNetworkInterfaceAttribute
action on the mount target's network interface.
Parameter Syntax
$result = $client->modifyMountTargetSecurityGroups([ 'MountTargetId' => '<string>', // REQUIRED 'SecurityGroups' => ['<string>', ...], ]);
Parameter Details
Members
- MountTargetId
-
- Required: Yes
- Type: string
The ID of the mount target whose security groups you want to modify.
- SecurityGroups
-
- Type: Array of strings
An array of up to five VPC security group IDs.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- MountTargetNotFound:
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
- IncorrectMountTargetState:
Returned if the mount target is not in the correct state for the operation.
- SecurityGroupLimitExceeded:
Returned if the size of
SecurityGroups
specified in the request is greater than five.- SecurityGroupNotFound:
Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
Examples
Example 1: To modify the security groups associated with a mount target for a file system
This operation modifies the security groups associated with a mount target for a file system.
$result = $client->modifyMountTargetSecurityGroups([ 'MountTargetId' => 'fsmt-12340abc', 'SecurityGroups' => [ 'sg-abcd1234', ], ]);
PutAccountPreferences
$result = $client->putAccountPreferences
([/* ... */]); $promise = $client->putAccountPreferencesAsync
([/* ... */]);
Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.
Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.
Parameter Syntax
$result = $client->putAccountPreferences([ 'ResourceIdType' => 'LONG_ID|SHORT_ID', // REQUIRED ]);
Parameter Details
Members
- ResourceIdType
-
- Required: Yes
- Type: string
Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either
LONG_ID
(17 characters), orSHORT_ID
(8 characters).Starting in October, 2021, you will receive an error when setting the account preference to
SHORT_ID
. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount target resources.
Result Syntax
[ 'ResourceIdPreference' => [ 'ResourceIdType' => 'LONG_ID|SHORT_ID', 'Resources' => ['<string>', ...], ], ]
Result Details
Members
- ResourceIdPreference
-
- Type: ResourceIdPreference structure
Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
PutBackupPolicy
$result = $client->putBackupPolicy
([/* ... */]); $promise = $client->putBackupPolicyAsync
([/* ... */]);
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
Parameter Syntax
$result = $client->putBackupPolicy([ 'BackupPolicy' => [ // REQUIRED 'Status' => 'ENABLED|ENABLING|DISABLED|DISABLING', // REQUIRED ], 'FileSystemId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BackupPolicy
-
- Required: Yes
- Type: BackupPolicy structure
The backup policy included in the
PutBackupPolicy
request. - FileSystemId
-
- Required: Yes
- Type: string
Specifies which EFS file system to update the backup policy for.
Result Syntax
[ 'BackupPolicy' => [ 'Status' => 'ENABLED|ENABLING|DISABLED|DISABLING', ], ]
Result Details
Members
- BackupPolicy
-
- Type: BackupPolicy structure
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
- InternalServerError:
Returned if an error occurred on the server side.
- ValidationException:
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
PutFileSystemPolicy
$result = $client->putFileSystemPolicy
([/* ... */]); $promise = $client->putFileSystemPolicyAsync
([/* ... */]);
Applies an Amazon EFS FileSystemPolicy
to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy.
EFS file system policies have a 20,000 character limit.
This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy
action.
Parameter Syntax
$result = $client->putFileSystemPolicy([ 'BypassPolicyLockoutSafetyCheck' => true || false, 'FileSystemId' => '<string>', // REQUIRED 'Policy' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BypassPolicyLockoutSafetyCheck
-
- Type: boolean
(Optional) A boolean that specifies whether or not to bypass the
FileSystemPolicy
lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making futurePutFileSystemPolicy
requests on this file system. SetBypassPolicyLockoutSafetyCheck
toTrue
only when you intend to prevent the IAM principal that is making the request from making subsequentPutFileSystemPolicy
requests on this file system. The default value isFalse
. - FileSystemId
-
- Required: Yes
- Type: string
The ID of the EFS file system that you want to create or update the
FileSystemPolicy
for. - Policy
-
- Required: Yes
- Type: string
The
FileSystemPolicy
that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see EFS Resource-based Policies.
Result Syntax
[ 'FileSystemId' => '<string>', 'Policy' => '<string>', ]
Result Details
Members
- FileSystemId
-
- Type: string
Specifies the EFS file system to which the
FileSystemPolicy
applies. - Policy
-
- Type: string
The JSON formatted
FileSystemPolicy
for the EFS file system.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- InvalidPolicyException:
Returned if the
FileSystemPolicy
is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
PutLifecycleConfiguration
$result = $client->putLifecycleConfiguration
([/* ... */]); $promise = $client->putLifecycleConfigurationAsync
([/* ... */]);
Use this action to manage storage for your file system. A LifecycleConfiguration
consists of one or more LifecyclePolicy
objects that define the following:
-
TransitionToIA
– When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage. -
TransitionToArchive
– When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.
The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.
-
TransitionToPrimaryStorageClass
– Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.
For more information, see Managing file system storage.
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration
object already exists for the specified file system, a PutLifecycleConfiguration
call modifies the existing configuration. A PutLifecycleConfiguration
call with an empty LifecyclePolicies
array in the request body deletes any existing LifecycleConfiguration
. In the request, specify the following:
-
The ID for the file system for which you are enabling, disabling, or modifying Lifecycle management.
-
A
LifecyclePolicies
array ofLifecyclePolicy
objects that define when to move files to IA storage, to Archive storage, and back to primary storage.Amazon EFS requires that each
LifecyclePolicy
object have only have a single transition, so theLifecyclePolicies
array needs to be structured with separateLifecyclePolicy
objects. See the example requests in the following section for more information.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.
Parameter Syntax
$result = $client->putLifecycleConfiguration([ 'FileSystemId' => '<string>', // REQUIRED 'LifecyclePolicies' => [ // REQUIRED [ 'TransitionToArchive' => 'AFTER_1_DAY|AFTER_7_DAYS|AFTER_14_DAYS|AFTER_30_DAYS|AFTER_60_DAYS|AFTER_90_DAYS|AFTER_180_DAYS|AFTER_270_DAYS|AFTER_365_DAYS', 'TransitionToIA' => 'AFTER_7_DAYS|AFTER_14_DAYS|AFTER_30_DAYS|AFTER_60_DAYS|AFTER_90_DAYS|AFTER_1_DAY|AFTER_180_DAYS|AFTER_270_DAYS|AFTER_365_DAYS', 'TransitionToPrimaryStorageClass' => 'AFTER_1_ACCESS', ], // ... ], ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system for which you are creating the
LifecycleConfiguration
object (String). - LifecyclePolicies
-
- Required: Yes
- Type: Array of LifecyclePolicy structures
An array of
LifecyclePolicy
objects that define the file system'sLifecycleConfiguration
object. ALifecycleConfiguration
object informs EFS Lifecycle management of the following:-
TransitionToIA
– When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage. -
TransitionToArchive
– When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.
The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.
-
TransitionToPrimaryStorageClass
– Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.
When using the
put-lifecycle-configuration
CLI command or thePutLifecycleConfiguration
API action, Amazon EFS requires that eachLifecyclePolicy
object have only a single transition. This means that in a request body,LifecyclePolicies
must be structured as an array ofLifecyclePolicy
objects, one object for each storage transition. See the example requests in the following section for more information.
Result Syntax
[ 'LifecyclePolicies' => [ [ 'TransitionToArchive' => 'AFTER_1_DAY|AFTER_7_DAYS|AFTER_14_DAYS|AFTER_30_DAYS|AFTER_60_DAYS|AFTER_90_DAYS|AFTER_180_DAYS|AFTER_270_DAYS|AFTER_365_DAYS', 'TransitionToIA' => 'AFTER_7_DAYS|AFTER_14_DAYS|AFTER_30_DAYS|AFTER_60_DAYS|AFTER_90_DAYS|AFTER_1_DAY|AFTER_180_DAYS|AFTER_270_DAYS|AFTER_365_DAYS', 'TransitionToPrimaryStorageClass' => 'AFTER_1_ACCESS', ], // ... ], ]
Result Details
Members
- LifecyclePolicies
-
- Type: Array of LifecyclePolicy structures
An array of lifecycle management policies. EFS supports a maximum of one policy per file system.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
Examples
Example 1: Creates a new lifecycleconfiguration object for a file system
This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.
$result = $client->putLifecycleConfiguration([ 'FileSystemId' => 'fs-01234567', 'LifecyclePolicies' => [ [ 'TransitionToIA' => 'AFTER_30_DAYS', ], ], ]);
Result syntax:
[ 'LifecyclePolicies' => [ [ 'TransitionToIA' => 'AFTER_30_DAYS', ], ], ]
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.
This operation requires permissions for the elasticfilesystem:TagResource
action.
Parameter Syntax
$result = $client->tagResource([ 'ResourceId' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
The ID specifying the EFS resource that you want to create a tag for.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
An array of
Tag
objects to add. EachTag
object is a key-value pair.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- AccessPointNotFound:
Returned if the specified
AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.
This operation requires permissions for the elasticfilesystem:UntagResource
action.
Parameter Syntax
$result = $client->untagResource([ 'ResourceId' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceId
-
- Required: Yes
- Type: string
Specifies the EFS resource that you want to remove tags from.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the key-value tag pairs that you want to remove from the specified EFS resource.
Result Syntax
[]
Result Details
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- InternalServerError:
Returned if an error occurred on the server side.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- AccessPointNotFound:
Returned if the specified
AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
UpdateFileSystem
$result = $client->updateFileSystem
([/* ... */]); $promise = $client->updateFileSystemAsync
([/* ... */]);
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
Parameter Syntax
$result = $client->updateFileSystem([ 'FileSystemId' => '<string>', // REQUIRED 'ProvisionedThroughputInMibps' => <float>, 'ThroughputMode' => 'bursting|provisioned|elastic', ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system that you want to update.
- ProvisionedThroughputInMibps
-
- Type: double
(Optional) The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if
ThroughputMode
is set toprovisioned
. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide. - ThroughputMode
-
- Type: string
(Optional) Updates the file system's throughput mode. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the
ThroughputMode
toprovisioned
, you must also set a value forProvisionedThroughputInMibps
.
Result Syntax
[ 'AvailabilityZoneId' => '<string>', 'AvailabilityZoneName' => '<string>', 'CreationTime' => <DateTime>, 'CreationToken' => '<string>', 'Encrypted' => true || false, 'FileSystemArn' => '<string>', 'FileSystemId' => '<string>', 'FileSystemProtection' => [ 'ReplicationOverwriteProtection' => 'ENABLED|DISABLED|REPLICATING', ], 'KmsKeyId' => '<string>', 'LifeCycleState' => 'creating|available|updating|deleting|deleted|error', 'Name' => '<string>', 'NumberOfMountTargets' => <integer>, 'OwnerId' => '<string>', 'PerformanceMode' => 'generalPurpose|maxIO', 'ProvisionedThroughputInMibps' => <float>, 'SizeInBytes' => [ 'Timestamp' => <DateTime>, 'Value' => <integer>, 'ValueInArchive' => <integer>, 'ValueInIA' => <integer>, 'ValueInStandard' => <integer>, ], 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'ThroughputMode' => 'bursting|provisioned|elastic', ]
Result Details
Members
- AvailabilityZoneId
-
- Type: string
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example,
use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account. - AvailabilityZoneName
-
- Type: string
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
- CreationTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
- CreationToken
-
- Required: Yes
- Type: string
The opaque string specified in the request.
- Encrypted
-
- Type: boolean
A Boolean value that, if true, indicates that the file system is encrypted.
- FileSystemArn
-
- Type: string
The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
. Example with sample data:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system, assigned by Amazon EFS.
- FileSystemProtection
-
- Type: FileSystemProtectionDescription structure
Describes the protection on the file system.
- KmsKeyId
-
- Type: string
The ID of an KMS key used to protect the encrypted file system.
- LifeCycleState
-
- Required: Yes
- Type: string
The lifecycle phase of the file system.
- Name
-
- Type: string
You can add tags to a file system, including a
Name
tag. For more information, see CreateFileSystem. If the file system has aName
tag, Amazon EFS returns the value in this field. - NumberOfMountTargets
-
- Required: Yes
- Type: int
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
- OwnerId
-
- Required: Yes
- Type: string
The Amazon Web Services account that created the file system.
- PerformanceMode
-
- Required: Yes
- Type: string
The Performance mode of the file system.
- ProvisionedThroughputInMibps
-
- Type: double
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using
ThroughputMode
set toprovisioned
. - SizeInBytes
-
- Required: Yes
- Type: FileSystemSize structure
The latest known metered size (in bytes) of data stored in the file system, in its
Value
field, and the time at which that size was determined in itsTimestamp
field. TheTimestamp
value is the integer number of seconds since 1970-01-01T00:00:00Z. TheSizeInBytes
value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is,SizeInBytes
represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time. - Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags associated with the file system, presented as an array of
Tag
objects. - ThroughputMode
-
- Type: string
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
- InsufficientThroughputCapacity:
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
- InternalServerError:
Returned if an error occurred on the server side.
- ThroughputLimitExceeded:
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
- TooManyRequests:
Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
UpdateFileSystemProtection
$result = $client->updateFileSystemProtection
([/* ... */]); $promise = $client->updateFileSystemProtectionAsync
([/* ... */]);
Updates protection on the file system.
This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection
action.
Parameter Syntax
$result = $client->updateFileSystemProtection([ 'FileSystemId' => '<string>', // REQUIRED 'ReplicationOverwriteProtection' => 'ENABLED|DISABLED|REPLICATING', ]);
Parameter Details
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the file system to update.
- ReplicationOverwriteProtection
-
- Type: string
The status of the file system's replication overwrite protection.
-
ENABLED
– The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection isENABLED
by default. -
DISABLED
– The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. -
REPLICATING
– The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.
Result Syntax
[ 'ReplicationOverwriteProtection' => 'ENABLED|DISABLED|REPLICATING', ]
Result Details
Members
- ReplicationOverwriteProtection
-
- Type: string
The status of the file system's replication overwrite protection.
-
ENABLED
– The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection isENABLED
by default. -
DISABLED
– The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. -
REPLICATING
– The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.
Errors
- BadRequest:
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
- FileSystemNotFound:
Returned if the specified
FileSystemId
value doesn't exist in the requester's Amazon Web Services account.- IncorrectFileSystemLifeCycleState:
Returned if the file system's lifecycle state is not "available".
- InsufficientThroughputCapacity:
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
- InternalServerError:
Returned if an error occurred on the server side.
- ThroughputLimitExceeded:
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
- ReplicationAlreadyExists:
Returned if the file system is already included in a replication configuration.>
- TooManyRequests:
Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
Shapes
AccessPointAlreadyExists
Description
Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.
Members
- AccessPointId
-
- Required: Yes
- Type: string
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
AccessPointLimitExceeded
Description
Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
AccessPointNotFound
Description
Returned if the specified AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
AvailabilityZonesMismatch
Description
Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.
Members
- ErrorCode
-
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
BackupPolicy
Description
The backup policy for the file system used to create automatic daily backups. If status has a value of ENABLED
, the file system is being automatically backed up. For more information, see Automatic backups.
Members
- Status
-
- Required: Yes
- Type: string
Describes the status of the file system's backup policy.
-
ENABLED
– EFS is automatically backing up the file system. -
ENABLING
– EFS is turning on automatic backups for the file system. -
DISABLED
– Automatic back ups are turned off for the file system. -
DISABLING
– EFS is turning off automatic backups for the file system.
BadRequest
Description
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
ConflictException
Description
Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
Members
- ErrorCode
-
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
CreationInfo
Description
Required if the RootDirectory
> Path
specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory
> Path
. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo
, you must include values for all properties.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.
If you do not provide CreationInfo
and the specified RootDirectory
does not exist, attempts to mount the file system using the access point will fail.
Members
- OwnerGid
-
- Required: Yes
- Type: long (int|float)
Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - OwnerUid
-
- Required: Yes
- Type: long (int|float)
Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - Permissions
-
- Required: Yes
- Type: string
Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
DependencyTimeout
Description
The service timed out trying to fulfill the request, and the client should try the call again.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
Destination
Description
Describes the destination file system in the replication configuration.
Members
- FileSystemId
-
- Required: Yes
- Type: string
The ID of the destination Amazon EFS file system.
- LastReplicatedTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.
- Region
-
- Required: Yes
- Type: string
The Amazon Web Services Region in which the destination file system is located.
- Status
-
- Required: Yes
- Type: string
Describes the status of the destination EFS file system.
-
The
Paused
state occurs as a result of opting out of the source or destination Region after the replication configuration was created. To resume replication for the file system, you need to again opt in to the Amazon Web Services Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Guide. -
The
Error
state occurs when either the source or the destination file system (or both) is in a failed state and is unrecoverable. For more information, see Monitoring replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then restore the most recent backup of the failed file system (either the source or the destination) to a new file system.
DestinationToCreate
Description
Describes the new or existing destination file system for the replication configuration.
Members
- AvailabilityZoneName
-
- Type: string
To create a file system that uses One Zone storage, specify the name of the Availability Zone in which to create the destination file system.
- FileSystemId
-
- Type: string
The ID of the file system to use for the destination. The file system's replication overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new file system for the replication destination.
- KmsKeyId
-
- Type: string
Specify the Key Management Service (KMS) key that you want to use to encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,
/aws/elasticfilesystem
. This ID can be in one of the following formats:-
Key ID - The unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab
. -
ARN - The Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
. -
Key alias - A previously created display name for a key, for example
alias/projectKey1
. -
Key alias ARN - The ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
- Region
-
- Type: string
To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.
FileSystemAlreadyExists
Description
Returned if the file system you are trying to create already exists, with the creation token you provided.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- FileSystemId
-
- Required: Yes
- Type: string
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
FileSystemInUse
Description
Returned if a file system has mount targets.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
FileSystemLimitExceeded
Description
Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
FileSystemNotFound
Description
Returned if the specified FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
FileSystemSize
Description
The latest known metered size (in bytes) of data stored in the file system, in its Value
field, and the time at which that size was determined in its Timestamp
field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.
Members
- Timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the size of data, returned in the
Value
field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z. - Value
-
- Required: Yes
- Type: long (int|float)
The latest known metered size (in bytes) of data stored in the file system.
- ValueInArchive
-
- Type: long (int|float)
The latest known metered size (in bytes) of data stored in the Archive storage class.
- ValueInIA
-
- Type: long (int|float)
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- ValueInStandard
-
- Type: long (int|float)
The latest known metered size (in bytes) of data stored in the Standard storage class.
IncorrectFileSystemLifeCycleState
Description
Returned if the file system's lifecycle state is not "available".
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
IncorrectMountTargetState
Description
Returned if the mount target is not in the correct state for the operation.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
InsufficientThroughputCapacity
Description
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
InternalServerError
Description
Returned if an error occurred on the server side.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
InvalidPolicyException
Description
Returned if the FileSystemPolicy
is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.
Members
- ErrorCode
-
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
IpAddressInUse
Description
Returned if the request specified an IpAddress
that is already in use in the subnet.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
LifecyclePolicy
Description
Describes a policy used by Lifecycle management that specifies when to transition files into and out of storage classes. For more information, see Managing file system storage.
When using the put-lifecycle-configuration
CLI command or the PutLifecycleConfiguration
API action, Amazon EFS requires that each LifecyclePolicy
object have only a single transition. This means that in a request body, LifecyclePolicies
must be structured as an array of LifecyclePolicy
objects, one object for each transition. For more information, see the request examples in PutLifecycleConfiguration.
Members
- TransitionToArchive
-
- Type: string
The number of days after files were last accessed in primary storage (the Standard storage class) files at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
- TransitionToIA
-
- Type: string
The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
- TransitionToPrimaryStorageClass
-
- Type: string
Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
MountTargetConflict
Description
Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
MountTargetNotFound
Description
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
NetworkInterfaceLimitExceeded
Description
The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
NoFreeAddressesInSubnet
Description
Returned if IpAddress
was not specified in the request and there are no free IP addresses in the subnet.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
PolicyNotFound
Description
Returned if the default file system policy is in effect for the EFS file system specified.
Members
- ErrorCode
-
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
PosixUser
Description
The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
Members
- Gid
-
- Required: Yes
- Type: long (int|float)
The POSIX group ID used for all file system operations using this access point.
- SecondaryGids
-
- Type: Array of long (int|float)s
Secondary POSIX group IDs used for all file system operations using this access point.
- Uid
-
- Required: Yes
- Type: long (int|float)
The POSIX user ID used for all file system operations using this access point.
ReplicationAlreadyExists
Description
Returned if the file system is already included in a replication configuration.>
Members
- ErrorCode
-
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
ReplicationNotFound
Description
Returned if the specified file system does not have a replication configuration.
Members
- ErrorCode
-
- Type: string
ReplicationNotFound
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
ResourceIdPreference
Description
Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.
Members
- ResourceIdType
-
- Type: string
Identifies the EFS resource ID preference, either
LONG_ID
(17 characters) orSHORT_ID
(8 characters). - Resources
-
- Type: Array of strings
Identifies the Amazon EFS resources to which the ID preference setting applies,
FILE_SYSTEM
andMOUNT_TARGET
.
RootDirectory
Description
Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's RootDirectory
and it's subdirectories.
Members
- CreationInfo
-
- Type: CreationInfo structure
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties.If you do not provide
CreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - Path
-
- Type: string
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. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the
CreationInfo
.
SecurityGroupLimitExceeded
Description
Returned if the size of SecurityGroups
specified in the request is greater than five.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
SecurityGroupNotFound
Description
Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
SubnetNotFound
Description
Returned if there is no subnet with ID SubnetId
provided in the request.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
Tag
Description
A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /
.
Members
- Key
-
- Required: Yes
- Type: string
The tag key (String). The key can't start with
aws:
. - Value
-
- Required: Yes
- Type: string
The value of the tag key.
ThrottlingException
Description
Returned when the CreateAccessPoint
API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120.
Members
- ErrorCode
-
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
ThroughputLimitExceeded
Description
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
TooManyRequests
Description
Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
UnsupportedAvailabilityZone
Description
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
ValidationException
Description
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
Members
- ErrorCode
-
- Required: Yes
- Type: string
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
- Message
-
- Type: string
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.