@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_NAME |
| Modifier and Type | Method and Description |
|---|---|
static FSxAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
FSxAsyncClient. |
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 for Windows File Server file system.
|
default CompletableFuture<CreateBackupResponse> |
createBackup(CreateBackupRequest createBackupRequest)
Creates a backup of an existing Amazon FSx for Windows File Server file system.
|
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 for Windows File Server backup.
|
default CompletableFuture<CreateFileSystemFromBackupResponse> |
createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
|
default CompletableFuture<DeleteBackupResponse> |
deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes an Amazon FSx for Windows File Server backup, deleting its contents.
|
default CompletableFuture<DeleteBackupResponse> |
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes an Amazon FSx for Windows File Server 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 for Windows File Server 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 for Windows File Server backups, if a
BackupIds value
is provided for that backup. |
default CompletableFuture<DescribeBackupsResponse> |
describeBackups(DescribeBackupsRequest describeBackupsRequest)
Returns the description of specific Amazon FSx for Windows File Server backups, if a
BackupIds value
is provided for that backup. |
default DescribeBackupsPublisher |
describeBackupsPaginator()
Returns the description of specific Amazon FSx for Windows File Server backups, if a
BackupIds value
is provided for that backup. |
default DescribeBackupsPublisher |
describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Returns the description of specific Amazon FSx for Windows File Server backups, if a
BackupIds value
is provided for that backup. |
default DescribeBackupsPublisher |
describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)
Returns the description of specific Amazon FSx for Windows File Server backups, if a
BackupIds value
is provided for that backup. |
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<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)
Updates a file system configuration.
|
default CompletableFuture<UpdateFileSystemResponse> |
updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Updates a file system configuration.
|
serviceNameclosestatic final String SERVICE_NAME
static FSxAsyncClient create()
FSxAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static FSxAsyncClientBuilder builder()
FSxAsyncClient.default CompletableFuture<CreateBackupResponse> createBackup(CreateBackupRequest createBackupRequest)
Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.
If a backup with the specified client request token exists, and the parameters match, this operation returns the
description of the existing backup. If a backup specified client request token exists, and the parameters don't
match, this operation returns IncompatibleParameterError. If a backup with the specified client
request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of
creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear
whether a backup was created. If you use the same client request token and the initial call created a backup, the
operation returns a successful result because all the parameters are the same.
The CreateFileSystem operation returns while the backup's lifecycle state is still
CREATING. You can check the file system creation status by calling the DescribeBackups
operation, which returns the backup state along with other information.
createBackupRequest - The request object for the CreateBackup operation.default CompletableFuture<CreateBackupResponse> createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.
If a backup with the specified client request token exists, and the parameters match, this operation returns the
description of the existing backup. If a backup specified client request token exists, and the parameters don't
match, this operation returns IncompatibleParameterError. If a backup with the specified client
request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of
creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear
whether a backup was created. If you use the same client request token and the initial call created a backup, the
operation returns a successful result because all the parameters are the same.
The CreateFileSystem operation returns while the backup's lifecycle state is still
CREATING. You can check the file system creation status by calling the DescribeBackups
operation, which returns the backup state along with other information.
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<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 for the CreateFileSystem 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.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 for the CreateFileSystem 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.default CompletableFuture<CreateFileSystemFromBackupResponse> createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
If a file system with the specified client request token exists and the parameters match, this call returns the
description of the existing 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.default CompletableFuture<CreateFileSystemFromBackupResponse> createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> createFileSystemFromBackupRequest)
Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
If a file system with the specified client request token exists and the parameters match, this call returns the
description of the existing 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.default CompletableFuture<DeleteBackupResponse> deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup will not show up in later
DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
deleteBackupRequest - The request object for DeleteBackup operation.default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup will not show up in later
DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
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.
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.
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 for Windows File Server backups, if a BackupIds value
is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups
returned across the responses of a multi-call iteration is unspecified.
describeBackupsRequest - The request object for DescribeBackups operation.default CompletableFuture<DescribeBackupsResponse> describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value
is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups
returned across the responses of a multi-call iteration is unspecified.
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 for Windows File Server backups, if a BackupIds value
is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups
returned across the responses of a multi-call iteration is unspecified.
default DescribeBackupsPublisher describeBackupsPaginator()
Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value
is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups
returned across the responses of a multi-call iteration is unspecified.
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.
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 for Windows File Server backups, if a BackupIds value
is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups
returned across the responses of a multi-call iteration is unspecified.
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.
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 for Windows File Server backups, if a BackupIds value
is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups
returned across the responses of a multi-call iteration is unspecified.
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.
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<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 NextTokenvalue. Then the action continues
to be called with the NextToken parameter set to the value of the last NextToken value
until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
describeFileSystemsRequest - The request object for DescribeFileSystems operation.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 NextTokenvalue. Then the action continues
to be called with the NextToken parameter set to the value of the last NextToken value
until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
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 NextTokenvalue. Then the action continues
to be called with the NextToken parameter set to the value of the last NextToken value
until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
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 NextTokenvalue. Then the action continues
to be called with the NextToken parameter set to the value of the last NextToken value
until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
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.
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 NextTokenvalue. Then the action continues
to be called with the NextToken parameter set to the value of the last NextToken value
until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
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.
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 NextTokenvalue. Then the action continues
to be called with the NextToken parameter set to the value of the last NextToken value
until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
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.
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<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 NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags
returned across the responses of a multi-call iteration is unspecified.
listTagsForResourceRequest - The request object for ListTagsForResource operation.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 NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags
returned across the responses of a multi-call iteration is unspecified.
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)
Updates a file system configuration.
updateFileSystemRequest - The request object for the UpdateFileSystem operation.default CompletableFuture<UpdateFileSystemResponse> updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
Updates a file system configuration.
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.