com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemAsync Maven / Gradle / Ivy
/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticfilesystem;
import javax.annotation.Generated;
import com.amazonaws.services.elasticfilesystem.model.*;
/**
* Interface for accessing EFS asynchronously. Each asynchronous method will return a Java Future object representing
* the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive notification when
* an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.elasticfilesystem.AbstractAmazonElasticFileSystemAsync} instead.
*
*
* Amazon Elastic File System
*
* Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in
* the AWS 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 User Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonElasticFileSystemAsync extends AmazonElasticFileSystem {
/**
*
* 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:
*
*
* -
*
* 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.
*
*
*
* 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 also takes 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.
*
*
* 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 via the mount
* target. For more information, see Amazon
* EFS: How it Works.
*
*
* This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
*
*
* @param createFileSystemRequest
* @return A Java Future containing the result of the CreateFileSystem operation returned by the service.
* @sample AmazonElasticFileSystemAsync.CreateFileSystem
* @see AWS API Documentation
*/
java.util.concurrent.Future createFileSystemAsync(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 AWS 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.
*
*
*
* 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 also takes 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.
*
*
* 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 via the mount
* target. For more information, see Amazon
* EFS: How it Works.
*
*
* This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
*
*
* @param createFileSystemRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateFileSystem operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.CreateFileSystem
* @see AWS API Documentation
*/
java.util.concurrent.Future createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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. For more information, see DescribeFileSystems.
*
*
* In the request, you also provide a subnet ID, which determines the following:
*
*
* -
*
* VPC in which Amazon EFS creates the mount target
*
*
* -
*
* Availability Zone in which Amazon EFS creates the mount target
*
*
* -
*
* 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 via 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 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 won't be able to 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
*
*
*
*
* @param createMountTargetRequest
* @return A Java Future containing the result of the CreateMountTarget operation returned by the service.
* @sample AmazonElasticFileSystemAsync.CreateMountTarget
* @see AWS API Documentation
*/
java.util.concurrent.Future createMountTargetAsync(CreateMountTargetRequest createMountTargetRequest);
/**
*
* 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. For more information, see DescribeFileSystems.
*
*
* In the request, you also provide a subnet ID, which determines the following:
*
*
* -
*
* VPC in which Amazon EFS creates the mount target
*
*
* -
*
* Availability Zone in which Amazon EFS creates the mount target
*
*
* -
*
* 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 via 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 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 won't be able to 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
*
*
*
*
* @param createMountTargetRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateMountTarget operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.CreateMountTarget
* @see AWS API Documentation
*/
java.util.concurrent.Future createMountTargetAsync(CreateMountTargetRequest createMountTargetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createTagsRequest
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* @sample AmazonElasticFileSystemAsync.CreateTags
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createTagsAsync(CreateTagsRequest createTagsRequest);
/**
*
* 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.
*
*
* @param createTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.CreateTags
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createTagsAsync(CreateTagsRequest createTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteFileSystemRequest
* @return A Java Future containing the result of the DeleteFileSystem operation returned by the service.
* @sample AmazonElasticFileSystemAsync.DeleteFileSystem
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteFileSystemAsync(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.
*
*
* @param deleteFileSystemRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteFileSystem operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.DeleteFileSystem
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified mount target.
*
*
* This operation forcibly breaks any mounts of the file system via 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 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
* via 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
*
*
*
*
* @param deleteMountTargetRequest
* @return A Java Future containing the result of the DeleteMountTarget operation returned by the service.
* @sample AmazonElasticFileSystemAsync.DeleteMountTarget
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteMountTargetAsync(DeleteMountTargetRequest deleteMountTargetRequest);
/**
*
* Deletes the specified mount target.
*
*
* This operation forcibly breaks any mounts of the file system via 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 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
* via 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
*
*
*
*
* @param deleteMountTargetRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteMountTarget operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.DeleteMountTarget
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteMountTargetAsync(DeleteMountTargetRequest deleteMountTargetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that
* does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related
* restrictions, see Tag
* Restrictions in the AWS Billing and Cost Management User Guide.
*
*
* This operation requires permissions for the elasticfilesystem:DeleteTags action.
*
*
* @param deleteTagsRequest
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* @sample AmazonElasticFileSystemAsync.DeleteTags
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteTagsAsync(DeleteTagsRequest deleteTagsRequest);
/**
*
* Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that
* does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related
* restrictions, see Tag
* Restrictions in the AWS Billing and Cost Management User Guide.
*
*
* This operation requires permissions for the elasticfilesystem:DeleteTags action.
*
*
* @param deleteTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.DeleteTags
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteTagsAsync(DeleteTagsRequest deleteTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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 AWS account in the AWS 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. 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 implementation may return fewer than MaxItems file system descriptions while still including a
* NextMarker value.
*
*
* 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.
*
*
* @param describeFileSystemsRequest
* @return A Java Future containing the result of the DescribeFileSystems operation returned by the service.
* @sample AmazonElasticFileSystemAsync.DescribeFileSystems
* @see AWS API Documentation
*/
java.util.concurrent.Future describeFileSystemsAsync(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 AWS account in the AWS 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. 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 implementation may return fewer than MaxItems file system descriptions while still including a
* NextMarker value.
*
*
* 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.
*
*
* @param describeFileSystemsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeFileSystems operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.DescribeFileSystems
* @see AWS API Documentation
*/
java.util.concurrent.Future describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DescribeFileSystems operation.
*
* @see #describeFileSystemsAsync(DescribeFileSystemsRequest)
*/
java.util.concurrent.Future describeFileSystemsAsync();
/**
* Simplified method form for invoking the DescribeFileSystems operation with an AsyncHandler.
*
* @see #describeFileSystemsAsync(DescribeFileSystemsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future describeFileSystemsAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
*
* @param describeMountTargetSecurityGroupsRequest
* @return A Java Future containing the result of the DescribeMountTargetSecurityGroups operation returned by the
* service.
* @sample AmazonElasticFileSystemAsync.DescribeMountTargetSecurityGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future describeMountTargetSecurityGroupsAsync(
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.
*
*
*
*
* @param describeMountTargetSecurityGroupsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeMountTargetSecurityGroups operation returned by the
* service.
* @sample AmazonElasticFileSystemAsyncHandler.DescribeMountTargetSecurityGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future describeMountTargetSecurityGroupsAsync(
DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeMountTargetsRequest
* @return A Java Future containing the result of the DescribeMountTargets operation returned by the service.
* @sample AmazonElasticFileSystemAsync.DescribeMountTargets
* @see AWS API Documentation
*/
java.util.concurrent.Future describeMountTargetsAsync(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.
*
*
* @param describeMountTargetsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeMountTargets operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.DescribeMountTargets
* @see AWS API Documentation
*/
java.util.concurrent.Future describeMountTargetsAsync(DescribeMountTargetsRequest describeMountTargetsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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 permissions for the elasticfilesystem:DescribeTags action.
*
*
* @param describeTagsRequest
* @return A Java Future containing the result of the DescribeTags operation returned by the service.
* @sample AmazonElasticFileSystemAsync.DescribeTags
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeTagsAsync(DescribeTagsRequest describeTagsRequest);
/**
*
* 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 permissions for the elasticfilesystem:DescribeTags action.
*
*
* @param describeTagsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeTags operation returned by the service.
* @sample AmazonElasticFileSystemAsyncHandler.DescribeTags
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeTagsAsync(DescribeTagsRequest describeTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
*
* @param modifyMountTargetSecurityGroupsRequest
* @return A Java Future containing the result of the ModifyMountTargetSecurityGroups operation returned by the
* service.
* @sample AmazonElasticFileSystemAsync.ModifyMountTargetSecurityGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyMountTargetSecurityGroupsAsync(
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.
*
*
*
*
* @param modifyMountTargetSecurityGroupsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ModifyMountTargetSecurityGroups operation returned by the
* service.
* @sample AmazonElasticFileSystemAsyncHandler.ModifyMountTargetSecurityGroups
* @see AWS API Documentation
*/
java.util.concurrent.Future modifyMountTargetSecurityGroupsAsync(
ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}