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 | |
---|---|---|
BadRequestException | ElasticFileSystem exception | |
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 AWS account with the specified creation token, this
operation does the following:
Otherwise, this operation returns a
The idempotent operation allows you to retry a 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 API, which among other things returns the file system
state.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 (CreateMountTarget) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works
This operation requires permission for the |
|
CreateFileSystemResponse | Configuration for accessing Amazon CreateFileSystem service | |
CreateFileSystemResult | This object provides description of a 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 via 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. For more information, see Amazon EFS: How it Works. In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be "available" (see DescribeFileSystems). In the request, you also provide a subnet ID, which serves several purposes:
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 request to add another mount target must meet the following requirements:
If the request satisfies the requirements, Amazon EFS does the following:
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 DescribeFileSystems API,
which among other things returns the mount target state.We recommend 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, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target. This operation requires permission for the following action on the file system:
This operation also requires permission for the following Amazon EC2 actions:
|
|
CreateMountTargetResponse | Configuration for accessing Amazon CreateMountTarget service | |
CreateMountTargetResult | This object provides description of a mount target. | |
CreateTagsRequest |
Container for the parameters to the CreateTags operation.
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
API.
This operation requires permission for the |
|
CreateTagsResponse | ||
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 will not be able to access any contents of
the deleted file system.
You cannot 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. DeleteFileSystem call returns while the file system state
is still "deleting". You can check the file system deletion status by calling the
DescribeFileSystems API, 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
will return a 404 "FileSystemNotFound" error.
This operation requires permission for the |
|
DeleteFileSystemResponse | ||
DeleteMountTargetRequest |
Container for the parameters to the DeleteMountTarget operation.
Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system via the mount target 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 may 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 using another mount target. This operation requires permission for the following action on the file system:
DeleteMountTarget
call returns while the mount target state is still "deleting". You can check the mount
target deletion by calling the DescribeMountTargets API, which returns a list
of mount target descriptions for the given file system. The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:
|
|
DeleteMountTargetResponse | ||
DeleteTagsRequest |
Container for the parameters to the DeleteTags operation.
Deletes the specified tags from a file system. If the DeleteTags request
includes a tag key that does not exist, Amazon EFS ignores it; it is not an error.
For more information about tags and related restrictions, go to Tag
Restrictions in the AWS Billing and Cost Management User Guide.
This operation requires permission for the |
|
DeleteTagsResponse | ||
DependencyTimeoutException | ElasticFileSystem exception | |
DescribeFileSystemsRequest |
Container for the parameters to the DescribeFileSystems operation.
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken or the FileSystemId is provided; otherwise,
returns descriptions of all file systems owned by the caller's AWS account in the
AWS region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the
So to retrieve a list of your file system descriptions, the expected usage of this
API is an iterative process of first calling
Note that the implementation may return fewer than
The order of file systems returned in the response of one
This operation requires permission for the |
|
DescribeFileSystemsResponse | Configuration for accessing Amazon DescribeFileSystems service | |
DescribeFileSystemsResult | ||
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 life
cycle state of the mount target is not "deleted".
This operation requires permissions for the following actions:
|
|
DescribeMountTargetSecurityGroupsResponse | Configuration for accessing Amazon DescribeMountTargetSecurityGroups service | |
DescribeMountTargetSecurityGroupsResult | ||
DescribeMountTargetsRequest |
Container for the parameters to the DescribeMountTargets operation.
Returns the descriptions of the current mount targets for a file system. The order
of mount targets returned in the response is unspecified.
This operation requires permission for the |
|
DescribeMountTargetsResponse | Configuration for accessing Amazon DescribeMountTargets service | |
DescribeMountTargetsResult | ||
DescribeTagsRequest |
Container for the parameters to the DescribeTags operation.
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 multi-call iteration (when using pagination), is unspecified.
This operation requires permission for the |
|
DescribeTagsResponse | Configuration for accessing Amazon DescribeTags service | |
DescribeTagsResult | ||
FileSystemAlreadyExistsException | ElasticFileSystem exception | |
FileSystemDescription | This object provides description of a file system. | |
FileSystemInUseException | ElasticFileSystem exception | |
FileSystemLimitExceededException | ElasticFileSystem exception | |
FileSystemNotFoundException | ElasticFileSystem exception | |
FileSystemSize |
This object provides 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. Note that the value does not 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 will represent 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.
|
|
IncorrectFileSystemLifeCycleStateException | ElasticFileSystem exception | |
IncorrectMountTargetStateException | ElasticFileSystem exception | |
InternalServerErrorException | ElasticFileSystem exception | |
IpAddressInUseException | ElasticFileSystem exception | |
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 (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 | ||
MountTargetConflictException | ElasticFileSystem exception | |
MountTargetDescription | This object provides description of a mount target. | |
MountTargetNotFoundException | ElasticFileSystem exception | |
NetworkInterfaceLimitExceededException | ElasticFileSystem exception | |
NoFreeAddressesInSubnetException | ElasticFileSystem exception | |
SecurityGroupLimitExceededException | ElasticFileSystem exception | |
SecurityGroupNotFoundException | ElasticFileSystem exception | |
SubnetNotFoundException | ElasticFileSystem exception | |
Tag | A tag is a pair of key and value. The allowed characters in keys and values are letters, whitespace, and numbers, representable in UTF-8, and the characters '+', '-', '=', '.', '_', ':', and '/'. | |
UnsupportedAvailabilityZoneException | ElasticFileSystem exception |