AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
![]() |
AccessPointAlreadyExistsException |
Returned if the access point that you are trying to create already exists, with the creation token you provided in the request. |
![]() |
AccessPointDescription |
Provides a description of an EFS file system access point. |
![]() |
AccessPointLimitExceededException |
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. |
![]() |
AccessPointNotFoundException |
Returned if the specified |
![]() |
AvailabilityZonesMismatchException |
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. |
![]() |
BackupPolicy |
The backup policy for the file system used to create automatic daily backups. If status
has a value of |
![]() |
BadRequestException |
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. |
![]() |
ConflictException |
Returned if the source file system in a replication is encrypted but the destination file system is unencrypted. |
![]() |
CreateAccessPointRequest |
Container for the parameters to the CreateAccessPoint operation.
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
Access points can be tagged on creation. If tags are specified in the creation action,
IAM performs additional authorization on the |
![]() |
CreateAccessPointResponse |
Provides a description of an EFS file system access point. |
![]() |
CreateFileSystemRequest |
Container for the parameters to the CreateFileSystem operation. 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:
Otherwise, this operation returns a For basic use cases, you can use a randomly generated UUID for the creation token.
The idempotent operation allows you to retry a For more information, see Creating a file system in the Amazon EFS User Guide.
The
This operation accepts an optional
The
You can set the throughput mode for the file system using the
After the file system is fully created, Amazon EFS sets its lifecycle state to
This operation requires permissions for the
File systems can be tagged on creation. If tags are specified in the creation action,
IAM performs additional authorization on the |
![]() |
CreateFileSystemResponse |
A description of the file system. |
![]() |
CreateMountTargetRequest |
Container for the parameters to the CreateMountTarget operation. 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 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 In the request, provide the following:
After creating the mount target, Amazon EFS returns a response that includes, a 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:
If the request satisfies the requirements, Amazon EFS does the following:
The 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:
This operation also requires permissions for the following Amazon EC2 actions:
|
![]() |
CreateMountTargetResponse |
Provides a description of a mount target. |
![]() |
CreateReplicationConfigurationRequest |
Container for the parameters to the CreateReplicationConfiguration operation. Creates a replication configuration to either a new or existing EFS file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:
This operation requires permissions for the |
![]() |
CreateReplicationConfigurationResponse |
Describes the replication configuration for a specific file system. |
![]() |
CreateTagsRequest |
Container for the parameters to the CreateTags operation.
DEPRECATED -
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
This operation requires permission for the |
![]() |
CreateTagsResponse |
This is the response object from the CreateTags operation. |
![]() |
CreationInfo |
Required if the 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 |
![]() |
DeleteAccessPointRequest |
Container for the parameters to the DeleteAccessPoint operation. 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 |
![]() |
DeleteAccessPointResponse |
This is the response object from the DeleteAccessPoint operation. |
![]() |
DeleteFileSystemPolicyRequest |
Container for the parameters to the DeleteFileSystemPolicy operation.
Deletes the
This operation requires permissions for the |
![]() |
DeleteFileSystemPolicyResponse |
This is the response object from the DeleteFileSystemPolicy operation. |
![]() |
DeleteFileSystemRequest |
Container for the parameters to the DeleteFileSystem operation. 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
This operation requires permissions for the |
![]() |
DeleteFileSystemResponse |
This is the response object from the DeleteFileSystem operation. |
![]() |
DeleteMountTargetRequest |
Container for the parameters to the DeleteMountTarget operation. 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:
The The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:
|
![]() |
DeleteMountTargetResponse |
This is the response object from the DeleteMountTarget operation. |
![]() |
DeleteReplicationConfigurationRequest |
Container for the parameters to the DeleteReplicationConfiguration operation.
Deletes a replication configuration. Deleting a replication configuration ends the
replication process. After a replication configuration is deleted, the destination
file system becomes
This operation requires permissions for the |
![]() |
DeleteReplicationConfigurationResponse |
This is the response object from the DeleteReplicationConfiguration operation. |
![]() |
DeleteTagsRequest |
Container for the parameters to the DeleteTags operation.
DEPRECATED -
Deletes the specified tags from a file system. If the
This operation requires permissions for the |
![]() |
DeleteTagsResponse |
This is the response object from the DeleteTags operation. |
![]() |
DependencyTimeoutException |
The service timed out trying to fulfill the request, and the client should try the call again. |
![]() |
DescribeAccessPointsRequest |
Container for the parameters to the DescribeAccessPoints operation.
Returns the description of a specific Amazon EFS access point if the
This operation requires permissions for the |
![]() |
DescribeAccessPointsResponse |
This is the response object from the DescribeAccessPoints operation. |
![]() |
DescribeAccountPreferencesRequest |
Container for the parameters to the DescribeAccountPreferences operation. 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. |
![]() |
DescribeAccountPreferencesResponse |
This is the response object from the DescribeAccountPreferences operation. |
![]() |
DescribeBackupPolicyRequest |
Container for the parameters to the DescribeBackupPolicy operation. Returns the backup policy for the specified EFS file system. |
![]() |
DescribeBackupPolicyResponse |
This is the response object from the DescribeBackupPolicy operation. |
![]() |
DescribeFileSystemPolicyRequest |
Container for the parameters to the DescribeFileSystemPolicy operation.
Returns the
This operation requires permissions for the |
![]() |
DescribeFileSystemPolicyResponse |
This is the response object from the DescribeFileSystemPolicy operation. |
![]() |
DescribeFileSystemsRequest |
Container for the parameters to the DescribeFileSystems operation.
Returns the description of a specific Amazon EFS file system if either the file system
When retrieving all file system descriptions, you can optionally specify the
To retrieve a list of your file system descriptions, this operation is used in an
iterative process, where
The order of file systems returned in the response of one
This operation requires permissions for the |
![]() |
DescribeFileSystemsResponse |
This is the response object from the DescribeFileSystems operation. |
![]() |
DescribeLifecycleConfigurationRequest |
Container for the parameters to the DescribeLifecycleConfiguration operation.
Returns the current
This operation requires permissions for the |
![]() |
DescribeLifecycleConfigurationResponse |
This is the response object from the DescribeLifecycleConfiguration operation. |
![]() |
DescribeMountTargetSecurityGroupsRequest |
Container for the parameters to the DescribeMountTargetSecurityGroups operation.
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 This operation requires permissions for the following actions:
|
![]() |
DescribeMountTargetSecurityGroupsResponse |
This is the response object from the DescribeMountTargetSecurityGroups operation. |
![]() |
DescribeMountTargetsRequest |
Container for the parameters to the DescribeMountTargets operation. 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 |
![]() |
DescribeMountTargetsResponse | |
![]() |
DescribeReplicationConfigurationsRequest |
Container for the parameters to the DescribeReplicationConfigurations operation. 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. |
![]() |
DescribeReplicationConfigurationsResponse |
This is the response object from the DescribeReplicationConfigurations operation. |
![]() |
DescribeTagsRequest |
Container for the parameters to the DescribeTags operation.
DEPRECATED - The
Returns the tags associated with a file system. The order of tags returned in the
response of one
This operation requires permissions for the |
![]() |
DescribeTagsResponse | |
![]() |
Destination |
Describes the destination file system in the replication configuration. |
![]() |
DestinationToCreate |
Describes the new or existing destination file system for the replication configuration.
|
![]() |
ElasticFileSystemPaginatorFactory |
Paginators for the ElasticFileSystem service |
![]() |
FileSystemAlreadyExistsException |
Returned if the file system you are trying to create already exists, with the creation token you provided. |
![]() |
FileSystemDescription |
A description of the file system. |
![]() |
FileSystemInUseException |
Returned if a file system has mount targets. |
![]() |
FileSystemLimitExceededException |
Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account. |
![]() |
FileSystemNotFoundException |
Returned if the specified |
![]() |
FileSystemProtectionDescription |
Describes the protection on a file system. |
![]() |
FileSystemSize |
The latest known metered size (in bytes) of data stored in the file system, in its
|
![]() |
IncorrectFileSystemLifeCycleStateException |
Returned if the file system's lifecycle state is not "available". |
![]() |
IncorrectMountTargetStateException |
Returned if the mount target is not in the correct state for the operation. |
![]() |
InsufficientThroughputCapacityException |
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. |
![]() |
InternalServerErrorException |
Returned if an error occurred on the server side. |
![]() |
InvalidPolicyException |
Returned if the |
![]() |
IpAddressInUseException |
Returned if the request specified an |
![]() |
LifecyclePolicy |
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 |
![]() |
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. 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 |
![]() |
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
![]() |
ModifyMountTargetSecurityGroupsRequest |
Container for the parameters to the ModifyMountTargetSecurityGroups operation. 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
The operation requires permissions for the following actions:
|
![]() |
ModifyMountTargetSecurityGroupsResponse |
This is the response object from the ModifyMountTargetSecurityGroups operation. |
![]() |
MountTargetConflictException |
Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets. |
![]() |
MountTargetDescription |
Provides a description of a mount target. |
![]() |
MountTargetNotFoundException |
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account. |
![]() |
NetworkInterfaceLimitExceededException |
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). |
![]() |
NoFreeAddressesInSubnetException |
Returned if |
![]() |
PolicyNotFoundException |
Returned if the default file system policy is in effect for the EFS file system specified. |
![]() |
PosixUser |
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. |
![]() |
PutAccountPreferencesRequest |
Container for the parameters to the PutAccountPreferences operation.
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.
|
![]() |
PutAccountPreferencesResponse |
This is the response object from the PutAccountPreferences operation. |
![]() |
PutBackupPolicyRequest |
Container for the parameters to the PutBackupPolicy operation. Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. |
![]() |
PutBackupPolicyResponse |
This is the response object from the PutBackupPolicy operation. |
![]() |
PutFileSystemPolicyRequest |
Container for the parameters to the PutFileSystemPolicy operation.
Applies an Amazon EFS
EFS file system policies have a 20,000 character limit.
This operation requires permissions for the |
![]() |
PutFileSystemPolicyResponse |
This is the response object from the PutFileSystemPolicy operation. |
![]() |
PutLifecycleConfigurationRequest |
Container for the parameters to the PutLifecycleConfiguration operation.
Use this action to manage storage for your file system. A
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
This operation requires permissions for the
To apply a |
![]() |
PutLifecycleConfigurationResponse |
This is the response object from the PutLifecycleConfiguration operation. |
![]() |
ReplicationAlreadyExistsException |
Returned if the file system is already included in a replication configuration.> |
![]() |
ReplicationConfigurationDescription |
Describes the replication configuration for a specific file system. |
![]() |
ReplicationNotFoundException |
Returned if the specified file system does not have a replication configuration. |
![]() |
ResourceIdPreference |
Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region. |
![]() |
RootDirectory |
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 |
![]() |
SecurityGroupLimitExceededException |
Returned if the size of |
![]() |
SecurityGroupNotFoundException |
Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC). |
![]() |
SubnetNotFoundException |
Returned if there is no subnet with ID |
![]() |
Tag |
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: |
![]() |
TagResourceRequest |
Container for the parameters to the TagResource operation. 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 |
![]() |
TagResourceResponse |
This is the response object from the TagResource operation. |
![]() |
ThrottlingException |
Returned when the |
![]() |
ThroughputLimitExceededException |
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. |
![]() |
TooManyRequestsException |
Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value. |
![]() |
UnsupportedAvailabilityZoneException |
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone. |
![]() |
UntagResourceRequest |
Container for the parameters to the UntagResource operation. 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 |
![]() |
UntagResourceResponse |
This is the response object from the UntagResource operation. |
![]() |
UpdateFileSystemProtectionRequest |
Container for the parameters to the UpdateFileSystemProtection operation. Updates protection on the file system.
This operation requires permissions for the |
![]() |
UpdateFileSystemProtectionResponse |
Describes the protection on a file system. |
![]() |
UpdateFileSystemRequest |
Container for the parameters to the UpdateFileSystem operation. Updates the throughput mode or the amount of provisioned throughput of an existing file system. |
![]() |
UpdateFileSystemResponse |
A description of the file system. |
![]() |
ValidationException |
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made. |
Name | Description | |
---|---|---|
![]() |
IDescribeAccessPointsPaginator |
Paginator for the DescribeAccessPoints operation |
![]() |
IDescribeFileSystemsPaginator |
Paginator for the DescribeFileSystems operation |
![]() |
IDescribeMountTargetsPaginator |
Paginator for the DescribeMountTargets operation |
![]() |
IDescribeReplicationConfigurationsPaginator |
Paginator for the DescribeReplicationConfigurations operation |
![]() |
IDescribeTagsPaginator |
Paginator for the DescribeTags operation |
![]() |
IElasticFileSystemPaginatorFactory |
Paginators for the ElasticFileSystem service |
![]() |
IListTagsForResourcePaginator |
Paginator for the ListTagsForResource operation |