Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 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 java.net.*;
  import java.util.*;
  
  
  import com.amazonaws.*;
  
Client for accessing AmazonElasticFileSystem. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Elastic File System

  
  public class AmazonElasticFileSystemClient extends AmazonWebServiceClient implements AmazonElasticFileSystem {

    
Provider for AWS credentials.
  
  
      private static final Log log = LogFactory.getLog(AmazonElasticFileSystem.class);

    
List of exception unmarshallers for all AmazonElasticFileSystem exceptions.
  
      protected List<JsonErrorUnmarshallerjsonErrorUnmarshallers;

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem. 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.

  
      public AmazonElasticFileSystemClient() {
          this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
      }

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem. 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.

Parameters:
clientConfiguration The client configuration options controlling how this client connects to AmazonElasticFileSystem (ex: proxy settings, retry counts, etc.).
See also:
com.amazonaws.auth.DefaultAWSCredentialsProviderChain
  
      public AmazonElasticFileSystemClient(ClientConfiguration clientConfiguration) {
          this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
      }

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem 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.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
 
     public AmazonElasticFileSystemClient(AWSCredentials awsCredentials) {
         this(awsCredentialsnew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem 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.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonElasticFileSystem (ex: proxy settings, retry counts, etc.).
 
     public AmazonElasticFileSystemClient(AWSCredentials awsCredentialsClientConfiguration clientConfiguration) {
         super(adjustClientConfiguration(clientConfiguration));
         
         this. = new StaticCredentialsProvider(awsCredentials);
         
         init();
     }

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem 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.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
 
     public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider) {
         this(awsCredentialsProvidernew ClientConfiguration());
     }

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem 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.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonElasticFileSystem (ex: proxy settings, retry counts, etc.).
 
     public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProviderClientConfiguration clientConfiguration) {
         this(awsCredentialsProviderclientConfigurationnull);
     }

    
Constructs a new client to invoke service methods on AmazonElasticFileSystem 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.

Parameters:
awsCredentialsProvider The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonElasticFileSystem (ex: proxy settings, retry counts, etc.).
requestMetricCollector optional request metric collector
 
     public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider,
             ClientConfiguration clientConfiguration,
             RequestMetricCollector requestMetricCollector) {
         super(adjustClientConfiguration(clientConfiguration), requestMetricCollector);
         
         this. = awsCredentialsProvider;
         
         init();
     }
 
     private void init() {
         
         
         // calling this.setEndPoint(...) will also modify the signer accordingly
         this.setEndpoint("elasticfilesystem.us-east-1.amazonaws.com");
         
         HandlerChainFactory chainFactory = new HandlerChainFactory();
         .addAll(chainFactory.newRequestHandlerChain(
                 "/com/amazonaws/services/elasticfilesystem/request.handlers"));
         .addAll(chainFactory.newRequestHandler2Chain(
                 "/com/amazonaws/services/elasticfilesystem/request.handler2s"));
     }
 
         ClientConfiguration config = orig;
         
         return config;
     }

    

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.

NOTE: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.

NOTE: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 API, which among other things returns the file system state.

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 (CreateMountTarget) in your VPC. 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 permission for the elasticfilesystem:CreateFileSystem action.

