com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystem Maven / Gradle / Ivy
Show all versions of aws-java-sdk-efs Show documentation
/*
* Copyright 2015-2020 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticfilesystem.model.*;
/**
* Interface for accessing EFS.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.elasticfilesystem.AbstractAmazonElasticFileSystem} 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 AmazonElasticFileSystem {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "elasticfilesystem";
/**
* Overrides the default endpoint for this client ("https://elasticfilesystem.us-east-1.amazonaws.com"). Callers can
* use this method to control which AWS region they want to work with.
*
* 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 {@link 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.
*
* @param 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 use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonElasticFileSystem#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
* {@link 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.
*
* @param region
* The region this client will communicate with. See {@link 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.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
* @param createAccessPointRequest
* @return Result of the CreateAccessPoint operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws AccessPointAlreadyExistsException
* Returned if the access point you are trying to create already exists, with the creation token you
* provided in the request.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws AccessPointLimitExceededException
* Returned if the AWS account has already created the maximum number of access points allowed per file
* system.
* @sample AmazonElasticFileSystem.CreateAccessPoint
* @see AWS API Documentation
*/
CreateAccessPointResult createAccessPoint(CreateAccessPointRequest createAccessPointRequest);
/**
*
* 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 by using the
* mount target. For more information, see Amazon EFS: How it Works.
*
*
* This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
*
*
* @param createFileSystemRequest
* @return Result of the CreateFileSystem operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemAlreadyExistsException
* Returned if the file system you are trying to create already exists, with the creation token you
* provided.
* @throws FileSystemLimitExceededException
* Returned if the AWS account has already created the maximum number of file systems allowed per account.
* @throws 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.
* @throws 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.
* @sample AmazonElasticFileSystem.CreateFileSystem
* @see AWS API Documentation
*/
CreateFileSystemResult createFileSystem(CreateFileSystemRequest createFileSystemRequest);
/**
*
* 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. 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 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
*
*
*
*
* @param createMountTargetRequest
* @return Result of the CreateMountTarget operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @throws MountTargetConflictException
* Returned if the mount target would violate one of the specified restrictions based on the file system's
* existing mount targets.
* @throws SubnetNotFoundException
* Returned if there is no subnet with ID SubnetId provided in the request.
* @throws NoFreeAddressesInSubnetException
* Returned if IpAddress was not specified in the request and there are no free IP addresses in
* the subnet.
* @throws IpAddressInUseException
* Returned if the request specified an IpAddress that is already in use in the subnet.
* @throws NetworkInterfaceLimitExceededException
* The calling account has reached the limit for elastic network interfaces for the specific AWS 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).
* @throws SecurityGroupLimitExceededException
* Returned if the size of SecurityGroups specified in the request is greater than five.
* @throws SecurityGroupNotFoundException
* Returned if one of the specified security groups doesn't exist in the subnet's VPC.
* @throws UnsupportedAvailabilityZoneException
* @sample AmazonElasticFileSystem.CreateMountTarget
* @see AWS API Documentation
*/
CreateMountTargetResult createMountTarget(CreateMountTargetRequest createMountTargetRequest);
/**
*
* 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 Result of the CreateTags operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.CreateTags
* @see AWS
* API Documentation
*/
@Deprecated
CreateTagsResult createTags(CreateTagsRequest createTagsRequest);
/**
*
* 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.
*
*
* @param deleteAccessPointRequest
* @return Result of the DeleteAccessPoint operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DeleteAccessPoint
* @see AWS API Documentation
*/
DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest);
/**
*
* 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 Result of the DeleteFileSystem operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws FileSystemInUseException
* Returned if a file system has mount targets.
* @sample AmazonElasticFileSystem.DeleteFileSystem
* @see AWS API Documentation
*/
DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest);
/**
*
* 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.
*
*
* @param deleteFileSystemPolicyRequest
* @return Result of the DeleteFileSystemPolicy operation returned by the service.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @sample AmazonElasticFileSystem.DeleteFileSystemPolicy
* @see AWS API Documentation
*/
DeleteFileSystemPolicyResult deleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest);
/**
*
* 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
*
*
*
*
* @param deleteMountTargetRequest
* @return Result of the DeleteMountTarget operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws DependencyTimeoutException
* The service timed out trying to fulfill the request, and the client should try the call again.
* @throws MountTargetNotFoundException
* Returned if there is no mount target with the specified ID found in the caller's account.
* @sample AmazonElasticFileSystem.DeleteMountTarget
* @see AWS API Documentation
*/
DeleteMountTargetResult deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest);
/**
*
* 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 AWS Billing and Cost Management User Guide.
*
*
* This operation requires permissions for the elasticfilesystem:DeleteTags action.
*
*
* @param deleteTagsRequest
* @return Result of the DeleteTags operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DeleteTags
* @see AWS
* API Documentation
*/
@Deprecated
DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest);
/**
*
* 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.
*
*
* @param describeAccessPointsRequest
* @return Result of the DescribeAccessPoints operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeAccessPoints
* @see AWS API Documentation
*/
DescribeAccessPointsResult describeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest);
/**
*
* Returns the backup policy for the specified EFS file system.
*
*
* @param describeBackupPolicyRequest
* @return Result of the DescribeBackupPolicy operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws PolicyNotFoundException
* Returned if the default file system policy is in effect for the EFS file system specified.
* @throws ValidationException
* Returned if the AWS Backup service is not available in the region that the request was made.
* @sample AmazonElasticFileSystem.DescribeBackupPolicy
* @see AWS API Documentation
*/
DescribeBackupPolicyResult describeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest);
/**
*
* Returns the FileSystemPolicy for the specified EFS file system.
*
*
* This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
*
*
* @param describeFileSystemPolicyRequest
* @return Result of the DescribeFileSystemPolicy operation returned by the service.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws PolicyNotFoundException
* Returned if the default file system policy is in effect for the EFS file system specified.
* @sample AmazonElasticFileSystem.DescribeFileSystemPolicy
* @see AWS API Documentation
*/
DescribeFileSystemPolicyResult describeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest);
/**
*
* 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. 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.
*
*
* @param describeFileSystemsRequest
* @return Result of the DescribeFileSystems operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeFileSystems
* @see AWS API Documentation
*/
DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest);
/**
* Simplified method form for invoking the DescribeFileSystems operation.
*
* @see #describeFileSystems(DescribeFileSystemsRequest)
*/
DescribeFileSystemsResult describeFileSystems();
/**
*
* 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.
*
*
* This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration
* operation.
*
*
* @param describeLifecycleConfigurationRequest
* @return Result of the DescribeLifecycleConfiguration operation returned by the service.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeLifecycleConfiguration
* @see AWS API Documentation
*/
DescribeLifecycleConfigurationResult describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest);
/**
*
* 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 Result of the DescribeMountTargetSecurityGroups operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws MountTargetNotFoundException
* Returned if there is no mount target with the specified ID found in the caller's account.
* @throws IncorrectMountTargetStateException
* Returned if the mount target is not in the correct state for the operation.
* @sample AmazonElasticFileSystem.DescribeMountTargetSecurityGroups
* @see AWS API Documentation
*/
DescribeMountTargetSecurityGroupsResult describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest);
/**
*
* 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 Result of the DescribeMountTargets operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws MountTargetNotFoundException
* Returned if there is no mount target with the specified ID found in the caller's account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeMountTargets
* @see AWS API Documentation
*/
DescribeMountTargetsResult describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest);
/**
*
* 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.
*
*
* @param describeTagsRequest
* @return Result of the DescribeTags operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeTags
* @see AWS
* API Documentation
*/
@Deprecated
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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 Result of the ModifyMountTargetSecurityGroups operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws MountTargetNotFoundException
* Returned if there is no mount target with the specified ID found in the caller's account.
* @throws IncorrectMountTargetStateException
* Returned if the mount target is not in the correct state for the operation.
* @throws SecurityGroupLimitExceededException
* Returned if the size of SecurityGroups specified in the request is greater than five.
* @throws SecurityGroupNotFoundException
* Returned if one of the specified security groups doesn't exist in the subnet's VPC.
* @sample AmazonElasticFileSystem.ModifyMountTargetSecurityGroups
* @see AWS API Documentation
*/
ModifyMountTargetSecurityGroupsResult modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest);
/**
*
* Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.
*
*
* @param putBackupPolicyRequest
* @return Result of the PutBackupPolicy operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws ValidationException
* Returned if the AWS Backup service is not available in the region that the request was made.
* @sample AmazonElasticFileSystem.PutBackupPolicy
* @see AWS API Documentation
*/
PutBackupPolicyResult putBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest);
/**
*
* 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.
* 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.
*
*
* This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
*
*
* @param putFileSystemPolicyRequest
* @return Result of the PutFileSystemPolicy operation returned by the service.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws 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.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @sample AmazonElasticFileSystem.PutFileSystemPolicy
* @see AWS API Documentation
*/
PutFileSystemPolicyResult putFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest);
/**
*
* 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. A LifecycleConfiguration
* applies to all files in a file system.
*
*
* 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 disables lifecycle management.
*
*
* 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. The array can contain only one LifecyclePolicy item.
*
*
*
*
* This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.
*
*
* To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key
* Management Service (AWS KMS) permissions as when you created the encrypted file system.
*
*
* @param putLifecycleConfigurationRequest
* @return Result of the PutLifecycleConfiguration operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @sample AmazonElasticFileSystem.PutLifecycleConfiguration
* @see AWS API Documentation
*/
PutLifecycleConfigurationResult putLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the throughput mode or the amount of provisioned throughput of an existing file system.
*
*
* @param updateFileSystemRequest
* @return Result of the UpdateFileSystem operation returned by the service.
* @throws BadRequestException
* Returned if the request is malformed or contains an error such as an invalid parameter value or a missing
* required parameter.
* @throws FileSystemNotFoundException
* Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @throws 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.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws 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.
* @throws TooManyRequestsException
* Returned if you don’t wait at least 24 hours before changing the throughput mode, or decreasing the
* Provisioned Throughput value.
* @sample AmazonElasticFileSystem.UpdateFileSystem
* @see AWS API Documentation
*/
UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}