@Generated(value="software.amazon.awssdk:codegen") public interface FSxAsyncClient extends SdkClient
builder()
method.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateFileSystemAliasesResponse> |
associateFileSystemAliases(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.
|
default CompletableFuture<AssociateFileSystemAliasesResponse> |
associateFileSystemAliases(Consumer<AssociateFileSystemAliasesRequest.Builder> 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.
|
static FSxAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
FSxAsyncClient . |
default CompletableFuture<CancelDataRepositoryTaskResponse> |
cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING state. |
default CompletableFuture<CancelDataRepositoryTaskResponse> |
cancelDataRepositoryTask(Consumer<CancelDataRepositoryTaskRequest.Builder> cancelDataRepositoryTaskRequest)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING state. |
default CompletableFuture<CopyBackupResponse> |
copyBackup(Consumer<CopyBackupRequest.Builder> copyBackupRequest)
Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same
Region (in-Region copy).
|
default CompletableFuture<CopyBackupResponse> |
copyBackup(CopyBackupRequest copyBackupRequest)
Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same
Region (in-Region copy).
|
static FSxAsyncClient |
create()
Create a
FSxAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateBackupResponse> |
createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
Creates a backup of an existing Amazon FSx file system.
|
default CompletableFuture<CreateBackupResponse> |
createBackup(CreateBackupRequest createBackupRequest)
Creates a backup of an existing Amazon FSx file system.
|
default CompletableFuture<CreateDataRepositoryTaskResponse> |
createDataRepositoryTask(Consumer<CreateDataRepositoryTaskRequest.Builder> createDataRepositoryTaskRequest)
Creates an Amazon FSx for Lustre data repository task.
|
default CompletableFuture<CreateDataRepositoryTaskResponse> |
createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest)
Creates an Amazon FSx for Lustre data repository task.
|
default CompletableFuture<CreateFileSystemResponse> |
createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)
Creates a new, empty Amazon FSx file system.
|
default CompletableFuture<CreateFileSystemResponse> |
createFileSystem(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty Amazon FSx file system.
|
default CompletableFuture<CreateFileSystemFromBackupResponse> |
createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> createFileSystemFromBackupRequest)
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
|
default CompletableFuture<CreateFileSystemFromBackupResponse> |
createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
|
default CompletableFuture<DeleteBackupResponse> |
deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes an Amazon FSx backup, deleting its contents.
|
default CompletableFuture<DeleteBackupResponse> |
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes an Amazon FSx backup, deleting its contents.
|
default CompletableFuture<DeleteFileSystemResponse> |
deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)
Deletes a file system, deleting its contents.
|
default CompletableFuture<DeleteFileSystemResponse> |
deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, deleting its contents.
|
default CompletableFuture<DescribeBackupsResponse> |
describeBackups()
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
default CompletableFuture<DescribeBackupsResponse> |
describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
default CompletableFuture<DescribeBackupsResponse> |
describeBackups(DescribeBackupsRequest describeBackupsRequest)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsPublisher |
describeBackupsPaginator()
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsPublisher |
describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsPublisher |
describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)
Returns the description of specific Amazon FSx backups, if a
BackupIds value is provided for that
backup. |
default CompletableFuture<DescribeDataRepositoryTasksResponse> |
describeDataRepositoryTasks(Consumer<DescribeDataRepositoryTasksRequest.Builder> 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. |
default CompletableFuture<DescribeDataRepositoryTasksResponse> |
describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)
Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more
TaskIds values are provided in the request, or if filters are used in the request. |
default DescribeDataRepositoryTasksPublisher |
describeDataRepositoryTasksPaginator(Consumer<DescribeDataRepositoryTasksRequest.Builder> 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. |
default DescribeDataRepositoryTasksPublisher |
describeDataRepositoryTasksPaginator(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. |
default CompletableFuture<DescribeFileSystemAliasesResponse> |
describeFileSystemAliases(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default CompletableFuture<DescribeFileSystemAliasesResponse> |
describeFileSystemAliases(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default DescribeFileSystemAliasesPublisher |
describeFileSystemAliasesPaginator(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default DescribeFileSystemAliasesPublisher |
describeFileSystemAliasesPaginator(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default CompletableFuture<DescribeFileSystemsResponse> |
describeFileSystems()
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
default CompletableFuture<DescribeFileSystemsResponse> |
describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
default CompletableFuture<DescribeFileSystemsResponse> |
describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
default DescribeFileSystemsPublisher |
describeFileSystemsPaginator()
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
default DescribeFileSystemsPublisher |
describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
default DescribeFileSystemsPublisher |
describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided
for that file system. |
default CompletableFuture<DisassociateFileSystemAliasesResponse> |
disassociateFileSystemAliases(Consumer<DisassociateFileSystemAliasesRequest.Builder> 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.
|
default CompletableFuture<DisassociateFileSystemAliasesResponse> |
disassociateFileSystemAliases(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.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags an Amazon FSx resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Tags an Amazon FSx resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
This action removes a tag from an Amazon FSx resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
This action removes a tag from an Amazon FSx resource.
|
default CompletableFuture<UpdateFileSystemResponse> |
updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
default CompletableFuture<UpdateFileSystemResponse> |
updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static FSxAsyncClient create()
FSxAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static FSxAsyncClientBuilder builder()
FSxAsyncClient
.default CompletableFuture<AssociateFileSystemAliasesResponse> associateFileSystemAliases(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.default CompletableFuture<AssociateFileSystemAliasesResponse> associateFileSystemAliases(Consumer<AssociateFileSystemAliasesRequest.Builder> 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.
This is a convenience which creates an instance of the AssociateFileSystemAliasesRequest.Builder
avoiding
the need to create one manually via AssociateFileSystemAliasesRequest.builder()
associateFileSystemAliasesRequest
- A Consumer
that will call methods on AssociateFileSystemAliasesRequest.Builder
to create a
request. The request object specifying one or more DNS alias names to associate with an Amazon FSx for
Windows File Server file system.default CompletableFuture<CancelDataRepositoryTaskResponse> cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING
or EXECUTING
state. When you cancel a task, Amazon FSx does the following.
Any files that FSx has already exported are not reverted.
FSx continues to export any files that are "in-flight" when the cancel operation is received.
FSx does not export any files that have not yet been exported.
cancelDataRepositoryTaskRequest
- Cancels a data repository task.default CompletableFuture<CancelDataRepositoryTaskResponse> cancelDataRepositoryTask(Consumer<CancelDataRepositoryTaskRequest.Builder> 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.
This is a convenience which creates an instance of the CancelDataRepositoryTaskRequest.Builder
avoiding
the need to create one manually via CancelDataRepositoryTaskRequest.builder()
cancelDataRepositoryTaskRequest
- A Consumer
that will call methods on CancelDataRepositoryTaskRequest.Builder
to create a
request. Cancels a data repository task.default CompletableFuture<CopyBackupResponse> copyBackup(CopyBackupRequest copyBackupRequest)
Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same 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 AWS 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 AWS 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.
copyBackupRequest
- Source Region
is invalid or is in a
different AWS partition.AVAILABLE
.default CompletableFuture<CopyBackupResponse> copyBackup(Consumer<CopyBackupRequest.Builder> copyBackupRequest)
Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same 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 AWS 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 AWS 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.
This is a convenience which creates an instance of the CopyBackupRequest.Builder
avoiding the need to
create one manually via CopyBackupRequest.builder()
copyBackupRequest
- A Consumer
that will call methods on CopyBackupRequest.Builder
to create a request.Source Region
is invalid or is in a
different AWS partition.AVAILABLE
.default CompletableFuture<CreateBackupResponse> createBackup(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.default CompletableFuture<CreateBackupResponse> createBackup(Consumer<CreateBackupRequest.Builder> 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.
This is a convenience which creates an instance of the CreateBackupRequest.Builder
avoiding the need to
create one manually via CreateBackupRequest.builder()
createBackupRequest
- A Consumer
that will call methods on CreateBackupRequest.Builder
to create a request. The
request object for the CreateBackup
operation.default CompletableFuture<CreateDataRepositoryTaskResponse> createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest)
Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations
between your Amazon FSx file system and its linked data repository. An example of a data repository task is
exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links
(symlinks) from your FSx file system to its linked data repository. A CreateDataRepositoryTask
operation will fail if a data repository is not linked to the FSx file system. To learn more about data
repository tasks, see 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
- default CompletableFuture<CreateDataRepositoryTaskResponse> createDataRepositoryTask(Consumer<CreateDataRepositoryTaskRequest.Builder> 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.
This is a convenience which creates an instance of the CreateDataRepositoryTaskRequest.Builder
avoiding
the need to create one manually via CreateDataRepositoryTaskRequest.builder()
createDataRepositoryTaskRequest
- A Consumer
that will call methods on CreateDataRepositoryTaskRequest.Builder
to create a
request.default CompletableFuture<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest createFileSystemRequest)
Creates a new, empty Amazon FSx file system.
If a file system with the specified client request token exists and the parameters match,
CreateFileSystem
returns the description of the existing file system. If a file system specified
client request token exists and the parameters don't match, this call returns
IncompatibleParameterError
. If a file system with the specified client request token doesn't exist,
CreateFileSystem
does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of
CREATING
.
Returns the description of the file system.
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation.
This means that calling the operation multiple times with the same client request token has no effect. By using
the idempotent operation, you can retry a CreateFileSystem
operation without the risk of creating an
extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether
a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If
you use the same client request token and the initial call created a file system, the client receives success as
long as the parameters are the same.
The CreateFileSystem
call returns while the file system's lifecycle state is still
CREATING
. You can check the file-system creation status by calling the DescribeFileSystems
operation, which returns the file system state along with other information.
createFileSystemRequest
- The request object used to create a new Amazon FSx file system.InvalidVpcId
means that the ID passed for the virtual private cloud (VPC) is invalid.
InvalidSubnetIds
returns the list of IDs for subnets that are either invalid or not part of
the VPC specified. InvalidSecurityGroupIds
returns the list of IDs for security groups that
are either invalid or not part of the VPC specified.PerUnitStorageThroughput
was provided. Please create your file system again, using a valid value.default CompletableFuture<CreateFileSystemResponse> createFileSystem(Consumer<CreateFileSystemRequest.Builder> 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.
This is a convenience which creates an instance of the CreateFileSystemRequest.Builder
avoiding the need
to create one manually via CreateFileSystemRequest.builder()
createFileSystemRequest
- A Consumer
that will call methods on CreateFileSystemRequest.Builder
to create a request.
The request object used to create a new Amazon FSx file system.InvalidVpcId
means that the ID passed for the virtual private cloud (VPC) is invalid.
InvalidSubnetIds
returns the list of IDs for subnets that are either invalid or not part of
the VPC specified. InvalidSecurityGroupIds
returns the list of IDs for security groups that
are either invalid or not part of the VPC specified.PerUnitStorageThroughput
was provided. Please create your file system again, using a valid value.default CompletableFuture<CreateFileSystemFromBackupResponse> createFileSystemFromBackup(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.InvalidVpcId
means that the ID passed for the virtual private cloud (VPC) is invalid.
InvalidSubnetIds
returns the list of IDs for subnets that are either invalid or not part of
the VPC specified. InvalidSecurityGroupIds
returns the list of IDs for security groups that
are either invalid or not part of the VPC specified.PerUnitStorageThroughput
was provided. Please create your file system again, using a valid value.default CompletableFuture<CreateFileSystemFromBackupResponse> createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> 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.
This is a convenience which creates an instance of the CreateFileSystemFromBackupRequest.Builder
avoiding
the need to create one manually via CreateFileSystemFromBackupRequest.builder()
createFileSystemFromBackupRequest
- A Consumer
that will call methods on CreateFileSystemFromBackupRequest.Builder
to create a
request. The request object for the CreateFileSystemFromBackup
operation.InvalidVpcId
means that the ID passed for the virtual private cloud (VPC) is invalid.
InvalidSubnetIds
returns the list of IDs for subnets that are either invalid or not part of
the VPC specified. InvalidSecurityGroupIds
returns the list of IDs for security groups that
are either invalid or not part of the VPC specified.PerUnitStorageThroughput
was provided. Please create your file system again, using a valid value.default CompletableFuture<DeleteBackupResponse> deleteBackup(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.default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteBackupRequest.Builder
avoiding the need to
create one manually via DeleteBackupRequest.builder()
deleteBackupRequest
- A Consumer
that will call methods on DeleteBackupRequest.Builder
to create a request. The
request object for DeleteBackup
operation.default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem
action returns while the file system has the DELETING
status. You
can check the file system deletion status by calling the DescribeFileSystems action, which returns a list
of file systems in your account. If you pass the file system ID for a deleted file system, the
DescribeFileSystems returns a FileSystemNotFound
error.
Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a
PENDING
or EXECUTING
state.
The data in a deleted file system is also deleted and can't be recovered by any means.
deleteFileSystemRequest
- The request object for DeleteFileSystem
operation.default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteFileSystemRequest.Builder
avoiding the need
to create one manually via DeleteFileSystemRequest.builder()
deleteFileSystemRequest
- A Consumer
that will call methods on DeleteFileSystemRequest.Builder
to create a request.
The request object for DeleteFileSystem
operation.default CompletableFuture<DescribeBackupsResponse> describeBackups(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 NextToken
value. 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.default CompletableFuture<DescribeBackupsResponse> describeBackups(Consumer<DescribeBackupsRequest.Builder> 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 NextToken
value. 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.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder
avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest
- A Consumer
that will call methods on DescribeBackupsRequest.Builder
to create a request.
The request object for DescribeBackups
operation.default CompletableFuture<DescribeBackupsResponse> describeBackups()
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 NextToken
value. 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.
default DescribeBackupsPublisher describeBackupsPaginator()
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 NextToken
value. 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.
This is a variant of describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest)
operation.
default DescribeBackupsPublisher describeBackupsPaginator(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 NextToken
value. 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.
This is a variant of describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest)
operation.
describeBackupsRequest
- The request object for DescribeBackups
operation.default DescribeBackupsPublisher describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> 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 NextToken
value. 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.
This is a variant of describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest)
operation.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder
avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest
- A Consumer
that will call methods on DescribeBackupsRequest.Builder
to create a request.
The request object for DescribeBackups
operation.default CompletableFuture<DescribeDataRepositoryTasksResponse> describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)
Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more
TaskIds
values are provided in the request, or if filters are used in the request. You can use
filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle
state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults
parameter
to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a
NextToken
value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken
from the last response.
describeDataRepositoryTasksRequest
- default CompletableFuture<DescribeDataRepositoryTasksResponse> describeDataRepositoryTasks(Consumer<DescribeDataRepositoryTasksRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeDataRepositoryTasksRequest.Builder
avoiding the need to create one manually via DescribeDataRepositoryTasksRequest.builder()
describeDataRepositoryTasksRequest
- A Consumer
that will call methods on DescribeDataRepositoryTasksRequest.Builder
to create
a request.default DescribeDataRepositoryTasksPublisher describeDataRepositoryTasksPaginator(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.
This is a variant of
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksPublisher publisher = client.describeDataRepositoryTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksPublisher publisher = client.describeDataRepositoryTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
operation.
describeDataRepositoryTasksRequest
- default DescribeDataRepositoryTasksPublisher describeDataRepositoryTasksPaginator(Consumer<DescribeDataRepositoryTasksRequest.Builder> 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.
This is a variant of
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksPublisher publisher = client.describeDataRepositoryTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksPublisher publisher = client.describeDataRepositoryTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
operation.
This is a convenience which creates an instance of the DescribeDataRepositoryTasksRequest.Builder
avoiding the need to create one manually via DescribeDataRepositoryTasksRequest.builder()
describeDataRepositoryTasksRequest
- A Consumer
that will call methods on DescribeDataRepositoryTasksRequest.Builder
to create
a request.default CompletableFuture<DescribeFileSystemAliasesResponse> describeFileSystemAliases(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.default CompletableFuture<DescribeFileSystemAliasesResponse> describeFileSystemAliases(Consumer<DescribeFileSystemAliasesRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeFileSystemAliasesRequest.Builder
avoiding
the need to create one manually via DescribeFileSystemAliasesRequest.builder()
describeFileSystemAliasesRequest
- A Consumer
that will call methods on DescribeFileSystemAliasesRequest.Builder
to create a
request. The request object for DescribeFileSystemAliases
operation.default DescribeFileSystemAliasesPublisher describeFileSystemAliasesPaginator(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.
This is a variant of
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesPublisher publisher = client.describeFileSystemAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesPublisher publisher = client.describeFileSystemAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation.
describeFileSystemAliasesRequest
- The request object for DescribeFileSystemAliases
operation.default DescribeFileSystemAliasesPublisher describeFileSystemAliasesPaginator(Consumer<DescribeFileSystemAliasesRequest.Builder> 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.
This is a variant of
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesPublisher publisher = client.describeFileSystemAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesPublisher publisher = client.describeFileSystemAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation.
This is a convenience which creates an instance of the DescribeFileSystemAliasesRequest.Builder
avoiding
the need to create one manually via DescribeFileSystemAliasesRequest.builder()
describeFileSystemAliasesRequest
- A Consumer
that will call methods on DescribeFileSystemAliasesRequest.Builder
to create a
request. The request object for DescribeFileSystemAliases
operation.default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)
Returns the description of specific Amazon FSx file systems, if a FileSystemIds
value is provided
for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS
Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults
parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken
value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken
from the last response.
This action is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems
is called first without a NextToken
value. 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.default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> 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 NextToken
value. 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.
This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder
avoiding the
need to create one manually via DescribeFileSystemsRequest.builder()
describeFileSystemsRequest
- A Consumer
that will call methods on DescribeFileSystemsRequest.Builder
to create a
request. The request object for DescribeFileSystems
operation.default CompletableFuture<DescribeFileSystemsResponse> describeFileSystems()
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 NextToken
value. 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.
default DescribeFileSystemsPublisher describeFileSystemsPaginator()
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 NextToken
value. 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.
This is a variant of
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest)
operation.
default DescribeFileSystemsPublisher describeFileSystemsPaginator(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 NextToken
value. 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.
This is a variant of
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest)
operation.
describeFileSystemsRequest
- The request object for DescribeFileSystems
operation.default DescribeFileSystemsPublisher describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> 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 NextToken
value. 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.
This is a variant of
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsPublisher publisher = client.describeFileSystemsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest)
operation.
This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder
avoiding the
need to create one manually via DescribeFileSystemsRequest.builder()
describeFileSystemsRequest
- A Consumer
that will call methods on DescribeFileSystemsRequest.Builder
to create a
request. The request object for DescribeFileSystems
operation.default CompletableFuture<DisassociateFileSystemAliasesResponse> disassociateFileSystemAliases(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.default CompletableFuture<DisassociateFileSystemAliasesResponse> disassociateFileSystemAliases(Consumer<DisassociateFileSystemAliasesRequest.Builder> 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.
This is a convenience which creates an instance of the DisassociateFileSystemAliasesRequest.Builder
avoiding the need to create one manually via DisassociateFileSystemAliasesRequest.builder()
disassociateFileSystemAliasesRequest
- A Consumer
that will call methods on DisassociateFileSystemAliasesRequest.Builder
to
create a request. The request object of DNS aliases to disassociate from an Amazon FSx for Windows File
Server file system.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
When retrieving all tags, you can optionally specify the MaxResults
parameter to limit the number of
tags in a response. If more tags remain, Amazon FSx returns a NextToken
value in the response. In
this case, send a later request with the NextToken
request parameter set to the value of
NextToken
from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource
is
called first without a NextToken
value. 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.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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 NextToken
value. 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.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request. The request object for ListTagsForResource
operation.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tags an Amazon FSx resource.
tagResourceRequest
- The request object for the TagResource
operation.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags an Amazon FSx resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request. The
request object for the TagResource
operation.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
This action removes a tag from an Amazon FSx resource.
untagResourceRequest
- The request object for UntagResource
action.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
This action removes a tag from an Amazon FSx resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request. The
request object for UntagResource
action.default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(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.default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> 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
This is a convenience which creates an instance of the UpdateFileSystemRequest.Builder
avoiding the need
to create one manually via UpdateFileSystemRequest.builder()
updateFileSystemRequest
- A Consumer
that will call methods on UpdateFileSystemRequest.Builder
to create a request.
The request object for the UpdateFileSystem
operation.