com.amazonaws.services.elasticfilesystem

Class AmazonElasticFileSystemClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystemClient

All Implemented Interfaces:

AmazonElasticFileSystem

Direct Known Subclasses:

AmazonElasticFileSystemAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonElasticFileSystemClient
extends AmazonWebServiceClient
implements AmazonElasticFileSystem

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

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystem

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonElasticFileSystemClient() Deprecated. use AmazonElasticFileSystemClientBuilder.defaultClient()
AmazonElasticFileSystemClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonElasticFileSystemClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonElasticFileSystemClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonElasticFileSystemClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AmazonElasticFileSystemClientBuilder	builder()
CreateFileSystemResult	createFileSystem(CreateFileSystemRequest request) Creates a new, empty file system.
CreateMountTargetResult	createMountTarget(CreateMountTargetRequest request) Creates a mount target for a file system.
CreateTagsResult	createTags(CreateTagsRequest request) Creates or overwrites tags associated with a file system.
DeleteFileSystemResult	deleteFileSystem(DeleteFileSystemRequest request) Deletes a file system, permanently severing access to its contents.
DeleteMountTargetResult	deleteMountTarget(DeleteMountTargetRequest request) Deletes the specified mount target.
DeleteTagsResult	deleteTags(DeleteTagsRequest request) Deletes the specified tags from a file system.
DescribeFileSystemsResult	describeFileSystems() Simplified method form for invoking the DescribeFileSystems operation.
DescribeFileSystemsResult	describeFileSystems(DescribeFileSystemsRequest request) Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided.
DescribeMountTargetsResult	describeMountTargets(DescribeMountTargetsRequest request) Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
DescribeMountTargetSecurityGroupsResult	describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest request) Returns the security groups currently in effect for a mount target.
DescribeTagsResult	describeTags(DescribeTagsRequest request) Returns the tags associated with a file system.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ModifyMountTargetSecurityGroupsResult	modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request) Modifies the set of security groups in effect for a mount target.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticfilesystem.AmazonElasticFileSystem

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient()

Deprecated. use AmazonElasticFileSystemClientBuilder.defaultClient()

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 Also:

