@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonElasticFileSystem
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonElasticFileSystem instead.
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAccessPointResult |
createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
Creates an EFS access point.
|
CreateFileSystemResult |
createFileSystem(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty file system.
|
CreateMountTargetResult |
createMountTarget(CreateMountTargetRequest createMountTargetRequest)
Creates a mount target for a file system.
|
CreateReplicationConfigurationResult |
createReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest)
Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system.
|
CreateTagsResult |
createTags(CreateTagsRequest createTagsRequest)
Deprecated.
|
DeleteAccessPointResult |
deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
Deletes the specified access point.
|
DeleteFileSystemResult |
deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, permanently severing access to its contents.
|
DeleteFileSystemPolicyResult |
deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)
Deletes the
FileSystemPolicy for the specified file system. |
DeleteMountTargetResult |
deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)
Deletes the specified mount target.
|
DeleteReplicationConfigurationResult |
deleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest)
Deletes an existing replication configuration.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deprecated.
|
DescribeAccessPointsResult |
describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)
Returns the description of a specific Amazon EFS access point if the
AccessPointId is provided. |
DescribeAccountPreferencesResult |
describeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest)
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.
|
DescribeBackupPolicyResult |
describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)
Returns the backup policy for the specified EFS file system.
|
DescribeFileSystemPolicyResult |
describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)
Returns the
FileSystemPolicy for the specified EFS file system. |
DescribeFileSystemsResult |
describeFileSystems()
Simplified method form for invoking the DescribeFileSystems operation.
|
DescribeFileSystemsResult |
describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken
or the FileSystemId is provided. |
DescribeLifecycleConfigurationResult |
describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)
Returns the current
LifecycleConfiguration object for the specified Amazon EFS file system. |
DescribeMountTargetsResult |
describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)
Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
|
DescribeMountTargetSecurityGroupsResult |
describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)
Returns the security groups currently in effect for a mount target.
|
DescribeReplicationConfigurationsResult |
describeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)
Retrieves the replication configurations for either a specific file system, or all configurations for the Amazon
Web Services account in an Amazon Web Services Region if a file system is not specified.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Deprecated.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags for a top-level EFS resource.
|
ModifyMountTargetSecurityGroupsResult |
modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)
Modifies the set of security groups in effect for a mount target.
|
PutAccountPreferencesResult |
putAccountPreferences(PutAccountPreferencesRequest putAccountPreferencesRequest)
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.
|
PutBackupPolicyResult |
putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)
Updates the file system's backup policy.
|
PutFileSystemPolicyResult |
putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)
Applies an Amazon EFS
FileSystemPolicy to an Amazon EFS file system. |
PutLifecycleConfigurationResult |
putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)
Enables lifecycle management by creating a new
LifecycleConfiguration object. |
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Creates a tag for an EFS resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an EFS resource.
|
UpdateFileSystemResult |
updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "elasticfilesystem.us-east-1.amazonaws.com") or a full URL, including
the protocol (ex: "https://elasticfilesystem.us-east-1.amazonaws.com"). If the protocol is not specified here,
the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "elasticfilesystem.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://elasticfilesystem.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)CreateAccessPointResult createAccessPoint(CreateAccessPointRequest createAccessPointRequest)
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 its own directory and below. To learn more, see Mounting a file system using EFS access points.
This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
createAccessPointRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.AccessPointAlreadyExistsException - Returned if the access point you are trying to create already exists, with the creation token you
provided in the request.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AccessPointLimitExceededException - Returned if the Amazon Web Services account has already created the maximum number of access points
allowed per file system.CreateFileSystemResult createFileSystem(CreateFileSystemRequest createFileSystemRequest)
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 most file systems. File systems using the
maxIO 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. 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.
createFileSystemRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemAlreadyExistsException - Returned if the file system you are trying to create already exists, with the creation token you
provided.FileSystemLimitExceededException - Returned if the Amazon Web Services account has already created the maximum number of file systems
allowed per account.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 to provisioned throughput mode. Try again later.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.UnsupportedAvailabilityZoneException - Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
CreateFileSystemRequest request = new CreateFileSystemRequest().withCreationToken("tokenstring").withPerformanceMode("generalPurpose");
CreateFileSystemResult response = client.createFileSystem(request);CreateMountTargetResult createMountTarget(CreateMountTargetRequest createMountTargetRequest)
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 an EFS file system using One Zone storage classes. 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 EC2
CreateNetworkInterface 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 where
fsmt-id is the mount target ID, and fs-id is the
FileSystemId.
Sets the requesterManaged property of the network interface to true, and the
requesterId value to EFS.
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 the IpAddress field to its address. If network interface creation
fails, the entire CreateMountTarget 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
createMountTargetRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".MountTargetConflictException - Returned if the mount target would violate one of the specified restrictions based on the file system's
existing mount targets.SubnetNotFoundException - Returned if there is no subnet with ID SubnetId provided in the request.NoFreeAddressesInSubnetException - Returned if IpAddress was not specified in the request and there are no free IP addresses in
the subnet.IpAddressInUseException - Returned if the request specified an IpAddress that is already in use in the subnet.NetworkInterfaceLimitExceededException - The calling account has reached the limit for elastic network interfaces for the specific Amazon Web
Services Region. The client should try to delete some elastic network interfaces or get the account limit
raised. For more information, see Amazon VPC
Limits in the Amazon VPC User Guide (see the Network interfaces per VPC entry in the table).SecurityGroupLimitExceededException - Returned if the size of SecurityGroups specified in the request is greater than five.SecurityGroupNotFoundException - Returned if one of the specified security groups doesn't exist in the subnet's VPC.UnsupportedAvailabilityZoneException - Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.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 classes. For more information, see Regional and One Zone
storage redundancy.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
CreateMountTargetRequest request = new CreateMountTargetRequest().withFileSystemId("fs-01234567").withSubnetId("subnet-1234abcd");
CreateMountTargetResult response = client.createMountTarget(request);CreateReplicationConfigurationResult createReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest)
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. The replication configuration specifies the following:
Source file system - an existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.
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.
Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. EFS Replication is available in all Amazon Web Services Region that Amazon EFS is available in, except the following regions: Asia Pacific (Hong Kong) Europe (Milan), Middle East (Bahrain), Africa (Cape Town), and Asia Pacific (Jakarta).
Availability zone - If you want the destination file system to use One Zone availability and durability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide.
Encryption - All destination file systems are created with encryption at rest enabled. You can specify the KMS key that is used to encrypt the destination file system. Your service-managed KMS key for Amazon EFS is used if you don't specify a KMS key. You cannot change this after the file system is created.
The following properties are set by default:
Performance mode - The destination file system's performance mode will match that of the source file system, unless the destination file system uses 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 use the Bursting throughput mode by default. You can modify the throughput mode once the file system is created.
The following properties are turned off by default:
Lifecycle management - EFS lifecycle management and intelligent tiering are not enabled on the destination file system. You can enable EFS lifecycle management and intelligent tiering after the destination file system is created.
Automatic backups - Automatic daily backups not enabled on the destination file system. You can change this setting after the file system is created.
For more information, see Amazon EFS replication.
createReplicationConfigurationRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.IncorrectFileSystemLifeCycleStateException - 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.ReplicationNotFoundException - Returned if the specified file system did not have a replication configuration.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.UnsupportedAvailabilityZoneException - Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.FileSystemLimitExceededException - Returned if the Amazon Web Services account has already created the maximum number of file systems
allowed per account.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 to provisioned throughput mode. Try again later.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.InternalServerErrorException - Returned if an error occurred on the server side.@Deprecated CreateTagsResult createTags(CreateTagsRequest createTagsRequest)
DEPRECATED - CreateTags is deprecated and not maintained. Please use the API action to create tags for EFS resources.
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.
createTagsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
CreateTagsRequest request = new CreateTagsRequest().withFileSystemId("fs-01234567").withTags(new Tag().withKey("Name").withValue("MyFileSystem"));
CreateTagsResult response = client.createTags(request);DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest)
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.
deleteAccessPointRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.AccessPointNotFoundException - Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
Services account.DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
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 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.
deleteFileSystemRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.FileSystemInUseException - Returned if a file system has mount targets.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
DeleteFileSystemRequest request = new DeleteFileSystemRequest().withFileSystemId("fs-01234567");
DeleteFileSystemResult response = client.deleteFileSystem(request);DeleteFileSystemPolicyResult deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest)
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.
deleteFileSystemPolicyRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".DeleteMountTargetResult deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest)
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
deleteMountTargetRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.DependencyTimeoutException - The service timed out trying to fulfill the request, and the client should try the call again.MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services
account.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
DeleteMountTargetRequest request = new DeleteMountTargetRequest().withMountTargetId("fsmt-12340abc");
DeleteMountTargetResult response = client.deleteMountTarget(request);DeleteReplicationConfigurationResult deleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest)
Deletes an existing replication configuration. To delete a replication configuration, you must make the request
from the Amazon Web Services Region in which the destination file system is located. Deleting a replication
configuration ends the replication process. You can write to the destination file system once it's status becomes
Writeable.
deleteReplicationConfigurationRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.ReplicationNotFoundException - Returned if the specified file system did not have a replication configuration.@Deprecated DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
DEPRECATED - DeleteTags is deprecated and not maintained. Please use the API action to remove tags from EFS resources.
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.
deleteTagsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
DeleteTagsRequest request = new DeleteTagsRequest().withFileSystemId("fs-01234567").withTagKeys("Name");
DeleteTagsResult response = client.deleteTags(request);DescribeAccessPointsResult describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest)
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.
describeAccessPointsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AccessPointNotFoundException - Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
Services account.DescribeAccountPreferencesResult describeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest)
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. For more information, see Managing Amazon EFS resource IDs.
describeAccountPreferencesRequest - InternalServerErrorException - Returned if an error occurred on the server side.DescribeBackupPolicyResult describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest)
Returns the backup policy for the specified EFS file system.
describeBackupPolicyRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.InternalServerErrorException - Returned if an error occurred on the server side.PolicyNotFoundException - 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.DescribeFileSystemPolicyResult describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest)
Returns the FileSystemPolicy for the specified EFS file system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
describeFileSystemPolicyRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.PolicyNotFoundException - Returned if the default file system policy is in effect for the EFS file system specified.DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)
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. Currently, this number is automatically set to 10. 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.
describeFileSystemsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build(); DescribeFileSystemsRequest request = new DescribeFileSystemsRequest(); DescribeFileSystemsResult response = client.describeFileSystems(request);
DescribeFileSystemsResult describeFileSystems()
DescribeLifecycleConfigurationResult describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest)
Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS
lifecycle management uses the LifecycleConfiguration object to identify which files to move to the
EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object,
the call returns an empty array in the response.
When EFS Intelligent Tiering is enabled, TransitionToPrimaryStorageClass has a value of
AFTER_1_ACCESS.
This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration
operation.
describeLifecycleConfigurationRequest - InternalServerErrorException - Returned if an error occurred on the server side.BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.DescribeMountTargetSecurityGroupsResult describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest)
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.
describeMountTargetSecurityGroupsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services
account.IncorrectMountTargetStateException - Returned if the mount target is not in the correct state for the operation.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
DescribeMountTargetSecurityGroupsRequest request = new DescribeMountTargetSecurityGroupsRequest().withMountTargetId("fsmt-12340abc");
DescribeMountTargetSecurityGroupsResult response = client.describeMountTargetSecurityGroups(request);DescribeMountTargetsResult describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest)
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.
describeMountTargetsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services
account.AccessPointNotFoundException - Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
Services account.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
DescribeMountTargetsRequest request = new DescribeMountTargetsRequest().withFileSystemId("fs-01234567");
DescribeMountTargetsResult response = client.describeMountTargets(request);DescribeReplicationConfigurationsResult describeReplicationConfigurations(DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest)
Retrieves the replication configurations for either a specific file system, or all configurations for the Amazon Web Services account in an Amazon Web Services Region if a file system is not specified.
describeReplicationConfigurationsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.InternalServerErrorException - Returned if an error occurred on the server side.ReplicationNotFoundException - Returned if the specified file system did 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.@Deprecated DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the API action to remove tags from EFS resources.
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.
describeTagsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
DescribeTagsRequest request = new DescribeTagsRequest().withFileSystemId("fs-01234567");
DescribeTagsResult response = client.describeTags(request);ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AccessPointNotFoundException - Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
Services account.ModifyMountTargetSecurityGroupsResult modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest)
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.
modifyMountTargetSecurityGroupsRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services
account.IncorrectMountTargetStateException - Returned if the mount target is not in the correct state for the operation.SecurityGroupLimitExceededException - Returned if the size of SecurityGroups specified in the request is greater than five.SecurityGroupNotFoundException - Returned if one of the specified security groups doesn't exist in the subnet's VPC.AmazonElasticFileSystem client = AmazonElasticFileSystemClientBuilder.standard().build();
ModifyMountTargetSecurityGroupsRequest request = new ModifyMountTargetSecurityGroupsRequest().withMountTargetId("fsmt-12340abc").withSecurityGroups(
"sg-abcd1234");
ModifyMountTargetSecurityGroupsResult response = client.modifyMountTargetSecurityGroups(request);PutAccountPreferencesResult putAccountPreferences(PutAccountPreferencesRequest putAccountPreferencesRequest)
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 need to use short IDs for file system and mount target resources.
putAccountPreferencesRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.PutBackupPolicyResult putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest)
Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
putBackupPolicyRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".InternalServerErrorException - 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.PutFileSystemPolicyResult putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest)
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.
putFileSystemPolicyRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.InvalidPolicyException - Returned if the FileSystemPolicy is is malformed or contains an error such as an invalid
parameter value or a missing required parameter. Returned in the case of a policy lockout safety check
error.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".PutLifecycleConfigurationResult putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest)
Enables lifecycle management 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. To enable EFS Intelligent Tiering, set
the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS. For more information,
see EFS Lifecycle
Management.
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 and turns off lifecycle management for the file
system.
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 of LifecyclePolicy objects that define when files are moved
to the IA storage class. Amazon EFS requires that each LifecyclePolicy object have only have a
single transition, so the LifecyclePolicies array needs to be structured with separate
LifecyclePolicy 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.
putLifecycleConfigurationRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AccessPointNotFoundException - Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
Services account.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.InternalServerErrorException - Returned if an error occurred on the server side.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.AccessPointNotFoundException - Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
Services account.UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Updates the throughput mode or the amount of provisioned throughput of an existing file system.
updateFileSystemRequest - BadRequestException - Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
required parameter.FileSystemNotFoundException - Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web
Services account.IncorrectFileSystemLifeCycleStateException - Returned if the file system's lifecycle state is not "available".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 to provisioned throughput mode. Try again later.InternalServerErrorException - Returned if an error occurred on the server side.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 changing the throughput mode, or decreasing the
Provisioned Throughput value.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.