com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemClient Maven / Gradle / Ivy
Show all versions of aws-java-sdk-efs Show documentation
/*
* Copyright 2010-2016 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 org.w3c.dom.*;
import java.net.*;
import java.util.*;
import java.util.Map.Entry;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.services.elasticfilesystem.model.*;
import com.amazonaws.services.elasticfilesystem.model.transform.*;
/**
* Client for accessing EFS. All service calls made using this client are
* blocking, and will not return until the service call completes.
*
* Amazon Elastic File System
*/
@ThreadSafe
public class AmazonElasticFileSystemClient extends AmazonWebServiceClient
implements AmazonElasticFileSystem {
/** Provider for AWS credentials. */
private 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 SdkJsonProtocolFactory protocolFactory = new SdkJsonProtocolFactory(
new JsonClientMetadata()
.withProtocolVersion("1.1")
.withSupportsCbor(false)
.withContentTypeOverride("")
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("FileSystemInUse")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.FileSystemInUseException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode(
"IncorrectFileSystemLifeCycleState")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.IncorrectFileSystemLifeCycleStateException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("SecurityGroupNotFound")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.SecurityGroupNotFoundException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("SubnetNotFound")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.SubnetNotFoundException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("DependencyTimeout")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.DependencyTimeoutException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("FileSystemNotFound")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode(
"UnsupportedAvailabilityZone")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.UnsupportedAvailabilityZoneException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("IpAddressInUse")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.IpAddressInUseException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("SecurityGroupLimitExceeded")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.SecurityGroupLimitExceededException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("InternalServerError")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("MountTargetConflict")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.MountTargetConflictException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("NoFreeAddressesInSubnet")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.NoFreeAddressesInSubnetException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("BadRequest")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.BadRequestException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode(
"NetworkInterfaceLimitExceeded")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.NetworkInterfaceLimitExceededException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("FileSystemAlreadyExists")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.FileSystemAlreadyExistsException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("MountTargetNotFound")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("IncorrectMountTargetState")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.IncorrectMountTargetStateException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata()
.withErrorCode("FileSystemLimitExceeded")
.withModeledClass(
com.amazonaws.services.elasticfilesystem.model.FileSystemLimitExceededException.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:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2
* metadata service
*
*
*
* All service calls made using this new client object are blocking, and
* will not return until the service call completes.
*
* @see DefaultAWSCredentialsProviderChain
*/
public AmazonElasticFileSystemClient() {
this(new DefaultAWSCredentialsProviderChain(), 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:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2
* metadata service
*
*
*
* 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
*/
public AmazonElasticFileSystemClient(ClientConfiguration clientConfiguration) {
this(new DefaultAWSCredentialsProviderChain(), 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.
*/
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.).
*/
public AmazonElasticFileSystemClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentialsProvider = new StaticCredentialsProvider(
awsCredentials);
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.
*/
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.).
*/
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
*/
public AmazonElasticFileSystemClient(
AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(clientConfiguration, requestMetricCollector);
this.awsCredentialsProvider = awsCredentialsProvider;
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"));
}
/**
*
* 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 than general purpose mode file systems,
* with a tradeoff of slightly higher latencies for most file operations.
* For more information, see Amazon EFS: Performance Modes.
*
*
* After the file system is fully created, Amazon EFS sets its lifecycle
* state to available, at which point you can create one or
* more mount targets for the file system in your VPC. For more information,
* see CreateMountTarget. You mount your Amazon EFS file system on an
* EC2 instances in your VPC via the mount target. For more information, see
*
* Amazon EFS: How it Works.
*
*
* This operation requires permissions for the
* elasticfilesystem:CreateFileSystem action.
*
*
* @param createFileSystemRequest
* @return 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 maximum number of
* file systems allowed per account.
* @sample AmazonElasticFileSystem.CreateFileSystem
*/
@Override
public CreateFileSystemResult createFileSystem(
CreateFileSystemRequest createFileSystemRequest) {
ExecutionContext executionContext = createExecutionContext(createFileSystemRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateFileSystemRequestMarshaller(protocolFactory)
.marshall(super
.beforeMarshalling(createFileSystemRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new CreateFileSystemResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Creates a mount target for a file system. You can then mount the file
* system on EC2 instances via the mount target.
*
*
* You can create one mount target in each Availability Zone in your VPC.
* All EC2 instances in a VPC within a given Availability Zone share a
* single mount target for a given file system. If you have multiple subnets
* in an Availability Zone, you create a mount target in one of the subnets.
* EC2 instances do not need to be in the same subnet as the mount target in
* order to access their file system. For more information, see Amazon
* EFS: How it Works.
*
*
* In the request, you also specify a file system ID for which you are
* creating the mount target and the file system's lifecycle state must be
* available. For more information, see
* DescribeFileSystems.
*
*
* In the request, you also provide a subnet ID, which determines the
* following:
*
*
* -
*
* VPC in which Amazon EFS creates the mount target
*
*
* -
*
* Availability Zone in which Amazon EFS creates the mount target
*
*
* -
*
* IP address range from which Amazon EFS selects the IP address of the
* mount target (if you don't specify an IP address in the request)
*
*
*
*
* After creating the mount target, Amazon EFS returns a response that
* includes, a MountTargetId and an IpAddress. You
* use this IP address when mounting the file system in an EC2 instance. You
* can also use the mount target's DNS name when mounting the file system.
* The EC2 instance on which you mount the file system via the mount target
* can resolve the mount target's DNS name to its IP address. For more
* information, see How it Works: Implementation Overview.
*
*
* Note that you can create mount targets for a file system in only one VPC,
* and there can be only one mount target per Availability Zone. That is, if
* the file system already has one or more mount targets created for it, the
* subnet specified in the request to add another mount target must meet the
* following requirements:
*
*
* -
*
* Must belong to the same VPC as the subnets of the existing mount targets
*
*
* -
*
* Must not be in the same Availability Zone as any of the subnets of the
* existing mount targets
*
*
*
*
* If the request satisfies the requirements, Amazon EFS does the following:
*
*
* -
*
* Creates a new mount target in the specified subnet.
*
*
* -
*
* Also creates a new network interface in the subnet as follows:
*
*
* -
*
* If the request provides an IpAddress, Amazon EFS assigns
* that IP address to the network interface. Otherwise, Amazon EFS assigns a
* free address in the subnet (in the same way that the Amazon EC2
* CreateNetworkInterface call does when a request does not
* specify a primary private IP address).
*
*
* -
*
* If the request provides SecurityGroups, this network
* interface is associated with those security groups. Otherwise, it belongs
* to the default security group for the subnet's VPC.
*
*
* -
*
* Assigns the description
* Mount target fsmt-id for file system fs-id
* where fsmt-id is the mount target ID, and
* fs-id is the FileSystemId.
*
*
* -
*
* Sets the requesterManaged property of the network interface
* to true, and the requesterId value to
* EFS.
*
*
*
*
* Each Amazon EFS mount target has one corresponding requestor-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 DescribeFileSystems operation, which among other
* things returns the mount target state.
*
*
*
* We recommend you create a mount target in each of the Availability Zones.
* There are cost considerations for using a file system in an Availability
* Zone through a mount target created in another Availability Zone. For
* more information, see Amazon
* EFS. In addition, by always using a mount target local to the
* instance's Availability Zone, you eliminate a partial failure scenario.
* If the Availability Zone in which your mount target is created goes down,
* then you won't be able to access your file system through that mount
* target.
*
*
* This operation requires permissions for the following action on the file
* system:
*
*
* -
*
* elasticfilesystem:CreateMountTarget
*
*
*
*
* This operation also requires permissions for the following Amazon EC2
* actions:
*
*
* -
*
* ec2:DescribeSubnets
*
*
* -
*
* ec2:DescribeNetworkInterfaces
*
*
* -
*
* ec2:CreateNetworkInterface
*
*
*
*
* @param createMountTargetRequest
* @return 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 does not
* exist in the requester's AWS account.
* @throws IncorrectFileSystemLifeCycleStateException
* Returned if the file system's life cycle state is not "created".
* @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 ENI limit for the specific
* AWS region. Client should try to delete some ENIs or get its
* account limit raised. For more information, see Amazon VPC Limits in the Amazon Virtual Private Cloud 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 does not exist
* in the subnet's VPC.
* @throws UnsupportedAvailabilityZoneException
* @sample AmazonElasticFileSystem.CreateMountTarget
*/
@Override
public CreateMountTargetResult createMountTarget(
CreateMountTargetRequest createMountTargetRequest) {
ExecutionContext executionContext = createExecutionContext(createMountTargetRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateMountTargetRequestMarshaller(
protocolFactory).marshall(super
.beforeMarshalling(createMountTargetRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new CreateMountTargetResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 does not
* exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.CreateTags
*/
@Override
public CreateTagsResult createTags(CreateTagsRequest createTagsRequest) {
ExecutionContext executionContext = createExecutionContext(createTagsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateTagsRequestMarshaller(protocolFactory)
.marshall(super.beforeMarshalling(createTagsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new CreateTagsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 does not
* exist in the requester's AWS account.
* @throws FileSystemInUseException
* Returned if a file system has mount targets.
* @sample AmazonElasticFileSystem.DeleteFileSystem
*/
@Override
public DeleteFileSystemResult deleteFileSystem(
DeleteFileSystemRequest deleteFileSystemRequest) {
ExecutionContext executionContext = createExecutionContext(deleteFileSystemRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteFileSystemRequestMarshaller(protocolFactory)
.marshall(super
.beforeMarshalling(deleteFileSystemRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DeleteFileSystemResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Deletes the specified mount target.
*
*
* This operation forcibly breaks any mounts of the file system via the
* mount target that is being deleted, which might disrupt instances or
* applications using those mounts. To avoid applications getting cut off
* abruptly, you might consider unmounting any mounts of the mount target,
* if feasible. The operation also deletes the associated network interface.
* Uncommitted writes may be lost, but breaking a mount target using this
* operation does not corrupt the file system itself. The file system you
* created remains. You can mount an EC2 instance in your VPC via another
* mount target.
*
*
* This operation requires permissions for the following action on the file
* system:
*
*
* -
*
* elasticfilesystem:DeleteMountTarget
*
*
*
*
*
* The DeleteMountTarget call returns while the mount target
* state is still deleting. You can check the mount target
* deletion by calling the DescribeMountTargets operation, which
* returns a list of mount target descriptions for the given file system.
*
*
*
* The operation also requires permissions for the following Amazon EC2
* action on the mount target's network interface:
*
*
* -
*
* ec2:DeleteNetworkInterface
*
*
*
*
* @param deleteMountTargetRequest
* @return 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
*/
@Override
public DeleteMountTargetResult deleteMountTarget(
DeleteMountTargetRequest deleteMountTargetRequest) {
ExecutionContext executionContext = createExecutionContext(deleteMountTargetRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteMountTargetRequestMarshaller(
protocolFactory).marshall(super
.beforeMarshalling(deleteMountTargetRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DeleteMountTargetResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Deletes the specified tags from a file system. If the
* DeleteTags request includes a tag key that does not exist,
* Amazon EFS ignores it and doesn't cause an error. For more information
* about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User
* Guide.
*
*
* This operation requires permissions for the
* elasticfilesystem:DeleteTags action.
*
*
* @param deleteTagsRequest
* @return 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 does not
* exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DeleteTags
*/
@Override
public DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest) {
ExecutionContext executionContext = createExecutionContext(deleteTagsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteTagsRequestMarshaller(protocolFactory)
.marshall(super.beforeMarshalling(deleteTagsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DeleteTagsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns the description of a specific Amazon EFS file system if either
* the file system CreationToken or the
* FileSystemId is provided. Otherwise, it returns descriptions
* of all file systems owned by the caller's AWS account in the AWS Region
* of the endpoint that you're calling.
*
*
* When retrieving all file system descriptions, you can optionally specify
* the MaxItems parameter to limit the number of descriptions
* in a response. If more file system descriptions remain, Amazon EFS
* returns a NextMarker, an opaque token, in the response. In
* this case, you should send a subsequent request with the
* Marker request parameter set to the value of
* NextMarker.
*
*
* To retrieve a list of your file system descriptions, this operation is
* used in an iterative process, where DescribeFileSystems is
* called first without the Marker and then the operation
* continues to call it with the Marker parameter set to the
* value of the NextMarker from the previous response until the
* response has no NextMarker.
*
*
* The implementation may return fewer than MaxItems file
* system descriptions while still including a NextMarker
* value.
*
*
* The order of file systems returned in the response of one
* DescribeFileSystems call and the order of file systems
* returned across the responses of a multi-call iteration is unspecified.
*
*
* This operation requires permissions for the
* elasticfilesystem:DescribeFileSystems action.
*
*
* @param describeFileSystemsRequest
* @return 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 does not
* exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeFileSystems
*/
@Override
public DescribeFileSystemsResult describeFileSystems(
DescribeFileSystemsRequest describeFileSystemsRequest) {
ExecutionContext executionContext = createExecutionContext(describeFileSystemsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeFileSystemsRequestMarshaller(
protocolFactory).marshall(super
.beforeMarshalling(describeFileSystemsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DescribeFileSystemsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
@Override
public DescribeFileSystemsResult describeFileSystems() {
return describeFileSystems(new DescribeFileSystemsRequest());
}
/**
*
* 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
*/
@Override
public DescribeMountTargetSecurityGroupsResult describeMountTargetSecurityGroups(
DescribeMountTargetSecurityGroupsRequest describeMountTargetSecurityGroupsRequest) {
ExecutionContext executionContext = createExecutionContext(describeMountTargetSecurityGroupsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeMountTargetSecurityGroupsRequestMarshaller(
protocolFactory)
.marshall(super
.beforeMarshalling(describeMountTargetSecurityGroupsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DescribeMountTargetSecurityGroupsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 does not
* 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.
* @sample AmazonElasticFileSystem.DescribeMountTargets
*/
@Override
public DescribeMountTargetsResult describeMountTargets(
DescribeMountTargetsRequest describeMountTargetsRequest) {
ExecutionContext executionContext = createExecutionContext(describeMountTargetsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeMountTargetsRequestMarshaller(
protocolFactory).marshall(super
.beforeMarshalling(describeMountTargetsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DescribeMountTargetsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Returns the tags associated with a file system. The order of tags
* returned in the response of one DescribeTags call and the
* order of tags returned across the responses of a multi-call iteration
* (when using pagination) is unspecified.
*
*
* This operation requires permissions for the
* elasticfilesystem:DescribeTags action.
*
*
* @param describeTagsRequest
* @return 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 does not
* exist in the requester's AWS account.
* @sample AmazonElasticFileSystem.DescribeTags
*/
@Override
public DescribeTagsResult describeTags(
DescribeTagsRequest describeTagsRequest) {
ExecutionContext executionContext = createExecutionContext(describeTagsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeTagsRequestMarshaller(protocolFactory)
.marshall(super.beforeMarshalling(describeTagsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new DescribeTagsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 does not exist
* in the subnet's VPC.
* @sample AmazonElasticFileSystem.ModifyMountTargetSecurityGroups
*/
@Override
public ModifyMountTargetSecurityGroupsResult modifyMountTargetSecurityGroups(
ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest) {
ExecutionContext executionContext = createExecutionContext(modifyMountTargetSecurityGroupsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext
.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ModifyMountTargetSecurityGroupsRequestMarshaller(
protocolFactory)
.marshall(super
.beforeMarshalling(modifyMountTargetSecurityGroupsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory
.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true)
.withHasStreamingSuccessResponse(false),
new ModifyMountTargetSecurityGroupsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* 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 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 Response invoke(
Request request,
HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
executionContext.setCredentialsProvider(CredentialUtils
.getCredentialsProvider(request.getOriginalRequest(),
awsCredentialsProvider));
return doInvoke(request, responseHandler, executionContext);
}
/**
* Invoke with no authentication. Credentials are not required and any
* credentials set on the client or request will be ignored for this
* operation.
**/
private Response anonymousInvoke(
Request request,
HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
return doInvoke(request, responseHandler, executionContext);
}
/**
* Invoke the request using the http client. Assumes credentials (or lack
* thereof) have been configured in the ExecutionContext beforehand.
**/
private Response doInvoke(
Request request,
HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
request.setEndpoint(endpoint);
request.setTimeOffset(timeOffset);
HttpResponseHandler errorResponseHandler = protocolFactory
.createErrorResponseHandler(new JsonErrorResponseMetadata());
return client.execute(request, responseHandler, errorResponseHandler,
executionContext);
}
}