Parameters:
createFileSystemRequest Container for the necessary parameters to execute the CreateFileSystem service method on AmazonElasticFileSystem.
Returns:
The response from the CreateFileSystem service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.FileSystemAlreadyExistsException
com.amazonaws.services.elasticfilesystem.model.FileSystemLimitExceededException
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public CreateFileSystemResult createFileSystem(CreateFileSystemRequest createFileSystemRequest) {
         ExecutionContext executionContext = createExecutionContext(createFileSystemRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateFileSystemRequestrequest = null;
         Response<CreateFileSystemResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateFileSystemRequestMarshaller().marshall(super.beforeMarshalling(createFileSystemRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<CreateFileSystemResultJsonUnmarshallerContextunmarshaller =
                 new CreateFileSystemResultJsonUnmarshaller();
             JsonResponseHandler<CreateFileSystemResultresponseHandler =
                 new JsonResponseHandler<CreateFileSystemResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target 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 using another mount target.

This operation requires permission for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

NOTE:The DeleteMountTarget call returns while the mount target state is still "deleting". You can check the mount target deletion by calling the DescribeMountTargets API, which returns a list of mount target descriptions for the given file system.

The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

Parameters:
deleteMountTargetRequest Container for the necessary parameters to execute the DeleteMountTarget service method on AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.DependencyTimeoutException
com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteMountTarget(DeleteMountTargetRequest deleteMountTargetRequest) {
         ExecutionContext executionContext = createExecutionContext(deleteMountTargetRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DeleteMountTargetRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DeleteMountTargetRequestMarshaller().marshall(super.beforeMarshalling(deleteMountTargetRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided; otherwise, 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 .

So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling DescribeFileSystems without the Marker and then continuing to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker .

Note that 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 permission for the elasticfilesystem:DescribeFileSystems action.

Parameters:
describeFileSystemsRequest Container for the necessary parameters to execute the DescribeFileSystems service method on AmazonElasticFileSystem.
Returns:
The response from the DescribeFileSystems service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest) {
         ExecutionContext executionContext = createExecutionContext(describeFileSystemsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeFileSystemsRequestrequest = null;
         Response<DescribeFileSystemsResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeFileSystemsRequestMarshaller().marshall(super.beforeMarshalling(describeFileSystemsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DescribeFileSystemsResultJsonUnmarshallerContextunmarshaller =
                 new DescribeFileSystemsResultJsonUnmarshaller();
             JsonResponseHandler<DescribeFileSystemsResultresponseHandler =
                 new JsonResponseHandler<DescribeFileSystemsResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

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 API.

This operation requires permission for the elasticfilesystem:CreateTags action.

Parameters:
createTagsRequest Container for the necessary parameters to execute the CreateTags service method on AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public void createTags(CreateTagsRequest createTagsRequest) {
         ExecutionContext executionContext = createExecutionContext(createTagsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateTagsRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateTagsRequestMarshaller().marshall(super.beforeMarshalling(createTagsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system.

You cannot 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.

NOTE:The DeleteFileSystem call returns while the file system state is still "deleting". You can check the file system deletion status by calling the DescribeFileSystems API, 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 will return a 404 "FileSystemNotFound" error.

This operation requires permission for the elasticfilesystem:DeleteFileSystem action.

Parameters:
deleteFileSystemRequest Container for the necessary parameters to execute the DeleteFileSystem service method on AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.FileSystemInUseException
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest) {
         ExecutionContext executionContext = createExecutionContext(deleteFileSystemRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DeleteFileSystemRequestrequest = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DeleteFileSystemRequestMarshaller().marshall(super.beforeMarshalling(deleteFileSystemRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
             invoke(requestresponseHandlerexecutionContext);
 
         } finally {
             
             endClientExecution(awsRequestMetricsrequestnull);
         }
     }
    
    

Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified.

This operation requires permission for the elasticfilesystem:DescribeMountTargets action on the file system FileSystemId .

Parameters:
describeMountTargetsRequest Container for the necessary parameters to execute the DescribeMountTargets service method on AmazonElasticFileSystem.
Returns:
The response from the DescribeMountTargets service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeMountTargetsResult describeMountTargets(DescribeMountTargetsRequest describeMountTargetsRequest) {
         ExecutionContext executionContext = createExecutionContext(describeMountTargetsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeMountTargetsRequestrequest = null;
         Response<DescribeMountTargetsResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeMountTargetsRequestMarshaller().marshall(super.beforeMarshalling(describeMountTargetsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<DescribeMountTargetsResultJsonUnmarshallerContextunmarshaller =
                 new DescribeMountTargetsResultJsonUnmarshaller();
             JsonResponseHandler<DescribeMountTargetsResultresponseHandler =
                 new JsonResponseHandler<DescribeMountTargetsResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

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" (see DescribeFileSystems).

In the request, you also provide a subnet ID, which serves several purposes:

  • It determines the VPC in which Amazon EFS creates the mount target.
  • It determines the Availability Zone in which Amazon EFS creates the mount target.
  • It determines 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 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 request to add another mount target must meet the following requirements:

  • The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.

  • The subnet specified in the request 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.

NOTE: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 API, 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, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity 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 permission for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permission for the following Amazon EC2 actions:

  • ec2:DescribeSubnets
  • ec2:DescribeNetworkInterfaces
  • ec2:CreateNetworkInterface

Parameters:
createMountTargetRequest Container for the necessary parameters to execute the CreateMountTarget service method on AmazonElasticFileSystem.
Returns:
The response from the CreateMountTarget service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.SecurityGroupLimitExceededException
com.amazonaws.services.elasticfilesystem.model.IncorrectFileSystemLifeCycleStateException
com.amazonaws.services.elasticfilesystem.model.SubnetNotFoundException
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.MountTargetConflictException
com.amazonaws.services.elasticfilesystem.model.SecurityGroupNotFoundException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.NoFreeAddressesInSubnetException
com.amazonaws.services.elasticfilesystem.model.IpAddressInUseException
com.amazonaws.services.elasticfilesystem.model.NetworkInterfaceLimitExceededException
com.amazonaws.services.elasticfilesystem.model.UnsupportedAvailabilityZoneException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
     public CreateMountTargetResult createMountTarget(CreateMountTargetRequest createMountTargetRequest) {
         ExecutionContext executionContext = createExecutionContext(createMountTargetRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<CreateMountTargetRequestrequest = null;
         Response<CreateMountTargetResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new CreateMountTargetRequestMarshaller().marshall(super.beforeMarshalling(createMountTargetRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
             Unmarshaller<CreateMountTargetResultJsonUnmarshallerContextunmarshaller =
                 new CreateMountTargetResultJsonUnmarshaller();
             JsonResponseHandler<CreateMountTargetResultresponseHandler =
                 new JsonResponseHandler<CreateMountTargetResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

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 life cycle 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.

Parameters:
describeMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the DescribeMountTargetSecurityGroups service method on AmazonElasticFileSystem.
Returns:
The response from the DescribeMountTargetSecurityGroups service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.IncorrectMountTargetStateException
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
 
         ExecutionContext executionContext = createExecutionContext(describeMountTargetSecurityGroupsRequest);
         AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
         awsRequestMetrics.startEvent(.);
         Request<DescribeMountTargetSecurityGroupsRequestrequest = null;
         Response<DescribeMountTargetSecurityGroupsResultresponse = null;
         
         try {
             awsRequestMetrics.startEvent(.);
             try {
                 request = new DescribeMountTargetSecurityGroupsRequestMarshaller().marshall(super.beforeMarshalling(describeMountTargetSecurityGroupsRequest));
                 // Binds the request metrics to the current request.
                 request.setAWSRequestMetrics(awsRequestMetrics);
             } finally {
                 awsRequestMetrics.endEvent(.);
             }
 
                 new DescribeMountTargetSecurityGroupsResultJsonUnmarshaller();
             JsonResponseHandler<DescribeMountTargetSecurityGroupsResultresponseHandler =
                 new JsonResponseHandler<DescribeMountTargetSecurityGroupsResult>(unmarshaller);
 
             response = invoke(requestresponseHandlerexecutionContext);
 
             return response.getAwsResponse();
         } finally {
             
             endClientExecution(awsRequestMetricsrequestresponse);
         }
     }

    

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 (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 life cycle 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.

Parameters:
modifyMountTargetSecurityGroupsRequest Container for the necessary parameters to execute the ModifyMountTargetSecurityGroups service method on AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.IncorrectMountTargetStateException
com.amazonaws.services.elasticfilesystem.model.SecurityGroupLimitExceededException
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.SecurityGroupNotFoundException
com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
    public void modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest modifyMountTargetSecurityGroupsRequest) {
        ExecutionContext executionContext = createExecutionContext(modifyMountTargetSecurityGroupsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<ModifyMountTargetSecurityGroupsRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new ModifyMountTargetSecurityGroupsRequestMarshaller().marshall(super.beforeMarshalling(modifyMountTargetSecurityGroupsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

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 permission for the elasticfilesystem:DescribeTags action.

Parameters:
describeTagsRequest Container for the necessary parameters to execute the DescribeTags service method on AmazonElasticFileSystem.
Returns:
The response from the DescribeTags service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
    public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) {
        ExecutionContext executionContext = createExecutionContext(describeTagsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DescribeTagsRequestrequest = null;
        Response<DescribeTagsResultresponse = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DescribeTagsRequestMarshaller().marshall(super.beforeMarshalling(describeTagsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            Unmarshaller<DescribeTagsResultJsonUnmarshallerContextunmarshaller =
                new DescribeTagsResultJsonUnmarshaller();
            JsonResponseHandler<DescribeTagsResultresponseHandler =
                new JsonResponseHandler<DescribeTagsResult>(unmarshaller);
            response = invoke(requestresponseHandlerexecutionContext);
            return response.getAwsResponse();
        } finally {
            
            endClientExecution(awsRequestMetricsrequestresponse);
        }
    }

    

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to Tag Restrictions in the AWS Billing and Cost Management User Guide .

This operation requires permission for the elasticfilesystem:DeleteTags action.

Parameters:
deleteTagsRequest Container for the necessary parameters to execute the DeleteTags service method on AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
    public void deleteTags(DeleteTagsRequest deleteTagsRequest) {
        ExecutionContext executionContext = createExecutionContext(deleteTagsRequest);
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        awsRequestMetrics.startEvent(.);
        Request<DeleteTagsRequestrequest = null;
        
        try {
            awsRequestMetrics.startEvent(.);
            try {
                request = new DeleteTagsRequestMarshaller().marshall(super.beforeMarshalling(deleteTagsRequest));
                // Binds the request metrics to the current request.
                request.setAWSRequestMetrics(awsRequestMetrics);
            } finally {
                awsRequestMetrics.endEvent(.);
            }
            JsonResponseHandler<VoidresponseHandler = new JsonResponseHandler<Void>(null);
            invoke(requestresponseHandlerexecutionContext);
        } finally {
            
            endClientExecution(awsRequestMetricsrequestnull);
        }
    }
    
    

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided; otherwise, 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 .

So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling DescribeFileSystems without the Marker and then continuing to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker .

Note that 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 permission for the elasticfilesystem:DescribeFileSystems action.

Returns:
The response from the DescribeFileSystems service method, as returned by AmazonElasticFileSystem.
Throws:
com.amazonaws.services.elasticfilesystem.model.BadRequestException
com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException
com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonElasticFileSystem indicating either a problem with the data in the request, or a server side issue.
        return describeFileSystems(new DescribeFileSystemsRequest());
    }
    @Override
    public void setEndpoint(String endpoint) {
        super.setEndpoint(endpoint);
    }
    @Override
    public void setEndpoint(String endpointString serviceNameString regionIdthrows IllegalArgumentException {
        super.setEndpoint(endpointserviceNameregionId);
    }

    
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.

Parameters:
request The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
        return .getResponseMetadataForRequest(request);
    }
    private <X, Y extends AmazonWebServiceRequestResponse<X> invoke(Request<Y> request,
            HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler,
            ExecutionContext executionContext) {
        request.setEndpoint();
        request.setTimeOffset();
        AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
        AWSCredentials credentials;
        awsRequestMetrics.startEvent(.);
        try {
            credentials = .getCredentials();
        } finally {
            awsRequestMetrics.endEvent(.);
        }
        AmazonWebServiceRequest originalRequest = request.getOriginalRequest();
        if (originalRequest != null && originalRequest.getRequestCredentials() != null) {
            credentials = originalRequest.getRequestCredentials();
        }
        executionContext.setCredentials(credentials);
        JsonErrorResponseHandler errorResponseHandler = new JsonErrorResponseHandler();
        Response<X> result = .execute(requestresponseHandler,
                errorResponseHandlerexecutionContext);
        return result;
    }
}
        
New to GrepCode? Check out our FAQ X