*
* 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 that 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonElasticFileSystemClient extends AmazonWebServiceClient implements AmazonElasticFileSystem { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonElasticFileSystem.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "elasticfilesystem"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("IpAddressInUse").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.IpAddressInUseExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("FileSystemInUse").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.FileSystemInUseExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("FileSystemAlreadyExists").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.FileSystemAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessPointAlreadyExists").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.AccessPointAlreadyExistsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("IncorrectFileSystemLifeCycleState").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.IncorrectFileSystemLifeCycleStateExceptionUnmarshaller .getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessPointLimitExceeded").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.AccessPointLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("NoFreeAddressesInSubnet").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.NoFreeAddressesInSubnetExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("FileSystemNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.FileSystemNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InsufficientThroughputCapacity").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.InsufficientThroughputCapacityExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("SecurityGroupLimitExceeded").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.SecurityGroupLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("PolicyNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.PolicyNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("FileSystemLimitExceeded").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.FileSystemLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("UnsupportedAvailabilityZone").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.UnsupportedAvailabilityZoneExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessPointNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.AccessPointNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MountTargetConflict").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.MountTargetConflictExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidPolicyException").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.InvalidPolicyExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("SecurityGroupNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.SecurityGroupNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("NetworkInterfaceLimitExceeded").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.NetworkInterfaceLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ReplicationNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.ReplicationNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("MountTargetNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.MountTargetNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("SubnetNotFound").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.SubnetNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("IncorrectMountTargetState").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.IncorrectMountTargetStateExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThroughputLimitExceeded").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.ThroughputLimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("DependencyTimeout").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.DependencyTimeoutExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AvailabilityZonesMismatch").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.AvailabilityZonesMismatchExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("TooManyRequests").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.TooManyRequestsExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("BadRequest").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.BadRequestExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerError").withExceptionUnmarshaller( com.amazonaws.services.elasticfilesystem.model.transform.InternalServerErrorExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.elasticfilesystem.model.AmazonElasticFileSystemException.class)); /** * Constructs a new client to invoke service methods on EFS. A credentials provider chain will be used that searches * for credentials in this order: ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AmazonElasticFileSystemClientBuilder#defaultClient()} */ @Deprecated public AmazonElasticFileSystemClient() { this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on EFS. A credentials provider chain will be used that searches * for credentials in this order: *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientConfiguration * The client configuration options controlling how this client connects to EFS (ex: proxy settings, retry * counts, etc.). * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AmazonElasticFileSystemClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AmazonElasticFileSystemClient(ClientConfiguration clientConfiguration) { this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration); } /** * Constructs a new client to invoke service methods on EFS using the specified AWS account credentials. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @deprecated use {@link AmazonElasticFileSystemClientBuilder#withCredentials(AWSCredentialsProvider)} for example: * {@code AmazonElasticFileSystemClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();} */ @Deprecated public AmazonElasticFileSystemClient(AWSCredentials awsCredentials) { this(awsCredentials, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on EFS using the specified AWS account credentials and client * configuration options. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to EFS (ex: proxy settings, retry * counts, etc.). * @deprecated use {@link AmazonElasticFileSystemClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AmazonElasticFileSystemClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AmazonElasticFileSystemClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { super(clientConfiguration); this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials); this.advancedConfig = AdvancedConfig.EMPTY; init(); } /** * Constructs a new client to invoke service methods on EFS using the specified AWS account credentials provider. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @deprecated use {@link AmazonElasticFileSystemClientBuilder#withCredentials(AWSCredentialsProvider)} */ @Deprecated public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on EFS using the specified AWS account credentials provider and * client configuration options. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to EFS (ex: proxy settings, retry * counts, etc.). * @deprecated use {@link AmazonElasticFileSystemClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AmazonElasticFileSystemClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, null); } /** * Constructs a new client to invoke service methods on EFS using the specified AWS account credentials provider, * client configuration options, and request metric collector. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to EFS (ex: proxy settings, retry * counts, etc.). * @param requestMetricCollector * optional request metric collector * @deprecated use {@link AmazonElasticFileSystemClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AmazonElasticFileSystemClientBuilder#withClientConfiguration(ClientConfiguration)} and * {@link AmazonElasticFileSystemClientBuilder#withMetricsCollector(RequestMetricCollector)} */ @Deprecated public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(clientConfiguration, requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; this.advancedConfig = AdvancedConfig.EMPTY; init(); } public static AmazonElasticFileSystemClientBuilder builder() { return AmazonElasticFileSystemClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on EFS using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonElasticFileSystemClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on EFS using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonElasticFileSystemClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("https://elasticfilesystem.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/elasticfilesystem/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/elasticfilesystem/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies * an operating system user and group, and a file system path, to any file system request made through the access * point. The operating system user and group override any identity information provided by the NFS client. The file * system path is exposed as the access point's root directory. Applications using the access point can only access * data in the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access * points. *
** If multiple requests to create access points on the same file system are sent in quick succession, and the file * system is near the limit of 1,000 access points, you may experience a throttling response for these requests. * This is to ensure that the file system does not exceed the stated access point limit. *
*
* This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
*
* Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional
* authorization on the elasticfilesystem:TagResource action to verify if users have permissions to
* create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource
* action. For more information, see Granting
* permissions to tag resources during creation.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws AccessPointLimitExceededException
* Returned if the Amazon Web Services account has already created the maximum number of access points
* allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
* @throws ThrottlingException
* Returned when the CreateAccessPoint API action is called too quickly and the number of
* Access Points on the file system is nearing the limit
* of 120.
* @sample AmazonElasticFileSystem.CreateAccessPoint
* @see AWS API Documentation
*/
@Override
public CreateAccessPointResult createAccessPoint(CreateAccessPointRequest request) {
request = beforeClientExecution(request);
return executeCreateAccessPoint(request);
}
@SdkInternalApi
final CreateAccessPointResult executeCreateAccessPoint(CreateAccessPointRequest createAccessPointRequest) {
ExecutionContext executionContext = createExecutionContext(createAccessPointRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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.
*
* File systems can be tagged on creation. If tags are specified in the creation action, IAM performs additional
* authorization on the elasticfilesystem:TagResource action to verify if users have permissions to
* create tags. Therefore, you must grant explicit permissions to use the elasticfilesystem:TagResource
* action. For more information, see Granting
* permissions to tag resources during creation.
*
* 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
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services 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 Amazon Web
* Services Region. Either delete some network interfaces or request that the account quota be raised. For
* more information, see Amazon VPC
* Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the
* Network interfaces table).
* @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 virtual private cloud
* (VPC).
* @throws UnsupportedAvailabilityZoneException
* Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
* @throws AvailabilityZonesMismatchException
* Returned if the Availability Zone that was specified for a mount target is different from the
* Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone
* storage redundancy.
* @sample AmazonElasticFileSystem.CreateMountTarget
* @see AWS API Documentation
*/
@Override
public CreateMountTargetResult createMountTarget(CreateMountTargetRequest request) {
request = beforeClientExecution(request);
return executeCreateMountTarget(request);
}
@SdkInternalApi
final CreateMountTargetResult executeCreateMountTarget(CreateMountTargetRequest createMountTargetRequest) {
ExecutionContext executionContext = createExecutionContext(createMountTargetRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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 in the Amazon EFS User Guide. 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. The destination file system configuration consists of the following properties: *
** Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is * created. Amazon EFS replication is available in all Amazon Web Services Regions that Amazon EFS is available in, * except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe (Milan), and Middle East * (Bahrain). *
** Availability Zone - If you want the destination file system to use EFS 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 * Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS * key, your service-managed KMS key for Amazon EFS is used. *
** After the file system is created, you cannot change the KMS key. *
** The following properties are set by default: *
** Performance mode - The destination file system's performance mode matches that of the source file system, * unless the destination file system uses EFS 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's throughput mode matches that of the source file system. * After the file system is created, you can modify the throughput mode. *
** The following properties are turned off by default: *
** Lifecycle management - EFS lifecycle management and EFS Intelligent-Tiering are not enabled on the * destination file system. After the destination file system is created, you can enable EFS lifecycle management * and EFS Intelligent-Tiering. *
** Automatic backups - Automatic daily backups not enabled on the destination file system. After the file * system is created, you can change this setting. *
** For more information, see Amazon EFS * replication in the Amazon EFS User Guide. *
* * @param createReplicationConfigurationRequest * @return Result of the CreateReplicationConfiguration 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 IncorrectFileSystemLifeCycleStateException * Returned if the file system's lifecycle state is not "available". * @throws ValidationException * Returned if the Backup service is not available in the Amazon Web Services Region in which the request * was made. * @throws ReplicationNotFoundException * Returned if the specified file system does not have a replication configuration. * @throws FileSystemNotFoundException * Returned if the specifiedFileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws UnsupportedAvailabilityZoneException
* Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
* @throws FileSystemLimitExceededException
* Returned if the Amazon Web Services 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 Throughput to Provisioned Throughput mode. Try again later.
* @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 InternalServerErrorException
* Returned if an error occurred on the server side.
* @sample AmazonElasticFileSystem.CreateReplicationConfiguration
* @see AWS API Documentation
*/
@Override
public CreateReplicationConfigurationResult createReplicationConfiguration(CreateReplicationConfigurationRequest request) {
request = beforeClientExecution(request);
return executeCreateReplicationConfiguration(request);
}
@SdkInternalApi
final CreateReplicationConfigurationResult executeCreateReplicationConfiguration(CreateReplicationConfigurationRequest createReplicationConfigurationRequest) {
ExecutionContext executionContext = createExecutionContext(createReplicationConfigurationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* DEPRECATED - CreateTags is deprecated and not maintained. To create tags for EFS resources, use the
* API action.
*
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.CreateTags
* @see AWS
* API Documentation
*/
@Override
@Deprecated
public CreateTagsResult createTags(CreateTagsRequest request) {
request = beforeClientExecution(request);
return executeCreateTags(request);
}
@SdkInternalApi
final CreateTagsResult executeCreateTags(CreateTagsRequest createTagsRequest) {
ExecutionContext executionContext = createExecutionContext(createTagsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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.
*
AccessPointId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DeleteAccessPoint
* @see AWS API Documentation
*/
@Override
public DeleteAccessPointResult deleteAccessPoint(DeleteAccessPointRequest request) {
request = beforeClientExecution(request);
return executeDeleteAccessPoint(request);
}
@SdkInternalApi
final DeleteAccessPointResult executeDeleteAccessPoint(DeleteAccessPointRequest deleteAccessPointRequest) {
ExecutionContext executionContext = createExecutionContext(deleteAccessPointRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists * and you can't access any contents of the deleted file system. *
** You need to manually delete mount targets attached to a file system before you can delete an EFS file system. * This step is performed for you when you use the Amazon Web Services console to delete a file system. *
** You cannot delete a file system that is part of an EFS Replication configuration. You need to delete the * replication configuration first. *
** You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first * delete them. For more information, see DescribeMountTargets and DeleteMountTarget. *
*
* The 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws FileSystemInUseException
* Returned if a file system has mount targets.
* @sample AmazonElasticFileSystem.DeleteFileSystem
* @see AWS API Documentation
*/
@Override
public DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest request) {
request = beforeClientExecution(request);
return executeDeleteFileSystem(request);
}
@SdkInternalApi
final DeleteFileSystemResult executeDeleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest) {
ExecutionContext executionContext = createExecutionContext(deleteFileSystemRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @sample AmazonElasticFileSystem.DeleteFileSystemPolicy
* @see AWS API Documentation
*/
@Override
public DeleteFileSystemPolicyResult deleteFileSystemPolicy(DeleteFileSystemPolicyRequest request) {
request = beforeClientExecution(request);
return executeDeleteFileSystemPolicy(request);
}
@SdkInternalApi
final DeleteFileSystemPolicyResult executeDeleteFileSystemPolicy(DeleteFileSystemPolicyRequest deleteFileSystemPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(deleteFileSystemPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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
*
* 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. After a replication configuration is deleted, the destination file
* system is no longer read-only. You can write to the destination file system after its status becomes
* Writeable.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws ReplicationNotFoundException
* Returned if the specified file system does not have a replication configuration.
* @sample AmazonElasticFileSystem.DeleteReplicationConfiguration
* @see AWS API Documentation
*/
@Override
public DeleteReplicationConfigurationResult deleteReplicationConfiguration(DeleteReplicationConfigurationRequest request) {
request = beforeClientExecution(request);
return executeDeleteReplicationConfiguration(request);
}
@SdkInternalApi
final DeleteReplicationConfigurationResult executeDeleteReplicationConfiguration(DeleteReplicationConfigurationRequest deleteReplicationConfigurationRequest) {
ExecutionContext executionContext = createExecutionContext(deleteReplicationConfigurationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from EFS resources, use the
* API action.
*
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DeleteTags
* @see AWS
* API Documentation
*/
@Override
@Deprecated
public DeleteTagsResult deleteTags(DeleteTagsRequest request) {
request = beforeClientExecution(request);
return executeDeleteTags(request);
}
@SdkInternalApi
final DeleteTagsResult executeDeleteTags(DeleteTagsRequest deleteTagsRequest) {
ExecutionContext executionContext = createExecutionContext(deleteTagsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DescribeAccessPoints
* @see AWS API Documentation
*/
@Override
public DescribeAccessPointsResult describeAccessPoints(DescribeAccessPointsRequest request) {
request = beforeClientExecution(request);
return executeDescribeAccessPoints(request);
}
@SdkInternalApi
final DescribeAccessPointsResult executeDescribeAccessPoints(DescribeAccessPointsRequest describeAccessPointsRequest) {
ExecutionContext executionContext = createExecutionContext(describeAccessPointsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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. *
* * @param describeAccountPreferencesRequest * @return Result of the DescribeAccountPreferences operation returned by the service. * @throws InternalServerErrorException * Returned if an error occurred on the server side. * @sample AmazonElasticFileSystem.DescribeAccountPreferences * @see AWS API Documentation */ @Override public DescribeAccountPreferencesResult describeAccountPreferences(DescribeAccountPreferencesRequest request) { request = beforeClientExecution(request); return executeDescribeAccountPreferences(request); } @SdkInternalApi final DescribeAccountPreferencesResult executeDescribeAccountPreferences(DescribeAccountPreferencesRequest describeAccountPreferencesRequest) { ExecutionContext executionContext = createExecutionContext(describeAccountPreferencesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 specifiedFileSystemId value doesn't exist in the requester's Amazon Web
* Services 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 Backup service is not available in the Amazon Web Services Region in which the request
* was made.
* @sample AmazonElasticFileSystem.DescribeBackupPolicy
* @see AWS API Documentation
*/
@Override
public DescribeBackupPolicyResult describeBackupPolicy(DescribeBackupPolicyRequest request) {
request = beforeClientExecution(request);
return executeDescribeBackupPolicy(request);
}
@SdkInternalApi
final DescribeBackupPolicyResult executeDescribeBackupPolicy(DescribeBackupPolicyRequest describeBackupPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(describeBackupPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Returns the FileSystemPolicy for the specified EFS file system.
*
* This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services 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
*/
@Override
public DescribeFileSystemPolicyResult describeFileSystemPolicy(DescribeFileSystemPolicyRequest request) {
request = beforeClientExecution(request);
return executeDescribeFileSystemPolicy(request);
}
@SdkInternalApi
final DescribeFileSystemPolicyResult executeDescribeFileSystemPolicy(DescribeFileSystemPolicyRequest describeFileSystemPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(describeFileSystemPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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. This number is automatically set to 100. 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DescribeFileSystems
* @see AWS API Documentation
*/
@Override
public DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest request) {
request = beforeClientExecution(request);
return executeDescribeFileSystems(request);
}
@SdkInternalApi
final DescribeFileSystemsResult executeDescribeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest) {
ExecutionContext executionContext = createExecutionContext(describeFileSystemsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DescribeLifecycleConfiguration
* @see AWS API Documentation
*/
@Override
public DescribeLifecycleConfigurationResult describeLifecycleConfiguration(DescribeLifecycleConfigurationRequest request) {
request = beforeClientExecution(request);
return executeDescribeLifecycleConfiguration(request);
}
@SdkInternalApi
final DescribeLifecycleConfigurationResult executeDescribeLifecycleConfiguration(DescribeLifecycleConfigurationRequest describeLifecycleConfigurationRequest) {
ExecutionContext executionContext = createExecutionContext(describeLifecycleConfigurationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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.
*
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws MountTargetNotFoundException
* Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services
* account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DescribeMountTargets
* @see AWS API Documentation
*/
@Override
public DescribeMountTargetsResult describeMountTargets(DescribeMountTargetsRequest request) {
request = beforeClientExecution(request);
return executeDescribeMountTargets(request);
}
@SdkInternalApi
final DescribeMountTargetsResult executeDescribeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest) {
ExecutionContext executionContext = createExecutionContext(describeMountTargetsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the * replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved. *
* * @param describeReplicationConfigurationsRequest * @return Result of the DescribeReplicationConfigurations 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 specifiedFileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws InternalServerErrorException
* Returned if an error occurred on the server side.
* @throws ReplicationNotFoundException
* Returned if the specified file system does not have a replication configuration.
* @throws ValidationException
* Returned if the Backup service is not available in the Amazon Web Services Region in which the request
* was made.
* @sample AmazonElasticFileSystem.DescribeReplicationConfigurations
* @see AWS API Documentation
*/
@Override
public DescribeReplicationConfigurationsResult describeReplicationConfigurations(DescribeReplicationConfigurationsRequest request) {
request = beforeClientExecution(request);
return executeDescribeReplicationConfigurations(request);
}
@SdkInternalApi
final DescribeReplicationConfigurationsResult executeDescribeReplicationConfigurations(
DescribeReplicationConfigurationsRequest describeReplicationConfigurationsRequest) {
ExecutionContext executionContext = createExecutionContext(describeReplicationConfigurationsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with
* EFS resources, use the ListTagsForResource API action.
*
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.DescribeTags
* @see AWS
* API Documentation
*/
@Override
@Deprecated
public DescribeTagsResult describeTags(DescribeTagsRequest request) {
request = beforeClientExecution(request);
return executeDescribeTags(request);
}
@SdkInternalApi
final DescribeTagsResult executeDescribeTags(DescribeTagsRequest describeTagsRequest) {
ExecutionContext executionContext = createExecutionContext(describeTagsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.ListTagsForResource
* @see AWS API Documentation
*/
@Override
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) {
request = beforeClientExecution(request);
return executeListTagsForResource(request);
}
@SdkInternalApi
final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) {
ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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.
*
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 virtual private cloud
* (VPC).
* @sample AmazonElasticFileSystem.ModifyMountTargetSecurityGroups
* @see AWS API Documentation
*/
@Override
public ModifyMountTargetSecurityGroupsResult modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request) {
request = beforeClientExecution(request);
return executeModifyMountTargetSecurityGroups(request);
}
@SdkInternalApi
final ModifyMountTargetSecurityGroupsResult executeModifyMountTargetSecurityGroups(
ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest) {
ExecutionContext executionContext = createExecutionContext(modifyMountTargetSecurityGroupsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 * character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. * All existing resource IDs are not affected by any changes you make. You can set the ID preference during the * opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource * IDs. *
** Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 * character format resource ID. Contact Amazon Web Services support if you receive an error and must use short IDs * for file system and mount target resources. *
** 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 specifiedFileSystemId value doesn't exist in the requester's Amazon Web
* Services 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 Backup service is not available in the Amazon Web Services Region in which the request
* was made.
* @sample AmazonElasticFileSystem.PutBackupPolicy
* @see AWS API Documentation
*/
@Override
public PutBackupPolicyResult putBackupPolicy(PutBackupPolicyRequest request) {
request = beforeClientExecution(request);
return executePutBackupPolicy(request);
}
@SdkInternalApi
final PutBackupPolicyResult executePutBackupPolicy(PutBackupPolicyRequest putBackupPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(putBackupPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws InvalidPolicyException
* Returned if the FileSystemPolicy is malformed or contains an error such as a parameter value
* that is not valid 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
*/
@Override
public PutFileSystemPolicyResult putFileSystemPolicy(PutFileSystemPolicyRequest request) {
request = beforeClientExecution(request);
return executePutFileSystemPolicy(request);
}
@SdkInternalApi
final PutFileSystemPolicyResult executePutFileSystemPolicy(PutFileSystemPolicyRequest putFileSystemPolicyRequest) {
ExecutionContext executionContext = createExecutionContext(putFileSystemPolicyRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request
* Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A
* LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the
* following:
*
* EFS Lifecycle management - When Amazon EFS automatically transitions files in a file system into the * lower-cost EFS Infrequent Access (IA) storage class. *
*
* To enable EFS Lifecycle management, set the value of TransitionToIA to one of the available options.
*
* EFS Intelligent-Tiering - When Amazon EFS automatically transitions files from IA back into the file * system's primary storage class (EFS Standard or EFS One Zone Standard). *
*
* 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 and EFS
* Intelligent-Tiering 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 and EFS * Intelligent-Tiering. *
*
* A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved
* into IA storage, and when they are moved back to Standard storage.
*
* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's lifecycle state is not "available".
* @sample AmazonElasticFileSystem.PutLifecycleConfiguration
* @see AWS API Documentation
*/
@Override
public PutLifecycleConfigurationResult putLifecycleConfiguration(PutLifecycleConfigurationRequest request) {
request = beforeClientExecution(request);
return executePutLifecycleConfiguration(request);
}
@SdkInternalApi
final PutLifecycleConfigurationResult executePutLifecycleConfiguration(PutLifecycleConfigurationRequest putLifecycleConfigurationRequest) {
ExecutionContext executionContext = createExecutionContext(putLifecycleConfigurationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.TagResource
* @see AWS
* API Documentation
*/
@Override
public TagResourceResult tagResource(TagResourceRequest request) {
request = beforeClientExecution(request);
return executeTagResource(request);
}
@SdkInternalApi
final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) {
ExecutionContext executionContext = createExecutionContext(tagResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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.
*
FileSystemId value doesn't exist in the requester's Amazon Web
* Services account.
* @throws AccessPointNotFoundException
* Returned if the specified AccessPointId value doesn't exist in the requester's Amazon Web
* Services account.
* @sample AmazonElasticFileSystem.UntagResource
* @see AWS API Documentation
*/
@Override
public UntagResourceResult untagResource(UntagResourceRequest request) {
request = beforeClientExecution(request);
return executeUntagResource(request);
}
@SdkInternalApi
final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) {
ExecutionContext executionContext = createExecutionContext(untagResourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request* 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 specifiedFileSystemId value doesn't exist in the requester's Amazon Web
* Services 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 Throughput to Provisioned Throughput mode. Try again later.
* @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 either changing the throughput mode, or decreasing
* the Provisioned Throughput value.
* @sample AmazonElasticFileSystem.UpdateFileSystem
* @see AWS API Documentation
*/
@Override
public UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest request) {
request = beforeClientExecution(request);
return executeUpdateFileSystem(request);
}
@SdkInternalApi
final UpdateFileSystemResult executeUpdateFileSystem(UpdateFileSystemRequest updateFileSystemRequest) {
ExecutionContext executionContext = createExecutionContext(updateFileSystemRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
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 the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private