@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonFSxAsync extends AmazonFSx
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonFSxAsync instead.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<AssociateFileSystemAliasesResult> |
associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest associateFileSystemAliasesRequest)
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 associateFileSystemAliasesRequest,
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.
|
Future<CancelDataRepositoryTaskResult> |
cancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest)
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 cancelDataRepositoryTaskRequest,
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<CreateBackupResult> |
createBackupAsync(CreateBackupRequest createBackupRequest)
Creates a backup of an existing Amazon FSx file system.
|
Future<CreateBackupResult> |
createBackupAsync(CreateBackupRequest createBackupRequest,
AsyncHandler<CreateBackupRequest,CreateBackupResult> asyncHandler)
Creates a backup of an existing Amazon FSx file system.
|
Future<CreateDataRepositoryTaskResult> |
createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest)
Creates an Amazon FSx for Lustre data repository task.
|
Future<CreateDataRepositoryTaskResult> |
createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest,
AsyncHandler<CreateDataRepositoryTaskRequest,CreateDataRepositoryTaskResult> asyncHandler)
Creates an Amazon FSx for Lustre data repository task.
|
Future<CreateFileSystemResult> |
createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty Amazon FSx file system.
|
Future<CreateFileSystemResult> |
createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest,
AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler)
Creates a new, empty Amazon FSx file system.
|
Future<CreateFileSystemFromBackupResult> |
createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
|
Future<CreateFileSystemFromBackupResult> |
createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest,
AsyncHandler<CreateFileSystemFromBackupRequest,CreateFileSystemFromBackupResult> asyncHandler)
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
|
Future<DeleteBackupResult> |
deleteBackupAsync(DeleteBackupRequest deleteBackupRequest)
Deletes an Amazon FSx backup, deleting its contents.
|
Future<DeleteBackupResult> |
deleteBackupAsync(DeleteBackupRequest deleteBackupRequest,
AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler)
Deletes an Amazon FSx backup, deleting its contents.
|
Future<DeleteFileSystemResult> |
deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, deleting its contents.
|
Future<DeleteFileSystemResult> |
deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest,
AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResult> asyncHandler)
Deletes a file system, deleting its contents.
|
Future<DescribeBackupsResult> |
describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
Future<DescribeBackupsResult> |
describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest,
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 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. |
Future<DescribeDataRepositoryTasksResult> |
describeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest,
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 describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
Future<DescribeFileSystemAliasesResult> |
describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest,
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 describeFileSystemsRequest)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
Future<DescribeFileSystemsResult> |
describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest,
AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
Future<DisassociateFileSystemAliasesResult> |
disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest disassociateFileSystemAliasesRequest)
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 disassociateFileSystemAliasesRequest,
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.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Tags an Amazon FSx resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tags an Amazon FSx resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
This action removes a tag from an Amazon FSx resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
This action removes a tag from an Amazon FSx resource.
|
Future<UpdateFileSystemResult> |
updateFileSystemAsync(UpdateFileSystemRequest updateFileSystemRequest)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
Future<UpdateFileSystemResult> |
updateFileSystemAsync(UpdateFileSystemRequest updateFileSystemRequest,
AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResult> asyncHandler)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
associateFileSystemAliases, cancelDataRepositoryTask, createBackup, createDataRepositoryTask, createFileSystem, createFileSystemFromBackup, deleteBackup, deleteFileSystem, describeBackups, describeDataRepositoryTasks, describeFileSystemAliases, describeFileSystems, disassociateFileSystemAliases, getCachedResponseMetadata, listTagsForResource, shutdown, tagResource, untagResource, updateFileSystemFuture<AssociateFileSystemAliasesResult> associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest associateFileSystemAliasesRequest)
Use 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 systen 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.
associateFileSystemAliasesRequest - The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File
Server file system.Future<AssociateFileSystemAliasesResult> associateFileSystemAliasesAsync(AssociateFileSystemAliasesRequest associateFileSystemAliasesRequest, 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. A file systen 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.
associateFileSystemAliasesRequest - 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.Future<CancelDataRepositoryTaskResult> cancelDataRepositoryTaskAsync(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.
cancelDataRepositoryTaskRequest - Cancels a data repository task.Future<CancelDataRepositoryTaskResult> cancelDataRepositoryTaskAsync(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest, 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. 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.
cancelDataRepositoryTaskRequest - 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.Future<CreateBackupResult> createBackupAsync(CreateBackupRequest createBackupRequest)
Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.
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 respository.
For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups.
For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows 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.
createBackupRequest - The request object for the CreateBackup operation.Future<CreateBackupResult> createBackupAsync(CreateBackupRequest createBackupRequest, AsyncHandler<CreateBackupRequest,CreateBackupResult> asyncHandler)
Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.
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 respository.
For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups.
For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows 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.
createBackupRequest - 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.Future<CreateDataRepositoryTaskResult> createDataRepositoryTaskAsync(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 Data Repository Tasks.
To learn more about linking a data repository to your file system, see Linking your file
system to an S3 bucket.
createDataRepositoryTaskRequest - Future<CreateDataRepositoryTaskResult> createDataRepositoryTaskAsync(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest, AsyncHandler<CreateDataRepositoryTaskRequest,CreateDataRepositoryTaskResult> asyncHandler)
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.
createDataRepositoryTaskRequest - 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.Future<CreateFileSystemResult> createFileSystemAsync(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.
createFileSystemRequest - The request object used to create a new Amazon FSx file system.Future<CreateFileSystemResult> createFileSystemAsync(CreateFileSystemRequest createFileSystemRequest, AsyncHandler<CreateFileSystemRequest,CreateFileSystemResult> asyncHandler)
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.
createFileSystemRequest - 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.Future<CreateFileSystemFromBackupResult> createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
Creates a new Amazon FSx 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.
createFileSystemFromBackupRequest - The request object for the CreateFileSystemFromBackup operation.Future<CreateFileSystemFromBackupResult> createFileSystemFromBackupAsync(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest, AsyncHandler<CreateFileSystemFromBackupRequest,CreateFileSystemFromBackupResult> asyncHandler)
Creates a new Amazon FSx 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.
createFileSystemFromBackupRequest - 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.Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest deleteBackupRequest)
Deletes 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.
deleteBackupRequest - The request object for DeleteBackup operation.Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest deleteBackupRequest, AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler)
Deletes 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.
deleteBackupRequest - 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.Future<DeleteFileSystemResult> deleteFileSystemAsync(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.
deleteFileSystemRequest - The request object for DeleteFileSystem operation.Future<DeleteFileSystemResult> deleteFileSystemAsync(DeleteFileSystemRequest deleteFileSystemRequest, AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResult> asyncHandler)
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.
deleteFileSystemRequest - 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.Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest)
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 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.
describeBackupsRequest - The request object for DescribeBackups operation.Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest, AsyncHandler<DescribeBackupsRequest,DescribeBackupsResult> asyncHandler)
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 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.
describeBackupsRequest - 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.Future<DescribeDataRepositoryTasksResult> describeDataRepositoryTasksAsync(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.
describeDataRepositoryTasksRequest - Future<DescribeDataRepositoryTasksResult> describeDataRepositoryTasksAsync(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest, 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. 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.
describeDataRepositoryTasksRequest - 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.Future<DescribeFileSystemAliasesResult> describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest)
Returns 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.
describeFileSystemAliasesRequest - The request object for DescribeFileSystemAliases operation.Future<DescribeFileSystemAliasesResult> describeFileSystemAliasesAsync(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest, AsyncHandler<DescribeFileSystemAliasesRequest,DescribeFileSystemAliasesResult> asyncHandler)
Returns 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.
describeFileSystemAliasesRequest - 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.Future<DescribeFileSystemsResult> describeFileSystemsAsync(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.
describeFileSystemsRequest - The request object for DescribeFileSystems operation.Future<DescribeFileSystemsResult> describeFileSystemsAsync(DescribeFileSystemsRequest describeFileSystemsRequest, AsyncHandler<DescribeFileSystemsRequest,DescribeFileSystemsResult> asyncHandler)
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.
describeFileSystemsRequest - 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.Future<DisassociateFileSystemAliasesResult> disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest disassociateFileSystemAliasesRequest)
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. 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.
disassociateFileSystemAliasesRequest - The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.Future<DisassociateFileSystemAliasesResult> disassociateFileSystemAliasesAsync(DisassociateFileSystemAliasesRequest disassociateFileSystemAliasesRequest, 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. 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.
disassociateFileSystemAliasesRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(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.
listTagsForResourceRequest - The request object for ListTagsForResource operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
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.
listTagsForResourceRequest - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Tags an Amazon FSx resource.
tagResourceRequest - The request object for the TagResource operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tags an Amazon FSx resource.
tagResourceRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
This action removes a tag from an Amazon FSx resource.
untagResourceRequest - The request object for UntagResource action.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
This action removes a tag from an Amazon FSx resource.
untagResourceRequest - 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.Future<UpdateFileSystemResult> updateFileSystemAsync(UpdateFileSystemRequest updateFileSystemRequest)
Use 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:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
StorageCapacity
WeeklyMaintenanceStartTime
updateFileSystemRequest - The request object for the UpdateFileSystem operation.Future<UpdateFileSystemResult> updateFileSystemAsync(UpdateFileSystemRequest updateFileSystemRequest, AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResult> asyncHandler)
Use 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:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
StorageCapacity
WeeklyMaintenanceStartTime
updateFileSystemRequest - 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.