com.amazonaws.services.fsx

Interface AmazonFSx

All Known Subinterfaces:

AmazonFSxAsync

All Known Implementing Classes:

AbstractAmazonFSx, AbstractAmazonFSxAsync, AmazonFSxAsyncClient, AmazonFSxClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonFSx

Interface for accessing Amazon FSx.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonFSx instead.

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelDataRepositoryTaskResult	cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest) Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state.
CreateBackupResult	createBackup(CreateBackupRequest createBackupRequest) Creates a backup of an existing Amazon FSx for Windows File Server file system.
CreateDataRepositoryTaskResult	createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest) Creates an Amazon FSx for Lustre data repository task.
CreateFileSystemResult	createFileSystem(CreateFileSystemRequest createFileSystemRequest) Creates a new, empty Amazon FSx file system.
CreateFileSystemFromBackupResult	createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest) Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
DeleteBackupResult	deleteBackup(DeleteBackupRequest deleteBackupRequest) Deletes an Amazon FSx for Windows File Server backup, deleting its contents.
DeleteFileSystemResult	deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest) Deletes a file system, deleting its contents.
DescribeBackupsResult	describeBackups(DescribeBackupsRequest describeBackupsRequest) Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup.
DescribeDataRepositoryTasksResult	describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest) Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request.
DescribeFileSystemsResult	describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest) Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that 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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags an Amazon FSx resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) This action removes a tag from an Amazon FSx resource.
UpdateFileSystemResult	updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest) Updates a file system configuration.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelDataRepositoryTask

CancelDataRepositoryTaskResult cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest)

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.

• Any files that FSx has already exported are not reverted.

• FSx continues to export any files that are "in-flight" when the cancel operation is received.

• FSx does not export any files that have not yet been exported.

Parameters:

cancelDataRepositoryTaskRequest - Cancels a data repository task.

Returns:

Result of the CancelDataRepositoryTask operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

UnsupportedOperationException - The requested operation is not supported for this resource or API.

DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.

DataRepositoryTaskEndedException - The data repository task could not be canceled because the task has already ended.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

createBackup

CreateBackupResult createBackup(CreateBackupRequest createBackupRequest)

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

• Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Parameters:

createBackupRequest - The request object for the CreateBackup operation.

Returns:

Result of the CreateBackup operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

UnsupportedOperationException - The requested operation is not supported for this resource or API.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

BackupInProgressException - Another backup is already under way. Wait for completion before initiating additional backups of this file system.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

createDataRepositoryTask

CreateDataRepositoryTaskResult createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest)

Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Using Data Repository Tasks. To learn more about linking a data repository to your file system, see Step 1: Create Your Amazon FSx for Lustre File System.

Parameters:

createDataRepositoryTaskRequest -

Returns:

Result of the CreateDataRepositoryTask operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

UnsupportedOperationException - The requested operation is not supported for this resource or API.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

InternalServerErrorException - A generic error indicating a server-side failure.

DataRepositoryTaskExecutingException - An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

See Also:

AWS API Documentation

createFileSystem

CreateFileSystemResult createFileSystem(CreateFileSystemRequest createFileSystemRequest)

Creates a new, empty Amazon FSx file system.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

• Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the file system.

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

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 returns the file system state along with other information.

Parameters:

createFileSystemRequest - The request object used to create a new Amazon FSx file system.

Returns:

Result of the CreateFileSystem operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

ActiveDirectoryErrorException - An Active Directory error.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InvalidImportPathException - The path provided for data repository import isn't valid.

InvalidExportPathException - The path provided for data repository export isn't valid.

InvalidNetworkSettingsException - One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

InternalServerErrorException - A generic error indicating a server-side failure.

MissingFileSystemConfigurationException - File system configuration is required for this operation.

See Also:

AWS API Documentation

createFileSystemFromBackup

CreateFileSystemFromBackupResult createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)

Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

• Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the file system.

Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystemFromBackup 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 returns the file system state along with other information.

Parameters:

createFileSystemFromBackupRequest - The request object for the CreateFileSystemFromBackup operation.

Returns:

Result of the CreateFileSystemFromBackup operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

ActiveDirectoryErrorException - An Active Directory error.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InvalidNetworkSettingsException - One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.

InternalServerErrorException - A generic error indicating a server-side failure.

MissingFileSystemConfigurationException - File system configuration is required for this operation.

See Also:

AWS API Documentation

deleteBackup

DeleteBackupResult deleteBackup(DeleteBackupRequest deleteBackupRequest)

Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

Parameters:

deleteBackupRequest - The request object for DeleteBackup operation.

Returns:

Result of the DeleteBackup operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

BackupInProgressException - Another backup is already under way. Wait for completion before initiating additional backups of this file system.

BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.

BackupRestoringException - You can't delete a backup while it's being used to restore a file system.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

deleteFileSystem

DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.

The data in a deleted file system is also deleted and can't be recovered by any means.

Parameters:

deleteFileSystemRequest - The request object for DeleteFileSystem operation.

Returns:

Result of the DeleteFileSystem operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

describeBackups

DescribeBackupsResult describeBackups(DescribeBackupsRequest describeBackupsRequest)

Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

• The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

• The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Parameters:

describeBackupsRequest - The request object for DescribeBackups operation.

Returns:

Result of the DescribeBackups operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

describeDataRepositoryTasks

DescribeDataRepositoryTasksResult describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)

Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Parameters:

describeDataRepositoryTasksRequest -

Returns:

Result of the DescribeDataRepositoryTasks operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

describeFileSystems

DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

• The implementation might return fewer than MaxResults file system descriptions while still including a NextToken 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 multicall iteration is unspecified.

Parameters:

describeFileSystemsRequest - The request object for DescribeFileSystems operation.

Returns:

Result of the DescribeFileSystems operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

InternalServerErrorException - A generic error indicating a server-side failure.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

• The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

• The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

Parameters:

listTagsForResourceRequest - The request object for ListTagsForResource operation.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

InternalServerErrorException - A generic error indicating a server-side failure.

ResourceNotFoundException - The resource specified by the Amazon Resource Name (ARN) can't be found.

NotServiceResourceErrorException - The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

ResourceDoesNotSupportTaggingException - The resource specified does not support tagging.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tags an Amazon FSx resource.

Parameters:

tagResourceRequest - The request object for the TagResource operation.

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

InternalServerErrorException - A generic error indicating a server-side failure.

ResourceNotFoundException - The resource specified by the Amazon Resource Name (ARN) can't be found.

NotServiceResourceErrorException - The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

ResourceDoesNotSupportTaggingException - The resource specified does not support tagging.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

This action removes a tag from an Amazon FSx resource.

Parameters:

untagResourceRequest - The request object for UntagResource action.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

InternalServerErrorException - A generic error indicating a server-side failure.

ResourceNotFoundException - The resource specified by the Amazon Resource Name (ARN) can't be found.

NotServiceResourceErrorException - The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

ResourceDoesNotSupportTaggingException - The resource specified does not support tagging.

See Also:

AWS API Documentation

updateFileSystem

UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)

Updates a file system configuration.

Parameters:

updateFileSystemRequest - The request object for the UpdateFileSystem operation.

Returns:

Result of the UpdateFileSystem operation returned by the service.

Throws:

BadRequestException - A generic error indicating a failure with a client request.

UnsupportedOperationException - The requested operation is not supported for this resource or API.

IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerErrorException - A generic error indicating a server-side failure.

FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.

MissingFileSystemConfigurationException - File system configuration is required for this operation.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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