@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonFSxAsyncClient extends AmazonFSxClient implements AmazonFSxAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<AssociateFileSystemAliasesResult> |
associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest request)
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows
File Server file system.
|
Future<AssociateFileSystemAliasesResult> |
associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest request,
AsyncHandler<AssociateFileSystemAliasesRequest,AssociateFileSystemAliasesResult> asyncHandler)
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows
File Server file system.
|
static AmazonFSxAsyncClientBuilder |
asyncBuilder() |
Future<CancelDataRepositoryTaskResult> |
cancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest request)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING state. |
Future<CancelDataRepositoryTaskResult> |
cancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest request,
AsyncHandler<CancelDataRepositoryTaskRequest,CancelDataRepositoryTaskResult> asyncHandler)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING state. |
Future<CopyBackupResult> |
copyBackupAsync(CopyBackupRequest request)
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region
(cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).
|
Future<CopyBackupResult> |
copyBackupAsync(CopyBackupRequest request,
AsyncHandler<CopyBackupRequest,CopyBackupResult> asyncHandler)
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region
(cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).
|
Future<CreateBackupResult> |
createBackupAsync(CreateBackupRequest request)
Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an
Amazon FSx for NetApp ONTAP volume.
|
Future<CreateBackupResult> |
createBackupAsync(CreateBackupRequest request,
AsyncHandler<CreateBackupRequest,CreateBackupResult> asyncHandler)
Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an
Amazon FSx for NetApp ONTAP volume.
|
Future<CreateDataRepositoryTaskResult> |
createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest request)
Creates an Amazon FSx for Lustre data repository task.
|
Future<CreateDataRepositoryTaskResult> |
createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest request,
AsyncHandler<CreateDataRepositoryTaskRequest,CreateDataRepositoryTaskResult> asyncHandler)
Creates an Amazon FSx for Lustre data repository task.
|
Future<CreateFileSystemResult> |
createFileSystemAsync(CreateFileSystemRequest request)
Creates a new, empty Amazon FSx file system.
|
Future<CreateFileSystemResult> |
createFileSystemAsync(CreateFileSystemRequest request,
AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler)
Creates a new, empty Amazon FSx file system.
|
Future<CreateFileSystemFromBackupResult> |
createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest request)
Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx
backup.
|
Future<CreateFileSystemFromBackupResult> |
createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest request,
AsyncHandler<CreateFileSystemFromBackupRequest,CreateFileSystemFromBackupResult> asyncHandler)
Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx
backup.
|
Future<CreateStorageVirtualMachineResult> |
createStorageVirtualMachineAsync(CreateStorageVirtualMachineRequest request)
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
|
Future<CreateStorageVirtualMachineResult> |
createStorageVirtualMachineAsync(CreateStorageVirtualMachineRequest request,
AsyncHandler<CreateStorageVirtualMachineRequest,CreateStorageVirtualMachineResult> asyncHandler)
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
|
Future<CreateVolumeResult> |
createVolumeAsync(CreateVolumeRequest request)
Creates an Amazon FSx for NetApp ONTAP storage volume.
|
Future<CreateVolumeResult> |
createVolumeAsync(CreateVolumeRequest request,
AsyncHandler<CreateVolumeRequest,CreateVolumeResult> asyncHandler)
Creates an Amazon FSx for NetApp ONTAP storage volume.
|
Future<CreateVolumeFromBackupResult> |
createVolumeFromBackupAsync(CreateVolumeFromBackupRequest request)
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
|
Future<CreateVolumeFromBackupResult> |
createVolumeFromBackupAsync(CreateVolumeFromBackupRequest request,
AsyncHandler<CreateVolumeFromBackupRequest,CreateVolumeFromBackupResult> asyncHandler)
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
|
Future<DeleteBackupResult> |
deleteBackupAsync(DeleteBackupRequest request)
Deletes an Amazon FSx backup, deleting its contents.
|
Future<DeleteBackupResult> |
deleteBackupAsync(DeleteBackupRequest request,
AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler)
Deletes an Amazon FSx backup, deleting its contents.
|
Future<DeleteFileSystemResult> |
deleteFileSystemAsync(DeleteFileSystemRequest request)
Deletes a file system, deleting its contents.
|
Future<DeleteFileSystemResult> |
deleteFileSystemAsync(DeleteFileSystemRequest request,
AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResult> asyncHandler)
Deletes a file system, deleting its contents.
|
Future<DeleteStorageVirtualMachineResult> |
deleteStorageVirtualMachineAsync(DeleteStorageVirtualMachineRequest request)
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).
|
Future<DeleteStorageVirtualMachineResult> |
deleteStorageVirtualMachineAsync(DeleteStorageVirtualMachineRequest request,
AsyncHandler<DeleteStorageVirtualMachineRequest,DeleteStorageVirtualMachineResult> asyncHandler)
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).
|
Future<DeleteVolumeResult> |
deleteVolumeAsync(DeleteVolumeRequest request)
Deletes an Amazon FSx for NetApp ONTAP volume.
|
Future<DeleteVolumeResult> |
deleteVolumeAsync(DeleteVolumeRequest request,
AsyncHandler<DeleteVolumeRequest,DeleteVolumeResult> asyncHandler)
Deletes an Amazon FSx for NetApp ONTAP volume.
|
Future<DescribeBackupsResult> |
describeBackupsAsync(DescribeBackupsRequest request)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
Future<DescribeBackupsResult> |
describeBackupsAsync(DescribeBackupsRequest request,
AsyncHandler<DescribeBackupsRequest,DescribeBackupsResult> asyncHandler)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
Future<DescribeDataRepositoryTasksResult> |
describeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest request)
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. |
Future<DescribeDataRepositoryTasksResult> |
describeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest request,
AsyncHandler<DescribeDataRepositoryTasksRequest,DescribeDataRepositoryTasksResult> asyncHandler)
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. |
Future<DescribeFileSystemAliasesResult> |
describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest request)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
Future<DescribeFileSystemAliasesResult> |
describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest request,
AsyncHandler<DescribeFileSystemAliasesRequest,DescribeFileSystemAliasesResult> asyncHandler)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
Future<DescribeFileSystemsResult> |
describeFileSystemsAsync(DescribeFileSystemsRequest request)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
Future<DescribeFileSystemsResult> |
describeFileSystemsAsync(DescribeFileSystemsRequest request,
AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
Future<DescribeStorageVirtualMachinesResult> |
describeStorageVirtualMachinesAsync(DescribeStorageVirtualMachinesRequest request)
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
Future<DescribeStorageVirtualMachinesResult> |
describeStorageVirtualMachinesAsync(DescribeStorageVirtualMachinesRequest request,
AsyncHandler<DescribeStorageVirtualMachinesRequest,DescribeStorageVirtualMachinesResult> asyncHandler)
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
Future<DescribeVolumesResult> |
describeVolumesAsync(DescribeVolumesRequest request)
Describes one or more Amazon FSx for NetApp ONTAP volumes.
|
Future<DescribeVolumesResult> |
describeVolumesAsync(DescribeVolumesRequest request,
AsyncHandler<DescribeVolumesRequest,DescribeVolumesResult> asyncHandler)
Describes one or more Amazon FSx for NetApp ONTAP volumes.
|
Future<DisassociateFileSystemAliasesResult> |
disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest request)
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for
Windows File Server file system.
|
Future<DisassociateFileSystemAliasesResult> |
disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest request,
AsyncHandler<DisassociateFileSystemAliasesRequest,DisassociateFileSystemAliasesResult> asyncHandler)
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for
Windows File Server file system.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Tags an Amazon FSx resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tags an Amazon FSx resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
This action removes a tag from an Amazon FSx resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
This action removes a tag from an Amazon FSx resource.
|
Future<UpdateFileSystemResult> |
updateFileSystemAsync(UpdateFileSystemRequest request)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
Future<UpdateFileSystemResult> |
updateFileSystemAsync(UpdateFileSystemRequest request,
AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResult> asyncHandler)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
Future<UpdateStorageVirtualMachineResult> |
updateStorageVirtualMachineAsync(UpdateStorageVirtualMachineRequest request)
Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
|
Future<UpdateStorageVirtualMachineResult> |
updateStorageVirtualMachineAsync(UpdateStorageVirtualMachineRequest request,
AsyncHandler<UpdateStorageVirtualMachineRequest,UpdateStorageVirtualMachineResult> asyncHandler)
Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
|
Future<UpdateVolumeResult> |
updateVolumeAsync(UpdateVolumeRequest request)
Updates an Amazon FSx for NetApp ONTAP volume's configuration.
|
Future<UpdateVolumeResult> |
updateVolumeAsync(UpdateVolumeRequest request,
AsyncHandler<UpdateVolumeRequest,UpdateVolumeResult> asyncHandler)
Updates an Amazon FSx for NetApp ONTAP volume's configuration.
|
associateFileSystemAliases, builder, cancelDataRepositoryTask, copyBackup, createBackup, createDataRepositoryTask, createFileSystem, createFileSystemFromBackup, createStorageVirtualMachine, createVolume, createVolumeFromBackup, deleteBackup, deleteFileSystem, deleteStorageVirtualMachine, deleteVolume, describeBackups, describeDataRepositoryTasks, describeFileSystemAliases, describeFileSystems, describeStorageVirtualMachines, describeVolumes, disassociateFileSystemAliases, getCachedResponseMetadata, listTagsForResource, tagResource, untagResource, updateFileSystem, updateStorageVirtualMachine, updateVolumeaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateFileSystemAliases, cancelDataRepositoryTask, copyBackup, createBackup, createDataRepositoryTask, createFileSystem, createFileSystemFromBackup, createStorageVirtualMachine, createVolume, createVolumeFromBackup, deleteBackup, deleteFileSystem, deleteStorageVirtualMachine, deleteVolume, describeBackups, describeDataRepositoryTasks, describeFileSystemAliases, describeFileSystems, describeStorageVirtualMachines, describeVolumes, disassociateFileSystemAliases, getCachedResponseMetadata, listTagsForResource, tagResource, untagResource, updateFileSystem, updateStorageVirtualMachine, updateVolumepublic static AmazonFSxAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateFileSystemAliasesResult> associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest request)
AmazonFSxAsyncUse this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
associateFileSystemAliasesAsync in interface AmazonFSxAsyncrequest - The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File
Server file system.public Future<AssociateFileSystemAliasesResult> associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest request, AsyncHandler<AssociateFileSystemAliasesRequest,AssociateFileSystemAliasesResult> asyncHandler)
AmazonFSxAsyncUse this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
associateFileSystemAliasesAsync in interface AmazonFSxAsyncrequest - The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File
Server file system.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CancelDataRepositoryTaskResult> cancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest request)
AmazonFSxAsync
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.
cancelDataRepositoryTaskAsync in interface AmazonFSxAsyncrequest - Cancels a data repository task.public Future<CancelDataRepositoryTaskResult> cancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest request, AsyncHandler<CancelDataRepositoryTaskRequest,CancelDataRepositoryTaskResult> asyncHandler)
AmazonFSxAsync
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.
cancelDataRepositoryTaskAsync in interface AmazonFSxAsyncrequest - Cancels a data repository task.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CopyBackupResult> copyBackupAsync(CopyBackupRequest request)
AmazonFSxAsyncCopies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition.
You can also use backup copies to clone your file data set to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the
backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy
a backup from the us-east-2 Region, you specify us-east-2 in the
SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy
is created in the same Region where the request is sent from (in-Region copy).
For more information on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide.
copyBackupAsync in interface AmazonFSxAsyncpublic Future<CopyBackupResult> copyBackupAsync(CopyBackupRequest request, AsyncHandler<CopyBackupRequest,CopyBackupResult> asyncHandler)
AmazonFSxAsyncCopies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition.
You can also use backup copies to clone your file data set to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the
backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy
a backup from the us-east-2 Region, you specify us-east-2 in the
SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy
is created in the same Region where the request is sent from (in-Region copy).
For more information on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide.
copyBackupAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateBackupResult> createBackupAsync(CreateBackupRequest request)
AmazonFSxAsyncCreates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data repository.
For more information about backups, see the following:
For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
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 CreateBackup operation returns while the backup's lifecycle state is still CREATING
. You can check the backup creation status by calling the DescribeBackups operation, which returns the
backup state along with other information.
createBackupAsync in interface AmazonFSxAsyncrequest - The request object for the CreateBackup operation.public Future<CreateBackupResult> createBackupAsync(CreateBackupRequest request, AsyncHandler<CreateBackupRequest,CreateBackupResult> asyncHandler)
AmazonFSxAsyncCreates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data repository.
For more information about backups, see the following:
For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
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 CreateBackup operation returns while the backup's lifecycle state is still CREATING
. You can check the backup creation status by calling the DescribeBackups operation, which returns the
backup state along with other information.
createBackupAsync in interface AmazonFSxAsyncrequest - The request object for the CreateBackup operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDataRepositoryTaskResult> createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest request)
AmazonFSxAsync
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 Data Repository Tasks.
To learn more about linking a data repository to your file system, see Linking your file
system to an S3 bucket.
createDataRepositoryTaskAsync in interface AmazonFSxAsyncpublic Future<CreateDataRepositoryTaskResult> createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest request, AsyncHandler<CreateDataRepositoryTaskRequest,CreateDataRepositoryTaskResult> asyncHandler)
AmazonFSxAsync
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 Data Repository Tasks.
To learn more about linking a data repository to your file system, see Linking your file
system to an S3 bucket.
createDataRepositoryTaskAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest request)
AmazonFSxAsyncCreates 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.
createFileSystemAsync in interface AmazonFSxAsyncrequest - The request object used to create a new Amazon FSx file system.public Future<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest request, AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler)
AmazonFSxAsyncCreates 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.
createFileSystemAsync in interface AmazonFSxAsyncrequest - The request object used to create a new Amazon FSx file system.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFileSystemFromBackupResult> createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest request)
AmazonFSxAsyncCreates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx 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.
createFileSystemFromBackupAsync in interface AmazonFSxAsyncrequest - The request object for the CreateFileSystemFromBackup operation.public Future<CreateFileSystemFromBackupResult> createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest request, AsyncHandler<CreateFileSystemFromBackupRequest,CreateFileSystemFromBackupResult> asyncHandler)
AmazonFSxAsyncCreates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx 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.
createFileSystemFromBackupAsync in interface AmazonFSxAsyncrequest - The request object for the CreateFileSystemFromBackup operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStorageVirtualMachineResult> createStorageVirtualMachineAsync(CreateStorageVirtualMachineRequest request)
AmazonFSxAsyncCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
createStorageVirtualMachineAsync in interface AmazonFSxAsyncpublic Future<CreateStorageVirtualMachineResult> createStorageVirtualMachineAsync(CreateStorageVirtualMachineRequest request, AsyncHandler<CreateStorageVirtualMachineRequest,CreateStorageVirtualMachineResult> asyncHandler)
AmazonFSxAsyncCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
createStorageVirtualMachineAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateVolumeResult> createVolumeAsync(CreateVolumeRequest request)
AmazonFSxAsyncCreates an Amazon FSx for NetApp ONTAP storage volume.
createVolumeAsync in interface AmazonFSxAsyncpublic Future<CreateVolumeResult> createVolumeAsync(CreateVolumeRequest request, AsyncHandler<CreateVolumeRequest,CreateVolumeResult> asyncHandler)
AmazonFSxAsyncCreates an Amazon FSx for NetApp ONTAP storage volume.
createVolumeAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateVolumeFromBackupResult> createVolumeFromBackupAsync(CreateVolumeFromBackupRequest request)
AmazonFSxAsyncCreates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
createVolumeFromBackupAsync in interface AmazonFSxAsyncpublic Future<CreateVolumeFromBackupResult> createVolumeFromBackupAsync(CreateVolumeFromBackupRequest request, AsyncHandler<CreateVolumeFromBackupRequest,CreateVolumeFromBackupResult> asyncHandler)
AmazonFSxAsyncCreates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
createVolumeFromBackupAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest request)
AmazonFSxAsyncDeletes an Amazon FSx 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.
deleteBackupAsync in interface AmazonFSxAsyncrequest - The request object for DeleteBackup operation.public Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest request, AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler)
AmazonFSxAsyncDeletes an Amazon FSx 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.
deleteBackupAsync in interface AmazonFSxAsyncrequest - The request object for DeleteBackup operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFileSystemResult> deleteFileSystemAsync(DeleteFileSystemRequest request)
AmazonFSxAsyncDeletes 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.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system.
Then provide a FileSystemId value to the DeleFileSystem operation.
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.
deleteFileSystemAsync in interface AmazonFSxAsyncrequest - The request object for DeleteFileSystem operation.public Future<DeleteFileSystemResult> deleteFileSystemAsync(DeleteFileSystemRequest request, AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResult> asyncHandler)
AmazonFSxAsyncDeletes 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.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system.
Then provide a FileSystemId value to the DeleFileSystem operation.
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.
deleteFileSystemAsync in interface AmazonFSxAsyncrequest - The request object for DeleteFileSystem operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStorageVirtualMachineResult> deleteStorageVirtualMachineAsync(DeleteStorageVirtualMachineRequest request)
AmazonFSxAsyncDeletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
deleteStorageVirtualMachineAsync in interface AmazonFSxAsyncpublic Future<DeleteStorageVirtualMachineResult> deleteStorageVirtualMachineAsync(DeleteStorageVirtualMachineRequest request, AsyncHandler<DeleteStorageVirtualMachineRequest,DeleteStorageVirtualMachineResult> asyncHandler)
AmazonFSxAsyncDeletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
deleteStorageVirtualMachineAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest request)
AmazonFSxAsync
Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final
backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have
fsx:TagResource permission in order to apply tags to the backup.
deleteVolumeAsync in interface AmazonFSxAsyncpublic Future<DeleteVolumeResult> deleteVolumeAsync(DeleteVolumeRequest request, AsyncHandler<DeleteVolumeRequest,DeleteVolumeResult> asyncHandler)
AmazonFSxAsync
Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final
backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have
fsx:TagResource permission in order to apply tags to the backup.
deleteVolumeAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest request)
AmazonFSxAsync
Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
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 backup 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.
describeBackupsAsync in interface AmazonFSxAsyncrequest - The request object for DescribeBackups operation.public Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest request, AsyncHandler<DescribeBackupsRequest,DescribeBackupsResult> asyncHandler)
AmazonFSxAsync
Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
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 backup 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.
describeBackupsAsync in interface AmazonFSxAsyncrequest - The request object for DescribeBackups operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataRepositoryTasksResult> describeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest request)
AmazonFSxAsync
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 Amazon Web Services account in the Amazon
Web Services 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.
describeDataRepositoryTasksAsync in interface AmazonFSxAsyncpublic Future<DescribeDataRepositoryTasksResult> describeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest request, AsyncHandler<DescribeDataRepositoryTasksRequest,DescribeDataRepositoryTasksResult> asyncHandler)
AmazonFSxAsync
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 Amazon Web Services account in the Amazon
Web Services 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.
describeDataRepositoryTasksAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFileSystemAliasesResult> describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest request)
AmazonFSxAsyncReturns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
describeFileSystemAliasesAsync in interface AmazonFSxAsyncrequest - The request object for DescribeFileSystemAliases operation.public Future<DescribeFileSystemAliasesResult> describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest request, AsyncHandler<DescribeFileSystemAliasesRequest,DescribeFileSystemAliasesResult> asyncHandler)
AmazonFSxAsyncReturns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
describeFileSystemAliasesAsync in interface AmazonFSxAsyncrequest - The request object for DescribeFileSystemAliases operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest request)
AmazonFSxAsync
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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the 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.
describeFileSystemsAsync in interface AmazonFSxAsyncrequest - The request object for DescribeFileSystems operation.public Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest request, AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler)
AmazonFSxAsync
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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the 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.
describeFileSystemsAsync in interface AmazonFSxAsyncrequest - The request object for DescribeFileSystems operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeStorageVirtualMachinesResult> describeStorageVirtualMachinesAsync(DescribeStorageVirtualMachinesRequest request)
AmazonFSxAsyncDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
describeStorageVirtualMachinesAsync in interface AmazonFSxAsyncpublic Future<DescribeStorageVirtualMachinesResult> describeStorageVirtualMachinesAsync(DescribeStorageVirtualMachinesRequest request, AsyncHandler<DescribeStorageVirtualMachinesRequest,DescribeStorageVirtualMachinesResult> asyncHandler)
AmazonFSxAsyncDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
describeStorageVirtualMachinesAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeVolumesResult> describeVolumesAsync(DescribeVolumesRequest request)
AmazonFSxAsyncDescribes one or more Amazon FSx for NetApp ONTAP volumes.
describeVolumesAsync in interface AmazonFSxAsyncpublic Future<DescribeVolumesResult> describeVolumesAsync(DescribeVolumesRequest request, AsyncHandler<DescribeVolumesRequest,DescribeVolumesResult> asyncHandler)
AmazonFSxAsyncDescribes one or more Amazon FSx for NetApp ONTAP volumes.
describeVolumesAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateFileSystemAliasesResult> disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest request)
AmazonFSxAsyncUse this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
disassociateFileSystemAliasesAsync in interface AmazonFSxAsyncrequest - The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.public Future<DisassociateFileSystemAliasesResult> disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest request, AsyncHandler<DisassociateFileSystemAliasesRequest,DisassociateFileSystemAliasesResult> asyncHandler)
AmazonFSxAsyncUse this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
disassociateFileSystemAliasesAsync in interface AmazonFSxAsyncrequest - The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonFSxAsyncLists 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.
listTagsForResourceAsync in interface AmazonFSxAsyncrequest - The request object for ListTagsForResource operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonFSxAsyncLists 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.
listTagsForResourceAsync in interface AmazonFSxAsyncrequest - The request object for ListTagsForResource operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonFSxAsyncTags an Amazon FSx resource.
tagResourceAsync in interface AmazonFSxAsyncrequest - The request object for the TagResource operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonFSxAsyncTags an Amazon FSx resource.
tagResourceAsync in interface AmazonFSxAsyncrequest - The request object for the TagResource operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonFSxAsyncThis action removes a tag from an Amazon FSx resource.
untagResourceAsync in interface AmazonFSxAsyncrequest - The request object for UntagResource action.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonFSxAsyncThis action removes a tag from an Amazon FSx resource.
untagResourceAsync in interface AmazonFSxAsyncrequest - The request object for UntagResource action.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateFileSystemResult> updateFileSystemAsync(UpdateFileSystemRequest request)
AmazonFSxAsyncUse this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
StorageCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
FsxAdminPassword
WeeklyMaintenanceStartTime
updateFileSystemAsync in interface AmazonFSxAsyncrequest - The request object for the UpdateFileSystem operation.public Future<UpdateFileSystemResult> updateFileSystemAsync(UpdateFileSystemRequest request, AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResult> asyncHandler)
AmazonFSxAsyncUse this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
StorageCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
FsxAdminPassword
WeeklyMaintenanceStartTime
updateFileSystemAsync in interface AmazonFSxAsyncrequest - The request object for the UpdateFileSystem operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateStorageVirtualMachineResult> updateStorageVirtualMachineAsync(UpdateStorageVirtualMachineRequest request)
AmazonFSxAsyncUpdates an Amazon FSx for ONTAP storage virtual machine (SVM).
updateStorageVirtualMachineAsync in interface AmazonFSxAsyncpublic Future<UpdateStorageVirtualMachineResult> updateStorageVirtualMachineAsync(UpdateStorageVirtualMachineRequest request, AsyncHandler<UpdateStorageVirtualMachineRequest,UpdateStorageVirtualMachineResult> asyncHandler)
AmazonFSxAsyncUpdates an Amazon FSx for ONTAP storage virtual machine (SVM).
updateStorageVirtualMachineAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateVolumeResult> updateVolumeAsync(UpdateVolumeRequest request)
AmazonFSxAsyncUpdates an Amazon FSx for NetApp ONTAP volume's configuration.
updateVolumeAsync in interface AmazonFSxAsyncpublic Future<UpdateVolumeResult> updateVolumeAsync(UpdateVolumeRequest request, AsyncHandler<UpdateVolumeRequest,UpdateVolumeResult> asyncHandler)
AmazonFSxAsyncUpdates an Amazon FSx for NetApp ONTAP volume's configuration.
updateVolumeAsync in interface AmazonFSxAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonFSxshutdown in class AmazonFSxClient