DefaultAWSCredentialsProviderChain

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to EFS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonElasticFileSystemClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient(AWSCredentials awsCredentials,
                                                 ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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.

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 EFS (ex: proxy settings, retry counts, etc.).

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

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.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider,
                                                 ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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.

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 EFS (ex: proxy settings, retry counts, etc.).

AmazonElasticFileSystemClient

@Deprecated
public AmazonElasticFileSystemClient(AWSCredentialsProvider awsCredentialsProvider,
                                                 ClientConfiguration clientConfiguration,
                                                 RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

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.

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 EFS (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonElasticFileSystemClientBuilder builder()

createFileSystem

public CreateFileSystemResult createFileSystem(CreateFileSystemRequest request)

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

• Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

• Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Specified by:

createFileSystem in interface AmazonElasticFileSystem

Parameters:

createFileSystemRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemAlreadyExistsException - Returned if the file system you are trying to create already exists, with the creation token you provided.

FileSystemLimitExceededException - Returned if the AWS account has already created maximum number of file systems allowed per account.

See Also:

AWS API Documentation

createMountTarget

public CreateMountTargetResult createMountTarget(CreateMountTargetRequest request)

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

• VPC in which Amazon EFS creates the mount target

• Availability Zone in which Amazon EFS creates the mount target

• IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

• Must belong to the same VPC as the subnets of the existing mount targets

• Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

• Creates a new mount target in the specified subnet.

• Also creates a new network interface in the subnet as follows:

  • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

  • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

  • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

  • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

  Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

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

• elasticfilesystem:CreateMountTarget

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

• ec2:DescribeSubnets

• ec2:DescribeNetworkInterfaces

• ec2:CreateNetworkInterface

Specified by:

createMountTarget in interface AmazonElasticFileSystem

Parameters:

createMountTargetRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

IncorrectFileSystemLifeCycleStateException - Returned if the file system's life cycle state is not "created".

MountTargetConflictException - Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

SubnetNotFoundException - Returned if there is no subnet with ID SubnetId provided in the request.

NoFreeAddressesInSubnetException - Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

IpAddressInUseException - Returned if the request specified an IpAddress that is already in use in the subnet.

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

SecurityGroupLimitExceededException - Returned if the size of SecurityGroups specified in the request is greater than five.

SecurityGroupNotFoundException - Returned if one of the specified security groups does not exist in the subnet's VPC.

UnsupportedAvailabilityZoneException

See Also:

AWS API Documentation

createTags

public CreateTagsResult createTags(CreateTagsRequest request)

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.

Specified by:

createTags in interface AmazonElasticFileSystem

Parameters:

createTagsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

See Also:

AWS API Documentation

deleteFileSystem

public DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest request)

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

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

Specified by:

deleteFileSystem in interface AmazonElasticFileSystem

Parameters:

deleteFileSystemRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

FileSystemInUseException - Returned if a file system has mount targets.

See Also:

AWS API Documentation

deleteMountTarget

public DeleteMountTargetResult deleteMountTarget(DeleteMountTargetRequest request)

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

Specified by:

deleteMountTarget in interface AmazonElasticFileSystem

Parameters:

deleteMountTargetRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

DependencyTimeoutException - The service timed out trying to fulfill the request, and the client should try the call again.

MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's account.

See Also:

AWS API Documentation

deleteTags

public DeleteTagsResult deleteTags(DeleteTagsRequest request)

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.

Specified by:

deleteTags in interface AmazonElasticFileSystem

Parameters:

deleteTagsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

See Also:

AWS API Documentation

describeFileSystems

public DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest request)

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's 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.

Specified by:

describeFileSystems in interface AmazonElasticFileSystem

Parameters:

describeFileSystemsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

See Also:

AWS API Documentation

describeFileSystems

public DescribeFileSystemsResult describeFileSystems()

Description copied from interface: AmazonElasticFileSystem

Simplified method form for invoking the DescribeFileSystems operation.

Specified by:

describeFileSystems in interface AmazonElasticFileSystem

See Also:

AmazonElasticFileSystem.describeFileSystems(DescribeFileSystemsRequest)

describeMountTargetSecurityGroups

public DescribeMountTargetSecurityGroupsResult describeMountTargetSecurityGroups(DescribeMountTargetSecurityGroupsRequest request)

Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

This operation requires permissions for the following actions:

• elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

• ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

Specified by:

describeMountTargetSecurityGroups in interface AmazonElasticFileSystem

Parameters:

describeMountTargetSecurityGroupsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's account.

IncorrectMountTargetStateException - Returned if the mount target is not in the correct state for the operation.

See Also:

AWS API Documentation

describeMountTargets

public DescribeMountTargetsResult describeMountTargets(DescribeMountTargetsRequest request)

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.

Specified by:

describeMountTargets in interface AmazonElasticFileSystem

Parameters:

describeMountTargetsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's account.

See Also:

AWS API Documentation

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest request)

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.

Specified by:

describeTags in interface AmazonElasticFileSystem

Parameters:

describeTagsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

FileSystemNotFoundException - Returned if the specified FileSystemId does not exist in the requester's AWS account.

See Also:

AWS API Documentation

modifyMountTargetSecurityGroups

public ModifyMountTargetSecurityGroupsResult modifyMountTargetSecurityGroups(ModifyMountTargetSecurityGroupsRequest request)

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

The operation requires permissions for the following actions:

• elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

• ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

Specified by:

modifyMountTargetSecurityGroups in interface AmazonElasticFileSystem

Parameters:

modifyMountTargetSecurityGroupsRequest -

Returns:

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.

InternalServerErrorException - Returned if an error occurred on the server side.

MountTargetNotFoundException - Returned if there is no mount target with the specified ID found in the caller's account.

IncorrectMountTargetStateException - Returned if the mount target is not in the correct state for the operation.

SecurityGroupLimitExceededException - Returned if the size of SecurityGroups specified in the request is greater than five.

SecurityGroupNotFoundException - Returned if one of the specified security groups does not exist in the subnet's VPC.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Specified by:

getCachedResponseMetadata in interface AmazonElasticFileSystem

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.