Package software.amazon.awssdk.services.fsx

Interface FSxAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface FSxAsyncClient extends AwsClient
Service client for accessing Amazon FSx asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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

  • Field Details

  • Method Details

    • associateFileSystemAliases

      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 system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

      The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

      Parameters:
      associateFileSystemAliasesRequest - The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
      Returns:
      A Java Future containing the result of the AssociateFileSystemAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateFileSystemAliases

      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 system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

      The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.


      This is a convenience which creates an instance of the AssociateFileSystemAliasesRequest.Builder avoiding the need to create one manually via AssociateFileSystemAliasesRequest.builder()

      Parameters:
      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.
      Returns:
      A Java Future containing the result of the AssociateFileSystemAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelDataRepositoryTask

      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 am export 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.

      For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.

      Parameters:
      cancelDataRepositoryTaskRequest - Cancels a data repository task.
      Returns:
      A Java Future containing the result of the CancelDataRepositoryTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • DataRepositoryTaskNotFoundException The data repository task or tasks you specified could not be found.
      • DataRepositoryTaskEndedException The data repository task could not be canceled because the task has already ended.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelDataRepositoryTask

      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 am export 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.

      For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.


      This is a convenience which creates an instance of the CancelDataRepositoryTaskRequest.Builder avoiding the need to create one manually via CancelDataRepositoryTaskRequest.builder()

      Parameters:
      cancelDataRepositoryTaskRequest - A Consumer that will call methods on CancelDataRepositoryTaskRequest.Builder to create a request. Cancels a data repository task.
      Returns:
      A Java Future containing the result of the CancelDataRepositoryTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • DataRepositoryTaskNotFoundException The data repository task or tasks you specified could not be found.
      • DataRepositoryTaskEndedException The data repository task could not be canceled because the task has already ended.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copyBackup

      default CompletableFuture<CopyBackupResponse> copyBackup(CopyBackupRequest copyBackupRequest)

      Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). 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 can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

      You can also use backup copies to clone your file dataset to another Region or within the same Region.

      You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

      For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.

      Parameters:
      copyBackupRequest -
      Returns:
      A Java Future containing the result of the CopyBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • InvalidSourceKmsKeyException The Key Management Service (KMS) key of the source backup is not valid.
      • InvalidDestinationKmsKeyException The Key Management Service (KMS) key of the destination backup is not valid.
      • InvalidRegionException The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.
      • SourceBackupUnavailableException The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.
      • IncompatibleRegionForMultiAzException Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copyBackup

      default CompletableFuture<CopyBackupResponse> copyBackup(Consumer<CopyBackupRequest.Builder> copyBackupRequest)

      Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). 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 can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

      You can also use backup copies to clone your file dataset to another Region or within the same Region.

      You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

      For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.


      This is a convenience which creates an instance of the CopyBackupRequest.Builder avoiding the need to create one manually via CopyBackupRequest.builder()

      Parameters:
      copyBackupRequest - A Consumer that will call methods on CopyBackupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopyBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • InvalidSourceKmsKeyException The Key Management Service (KMS) key of the source backup is not valid.
      • InvalidDestinationKmsKeyException The Key Management Service (KMS) key of the destination backup is not valid.
      • InvalidRegionException The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.
      • SourceBackupUnavailableException The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.
      • IncompatibleRegionForMultiAzException Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copySnapshotAndUpdateVolume

      default CompletableFuture<CopySnapshotAndUpdateVolumeResponse> copySnapshotAndUpdateVolume(CopySnapshotAndUpdateVolumeRequest copySnapshotAndUpdateVolumeRequest)

      Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.

      Parameters:
      copySnapshotAndUpdateVolumeRequest -
      Returns:
      A Java Future containing the result of the CopySnapshotAndUpdateVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copySnapshotAndUpdateVolume

      default CompletableFuture<CopySnapshotAndUpdateVolumeResponse> copySnapshotAndUpdateVolume(Consumer<CopySnapshotAndUpdateVolumeRequest.Builder> copySnapshotAndUpdateVolumeRequest)

      Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.


      This is a convenience which creates an instance of the CopySnapshotAndUpdateVolumeRequest.Builder avoiding the need to create one manually via CopySnapshotAndUpdateVolumeRequest.builder()

      Parameters:
      copySnapshotAndUpdateVolumeRequest - A Consumer that will call methods on CopySnapshotAndUpdateVolumeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopySnapshotAndUpdateVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackup

      default CompletableFuture<CreateBackupResponse> createBackup(CreateBackupRequest createBackupRequest)

      Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

      For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

      • A Persistent deployment type

      • Are not linked to a data repository

      For more information about backups, see the following:

      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 with the 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.

      Parameters:
      createBackupRequest - The request object for the CreateBackup operation.
      Returns:
      A Java Future containing the result of the CreateBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupInProgressException Another backup is already under way. Wait for completion before initiating additional backups of this file system.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBackup

      default CompletableFuture<CreateBackupResponse> createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)

      Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

      For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

      • A Persistent deployment type

      • Are not linked to a data repository

      For more information about backups, see the following:

      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 with the 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()

      Parameters:
      createBackupRequest - A Consumer that will call methods on CreateBackupRequest.Builder to create a request. The request object for the CreateBackup operation.
      Returns:
      A Java Future containing the result of the CreateBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupInProgressException Another backup is already under way. Wait for completion before initiating additional backups of this file system.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataRepositoryAssociation

      default CompletableFuture<CreateDataRepositoryAssociationResponse> createDataRepositoryAssociation(CreateDataRepositoryAssociationRequest createDataRepositoryAssociationRequest)

      Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

      Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

      CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

      Parameters:
      createDataRepositoryAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateDataRepositoryAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataRepositoryAssociation

      default CompletableFuture<CreateDataRepositoryAssociationResponse> createDataRepositoryAssociation(Consumer<CreateDataRepositoryAssociationRequest.Builder> createDataRepositoryAssociationRequest)

      Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

      Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

      CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.


      This is a convenience which creates an instance of the CreateDataRepositoryAssociationRequest.Builder avoiding the need to create one manually via CreateDataRepositoryAssociationRequest.builder()

      Parameters:
      createDataRepositoryAssociationRequest - A Consumer that will call methods on CreateDataRepositoryAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataRepositoryAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataRepositoryTask

      default CompletableFuture<CreateDataRepositoryTaskResponse> createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest)

      Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.

      You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. 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 a linked data repository.

      You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre 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.

      Parameters:
      createDataRepositoryTaskRequest -
      Returns:
      A Java Future containing the result of the CreateDataRepositoryTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • DataRepositoryTaskExecutingException An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataRepositoryTask

      default CompletableFuture<CreateDataRepositoryTaskResponse> createDataRepositoryTask(Consumer<CreateDataRepositoryTaskRequest.Builder> createDataRepositoryTaskRequest)

      Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.

      You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. 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 a linked data repository.

      You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre 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()

      Parameters:
      createDataRepositoryTaskRequest - A Consumer that will call methods on CreateDataRepositoryTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataRepositoryTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • DataRepositoryTaskExecutingException An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileCache

      default CompletableFuture<CreateFileCacheResponse> createFileCache(CreateFileCacheRequest createFileCacheRequest)

      Creates a new Amazon File Cache resource.

      You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

      • Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.

      • Returns the description of the cache in JSON format.

      The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.

      Parameters:
      createFileCacheRequest -
      Returns:
      A Java Future containing the result of the CreateFileCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingFileCacheConfigurationException A cache configuration is required for this operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileCache

      default CompletableFuture<CreateFileCacheResponse> createFileCache(Consumer<CreateFileCacheRequest.Builder> createFileCacheRequest)

      Creates a new Amazon File Cache resource.

      You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

      • Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.

      • Returns the description of the cache in JSON format.

      The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.


      This is a convenience which creates an instance of the CreateFileCacheRequest.Builder avoiding the need to create one manually via CreateFileCacheRequest.builder()

      Parameters:
      createFileCacheRequest - A Consumer that will call methods on CreateFileCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFileCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingFileCacheConfigurationException A cache configuration is required for this operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystem

      default CompletableFuture<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest createFileSystemRequest)

      Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

      • Amazon FSx for Lustre

      • Amazon FSx for NetApp ONTAP

      • Amazon FSx for OpenZFS

      • Amazon FSx for Windows File Server

      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.

      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 with the 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 in JSON format.

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

      Parameters:
      createFileSystemRequest - The request object used to create a new Amazon FSx file system.
      Returns:
      A Java Future containing the result of the CreateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • ActiveDirectoryErrorException An Active Directory error.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidImportPathException The path provided for data repository import isn't valid.
      • InvalidExportPathException The path provided for data repository export isn't valid.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingFileSystemConfigurationException A file system configuration is required for this operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystem

      default CompletableFuture<CreateFileSystemResponse> createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)

      Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

      • Amazon FSx for Lustre

      • Amazon FSx for NetApp ONTAP

      • Amazon FSx for OpenZFS

      • Amazon FSx for Windows File Server

      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.

      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 with the 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 in JSON format.

      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()

      Parameters:
      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.
      Returns:
      A Java Future containing the result of the CreateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • ActiveDirectoryErrorException An Active Directory error.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidImportPathException The path provided for data repository import isn't valid.
      • InvalidExportPathException The path provided for data repository export isn't valid.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingFileSystemConfigurationException A file system configuration is required for this operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystemFromBackup

      default CompletableFuture<CreateFileSystemFromBackupResponse> createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)

      Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS 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 file system with the specified client request token exists but 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 the 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 a success message as long as the parameters are the same.

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

      Parameters:
      createFileSystemFromBackupRequest - The request object for the CreateFileSystemFromBackup operation.
      Returns:
      A Java Future containing the result of the CreateFileSystemFromBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • ActiveDirectoryErrorException An Active Directory error.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingFileSystemConfigurationException A file system configuration is required for this operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFileSystemFromBackup

      default CompletableFuture<CreateFileSystemFromBackupResponse> createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> createFileSystemFromBackupRequest)

      Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS 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 file system with the specified client request token exists but 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 the 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 a success message 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()

      Parameters:
      createFileSystemFromBackupRequest - A Consumer that will call methods on CreateFileSystemFromBackupRequest.Builder to create a request. The request object for the CreateFileSystemFromBackup operation.
      Returns:
      A Java Future containing the result of the CreateFileSystemFromBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • ActiveDirectoryErrorException An Active Directory error.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InvalidPerUnitStorageThroughputException An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingFileSystemConfigurationException A file system configuration is required for this operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)

      Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

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

      • Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.

      • Returns the description of the snapshot.

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

      The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

      Parameters:
      createSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)

      Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

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

      • Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.

      • Returns the description of the snapshot.

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

      The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.


      This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to create one manually via CreateSnapshotRequest.builder()

      Parameters:
      createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStorageVirtualMachine

      default CompletableFuture<CreateStorageVirtualMachineResponse> createStorageVirtualMachine(CreateStorageVirtualMachineRequest createStorageVirtualMachineRequest)

      Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

      Parameters:
      createStorageVirtualMachineRequest -
      Returns:
      A Java Future containing the result of the CreateStorageVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActiveDirectoryErrorException An Active Directory error.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStorageVirtualMachine

      default CompletableFuture<CreateStorageVirtualMachineResponse> createStorageVirtualMachine(Consumer<CreateStorageVirtualMachineRequest.Builder> createStorageVirtualMachineRequest)

      Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.


      This is a convenience which creates an instance of the CreateStorageVirtualMachineRequest.Builder avoiding the need to create one manually via CreateStorageVirtualMachineRequest.builder()

      Parameters:
      createStorageVirtualMachineRequest - A Consumer that will call methods on CreateStorageVirtualMachineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStorageVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActiveDirectoryErrorException An Active Directory error.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVolume

      default CompletableFuture<CreateVolumeResponse> createVolume(CreateVolumeRequest createVolumeRequest)

      Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

      Parameters:
      createVolumeRequest -
      Returns:
      A Java Future containing the result of the CreateVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingVolumeConfigurationException A volume configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVolume

      default CompletableFuture<CreateVolumeResponse> createVolume(Consumer<CreateVolumeRequest.Builder> createVolumeRequest)

      Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.


      This is a convenience which creates an instance of the CreateVolumeRequest.Builder avoiding the need to create one manually via CreateVolumeRequest.builder()

      Parameters:
      createVolumeRequest - A Consumer that will call methods on CreateVolumeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingVolumeConfigurationException A volume configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVolumeFromBackup

      default CompletableFuture<CreateVolumeFromBackupResponse> createVolumeFromBackup(CreateVolumeFromBackupRequest createVolumeFromBackupRequest)

      Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.

      Parameters:
      createVolumeFromBackupRequest -
      Returns:
      A Java Future containing the result of the CreateVolumeFromBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingVolumeConfigurationException A volume configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVolumeFromBackup

      default CompletableFuture<CreateVolumeFromBackupResponse> createVolumeFromBackup(Consumer<CreateVolumeFromBackupRequest.Builder> createVolumeFromBackupRequest)

      Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.


      This is a convenience which creates an instance of the CreateVolumeFromBackupRequest.Builder avoiding the need to create one manually via CreateVolumeFromBackupRequest.builder()

      Parameters:
      createVolumeFromBackupRequest - A Consumer that will call methods on CreateVolumeFromBackupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVolumeFromBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingVolumeConfigurationException A volume configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackup

      default CompletableFuture<DeleteBackupResponse> deleteBackup(DeleteBackupRequest deleteBackupRequest)

      Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.

      The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.

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

      Parameters:
      deleteBackupRequest - The request object for the DeleteBackup operation.
      Returns:
      A Java Future containing the result of the DeleteBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • BackupInProgressException Another backup is already under way. Wait for completion before initiating additional backups of this file system.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • BackupRestoringException You can't delete a backup while it's being used to restore a file system.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • BackupBeingCopiedException You can't delete a backup while it's being copied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBackup

      default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)

      Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.

      The DeleteBackup call returns instantly. The backup won't 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()

      Parameters:
      deleteBackupRequest - A Consumer that will call methods on DeleteBackupRequest.Builder to create a request. The request object for the DeleteBackup operation.
      Returns:
      A Java Future containing the result of the DeleteBackup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • BackupInProgressException Another backup is already under way. Wait for completion before initiating additional backups of this file system.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • BackupRestoringException You can't delete a backup while it's being used to restore a file system.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • BackupBeingCopiedException You can't delete a backup while it's being copied.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataRepositoryAssociation

      default CompletableFuture<DeleteDataRepositoryAssociationResponse> deleteDataRepositoryAssociation(DeleteDataRepositoryAssociationRequest deleteDataRepositoryAssociationRequest)

      Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

      Parameters:
      deleteDataRepositoryAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteDataRepositoryAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataRepositoryAssociation

      default CompletableFuture<DeleteDataRepositoryAssociationResponse> deleteDataRepositoryAssociation(Consumer<DeleteDataRepositoryAssociationRequest.Builder> deleteDataRepositoryAssociationRequest)

      Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.


      This is a convenience which creates an instance of the DeleteDataRepositoryAssociationRequest.Builder avoiding the need to create one manually via DeleteDataRepositoryAssociationRequest.builder()

      Parameters:
      deleteDataRepositoryAssociationRequest - A Consumer that will call methods on DeleteDataRepositoryAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataRepositoryAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileCache

      default CompletableFuture<DeleteFileCacheResponse> deleteFileCache(DeleteFileCacheRequest deleteFileCacheRequest)

      Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.

      The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.

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

      Parameters:
      deleteFileCacheRequest -
      Returns:
      A Java Future containing the result of the DeleteFileCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileCache

      default CompletableFuture<DeleteFileCacheResponse> deleteFileCache(Consumer<DeleteFileCacheRequest.Builder> deleteFileCacheRequest)

      Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.

      The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.

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


      This is a convenience which creates an instance of the DeleteFileCacheRequest.Builder avoiding the need to create one manually via DeleteFileCacheRequest.builder()

      Parameters:
      deleteFileCacheRequest - A Consumer that will call methods on DeleteFileCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFileCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystem

      default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)

      Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.

      To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.

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

      To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a FileSystemId value to the DeleFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.

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

      If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).

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

      Parameters:
      deleteFileSystemRequest - The request object for DeleteFileSystem operation.
      Returns:
      A Java Future containing the result of the DeleteFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFileSystem

      default CompletableFuture<DeleteFileSystemResponse> deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)

      Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.

      To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.

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

      To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a FileSystemId value to the DeleFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.

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

      If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).

      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()

      Parameters:
      deleteFileSystemRequest - A Consumer that will call methods on DeleteFileSystemRequest.Builder to create a request. The request object for DeleteFileSystem operation.
      Returns:
      A Java Future containing the result of the DeleteFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSnapshot

      default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)

      Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

      The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

      Parameters:
      deleteSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSnapshot

      default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)

      Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

      The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.


      This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder avoiding the need to create one manually via DeleteSnapshotRequest.builder()

      Parameters:
      deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageVirtualMachine

      default CompletableFuture<DeleteStorageVirtualMachineResponse> deleteStorageVirtualMachine(DeleteStorageVirtualMachineRequest deleteStorageVirtualMachineRequest)

      Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

      Parameters:
      deleteStorageVirtualMachineRequest -
      Returns:
      A Java Future containing the result of the DeleteStorageVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStorageVirtualMachine

      default CompletableFuture<DeleteStorageVirtualMachineResponse> deleteStorageVirtualMachine(Consumer<DeleteStorageVirtualMachineRequest.Builder> deleteStorageVirtualMachineRequest)

      Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.


      This is a convenience which creates an instance of the DeleteStorageVirtualMachineRequest.Builder avoiding the need to create one manually via DeleteStorageVirtualMachineRequest.builder()

      Parameters:
      deleteStorageVirtualMachineRequest - A Consumer that will call methods on DeleteStorageVirtualMachineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStorageVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVolume

      default CompletableFuture<DeleteVolumeResponse> deleteVolume(DeleteVolumeRequest deleteVolumeRequest)

      Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

      Parameters:
      deleteVolumeRequest -
      Returns:
      A Java Future containing the result of the DeleteVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVolume

      default CompletableFuture<DeleteVolumeResponse> deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)

      Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.


      This is a convenience which creates an instance of the DeleteVolumeRequest.Builder avoiding the need to create one manually via DeleteVolumeRequest.builder()

      Parameters:
      deleteVolumeRequest - A Consumer that will call methods on DeleteVolumeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackups

      default CompletableFuture<DescribeBackupsResponse> describeBackups(DescribeBackupsRequest describeBackupsRequest)

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

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

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

      When using this operation, keep the following in mind:

      • The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.

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

      Parameters:
      describeBackupsRequest - The request object for the DescribeBackups operation.
      Returns:
      A Java Future containing the result of the DescribeBackups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackups

      default CompletableFuture<DescribeBackupsResponse> describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)

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

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

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

      When using this operation, keep the following in mind:

      • The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.

      • The order of the backups returned in the response of one DescribeBackups call and the order of the 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()

      Parameters:
      describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request. The request object for the DescribeBackups operation.
      Returns:
      A Java Future containing the result of the DescribeBackups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackups

      default CompletableFuture<DescribeBackupsResponse> describeBackups()

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

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

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

      When using this operation, keep the following in mind:

      • The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.

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

      Returns:
      A Java Future containing the result of the DescribeBackups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupsPaginator

      default DescribeBackupsPublisher describeBackupsPaginator()

      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.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupsPaginator

      default DescribeBackupsPublisher describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)

      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.

      Parameters:
      describeBackupsRequest - The request object for the DescribeBackups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeBackupsPaginator

      default DescribeBackupsPublisher describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)

      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()

      Parameters:
      describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request. The request object for the DescribeBackups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • BackupNotFoundException No Amazon FSx backups were found based upon the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryAssociations

      default CompletableFuture<DescribeDataRepositoryAssociationsResponse> describeDataRepositoryAssociations(DescribeDataRepositoryAssociationsRequest describeDataRepositoryAssociationsRequest)

      Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type.

      You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

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

      Parameters:
      describeDataRepositoryAssociationsRequest -
      Returns:
      A Java Future containing the result of the DescribeDataRepositoryAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • InvalidDataRepositoryTypeException You have filtered the response to a data repository type that is not supported.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryAssociations

      default CompletableFuture<DescribeDataRepositoryAssociationsResponse> describeDataRepositoryAssociations(Consumer<DescribeDataRepositoryAssociationsRequest.Builder> describeDataRepositoryAssociationsRequest)

      Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type.

      You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

      When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned 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 DescribeDataRepositoryAssociationsRequest.Builder avoiding the need to create one manually via DescribeDataRepositoryAssociationsRequest.builder()

      Parameters:
      describeDataRepositoryAssociationsRequest - A Consumer that will call methods on DescribeDataRepositoryAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataRepositoryAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • InvalidDataRepositoryTypeException You have filtered the response to a data repository type that is not supported.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryAssociationsPaginator

      default DescribeDataRepositoryAssociationsPublisher describeDataRepositoryAssociationsPaginator(DescribeDataRepositoryAssociationsRequest describeDataRepositoryAssociationsRequest)

      This is a variant of describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest) 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.DescribeDataRepositoryAssociationsPublisher publisher = client.describeDataRepositoryAssociationsPaginator(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.DescribeDataRepositoryAssociationsPublisher publisher = client.describeDataRepositoryAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsResponse 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 describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest) operation.

      Parameters:
      describeDataRepositoryAssociationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • InvalidDataRepositoryTypeException You have filtered the response to a data repository type that is not supported.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryAssociationsPaginator

      default DescribeDataRepositoryAssociationsPublisher describeDataRepositoryAssociationsPaginator(Consumer<DescribeDataRepositoryAssociationsRequest.Builder> describeDataRepositoryAssociationsRequest)

      This is a variant of describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest) 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.DescribeDataRepositoryAssociationsPublisher publisher = client.describeDataRepositoryAssociationsPaginator(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.DescribeDataRepositoryAssociationsPublisher publisher = client.describeDataRepositoryAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsResponse 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 describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest) operation.


      This is a convenience which creates an instance of the DescribeDataRepositoryAssociationsRequest.Builder avoiding the need to create one manually via DescribeDataRepositoryAssociationsRequest.builder()

      Parameters:
      describeDataRepositoryAssociationsRequest - A Consumer that will call methods on DescribeDataRepositoryAssociationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • InvalidDataRepositoryTypeException You have filtered the response to a data repository type that is not supported.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryTasks

      default CompletableFuture<DescribeDataRepositoryTasksResponse> describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)

      Returns the description of specific Amazon FSx for Lustre or Amazon File Cache 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 caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

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

      Parameters:
      describeDataRepositoryTasksRequest -
      Returns:
      A Java Future containing the result of the DescribeDataRepositoryTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryTaskNotFoundException The data repository task or tasks you specified could not be found.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryTasks

      default CompletableFuture<DescribeDataRepositoryTasksResponse> describeDataRepositoryTasks(Consumer<DescribeDataRepositoryTasksRequest.Builder> describeDataRepositoryTasksRequest)

      Returns the description of specific Amazon FSx for Lustre or Amazon File Cache 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 caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

      When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned 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()

      Parameters:
      describeDataRepositoryTasksRequest - A Consumer that will call methods on DescribeDataRepositoryTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataRepositoryTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryTaskNotFoundException The data repository task or tasks you specified could not be found.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryTasksPaginator

      default DescribeDataRepositoryTasksPublisher describeDataRepositoryTasksPaginator(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)

      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.

      Parameters:
      describeDataRepositoryTasksRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryTaskNotFoundException The data repository task or tasks you specified could not be found.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDataRepositoryTasksPaginator

      default DescribeDataRepositoryTasksPublisher describeDataRepositoryTasksPaginator(Consumer<DescribeDataRepositoryTasksRequest.Builder> describeDataRepositoryTasksRequest)

      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()

      Parameters:
      describeDataRepositoryTasksRequest - A Consumer that will call methods on DescribeDataRepositoryTasksRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • DataRepositoryTaskNotFoundException The data repository task or tasks you specified could not be found.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileCaches

      default CompletableFuture<DescribeFileCachesResponse> describeFileCaches(DescribeFileCachesRequest describeFileCachesRequest)

      Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

      When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation 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 operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation 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 operation, keep the following in mind:

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

      • The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.

      Parameters:
      describeFileCachesRequest -
      Returns:
      A Java Future containing the result of the DescribeFileCaches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileCaches

      default CompletableFuture<DescribeFileCachesResponse> describeFileCaches(Consumer<DescribeFileCachesRequest.Builder> describeFileCachesRequest)

      Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

      When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation 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 operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation 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 operation, keep the following in mind:

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

      • The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.


      This is a convenience which creates an instance of the DescribeFileCachesRequest.Builder avoiding the need to create one manually via DescribeFileCachesRequest.builder()

      Parameters:
      describeFileCachesRequest - A Consumer that will call methods on DescribeFileCachesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFileCaches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileCachesPaginator

      default DescribeFileCachesPublisher describeFileCachesPaginator(DescribeFileCachesRequest describeFileCachesRequest)

      This is a variant of describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) 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.DescribeFileCachesPublisher publisher = client.describeFileCachesPaginator(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.DescribeFileCachesPublisher publisher = client.describeFileCachesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse 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 describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) operation.

      Parameters:
      describeFileCachesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileCachesPaginator

      default DescribeFileCachesPublisher describeFileCachesPaginator(Consumer<DescribeFileCachesRequest.Builder> describeFileCachesRequest)

      This is a variant of describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) 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.DescribeFileCachesPublisher publisher = client.describeFileCachesPaginator(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.DescribeFileCachesPublisher publisher = client.describeFileCachesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse 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 describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) operation.


      This is a convenience which creates an instance of the DescribeFileCachesRequest.Builder avoiding the need to create one manually via DescribeFileCachesRequest.builder()

      Parameters:
      describeFileCachesRequest - A Consumer that will call methods on DescribeFileCachesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemAliases

      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.

      Parameters:
      describeFileSystemAliasesRequest - The request object for DescribeFileSystemAliases operation.
      Returns:
      A Java Future containing the result of the DescribeFileSystemAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemAliases

      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()

      Parameters:
      describeFileSystemAliasesRequest - A Consumer that will call methods on DescribeFileSystemAliasesRequest.Builder to create a request. The request object for DescribeFileSystemAliases operation.
      Returns:
      A Java Future containing the result of the DescribeFileSystemAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemAliasesPaginator

      default DescribeFileSystemAliasesPublisher describeFileSystemAliasesPaginator(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest)

      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.

      Parameters:
      describeFileSystemAliasesRequest - The request object for DescribeFileSystemAliases operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemAliasesPaginator

      default DescribeFileSystemAliasesPublisher describeFileSystemAliasesPaginator(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest)

      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()

      Parameters:
      describeFileSystemAliasesRequest - A Consumer that will call methods on DescribeFileSystemAliasesRequest.Builder to create a request. The request object for DescribeFileSystemAliases operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystems

      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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

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

      This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation 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 operation, keep the following in mind:

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

      • The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

      Parameters:
      describeFileSystemsRequest - The request object for DescribeFileSystems operation.
      Returns:
      A Java Future containing the result of the DescribeFileSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystems

      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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

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

      This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation 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 operation, 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()

      Parameters:
      describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request. The request object for DescribeFileSystems operation.
      Returns:
      A Java Future containing the result of the DescribeFileSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystems

      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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

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

      This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation 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 operation, 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.

      Returns:
      A Java Future containing the result of the DescribeFileSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemsPaginator

      default DescribeFileSystemsPublisher describeFileSystemsPaginator()

      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.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemsPaginator

      default DescribeFileSystemsPublisher describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)

      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.

      Parameters:
      describeFileSystemsRequest - The request object for DescribeFileSystems operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFileSystemsPaginator

      default DescribeFileSystemsPublisher describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)

      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()

      Parameters:
      describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request. The request object for DescribeFileSystems operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSharedVpcConfiguration

      default CompletableFuture<DescribeSharedVpcConfigurationResponse> describeSharedVpcConfiguration(DescribeSharedVpcConfigurationRequest describeSharedVpcConfigurationRequest)

      Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.

      Parameters:
      describeSharedVpcConfigurationRequest -
      Returns:
      A Java Future containing the result of the DescribeSharedVpcConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSharedVpcConfiguration

      default CompletableFuture<DescribeSharedVpcConfigurationResponse> describeSharedVpcConfiguration(Consumer<DescribeSharedVpcConfigurationRequest.Builder> describeSharedVpcConfigurationRequest)

      Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.


      This is a convenience which creates an instance of the DescribeSharedVpcConfigurationRequest.Builder avoiding the need to create one manually via DescribeSharedVpcConfigurationRequest.builder()

      Parameters:
      describeSharedVpcConfigurationRequest - A Consumer that will call methods on DescribeSharedVpcConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSharedVpcConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)

      Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

      When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots 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.

      Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

      When using this operation, keep the following in mind:

      • The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.

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

      Parameters:
      describeSnapshotsRequest -
      Returns:
      A Java Future containing the result of the DescribeSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)

      Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

      When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots 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.

      Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

      When using this operation, keep the following in mind:

      • The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.

      • The order of snapshots returned in the response of one DescribeSnapshots 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 DescribeSnapshotsRequest.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

      Parameters:
      describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)

      This is a variant of describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) 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.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(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.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsResponse 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 describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) operation.

      Parameters:
      describeSnapshotsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)

      This is a variant of describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) 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.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(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.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsResponse 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 describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) operation.


      This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

      Parameters:
      describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageVirtualMachines

      default CompletableFuture<DescribeStorageVirtualMachinesResponse> describeStorageVirtualMachines(DescribeStorageVirtualMachinesRequest describeStorageVirtualMachinesRequest)

      Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

      Parameters:
      describeStorageVirtualMachinesRequest -
      Returns:
      A Java Future containing the result of the DescribeStorageVirtualMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageVirtualMachines

      default CompletableFuture<DescribeStorageVirtualMachinesResponse> describeStorageVirtualMachines(Consumer<DescribeStorageVirtualMachinesRequest.Builder> describeStorageVirtualMachinesRequest)

      Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).


      This is a convenience which creates an instance of the DescribeStorageVirtualMachinesRequest.Builder avoiding the need to create one manually via DescribeStorageVirtualMachinesRequest.builder()

      Parameters:
      describeStorageVirtualMachinesRequest - A Consumer that will call methods on DescribeStorageVirtualMachinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStorageVirtualMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageVirtualMachinesPaginator

      default DescribeStorageVirtualMachinesPublisher describeStorageVirtualMachinesPaginator(DescribeStorageVirtualMachinesRequest describeStorageVirtualMachinesRequest)

      This is a variant of describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest) 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.DescribeStorageVirtualMachinesPublisher publisher = client.describeStorageVirtualMachinesPaginator(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.DescribeStorageVirtualMachinesPublisher publisher = client.describeStorageVirtualMachinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesResponse 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 describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest) operation.

      Parameters:
      describeStorageVirtualMachinesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageVirtualMachinesPaginator

      default DescribeStorageVirtualMachinesPublisher describeStorageVirtualMachinesPaginator(Consumer<DescribeStorageVirtualMachinesRequest.Builder> describeStorageVirtualMachinesRequest)

      This is a variant of describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest) 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.DescribeStorageVirtualMachinesPublisher publisher = client.describeStorageVirtualMachinesPaginator(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.DescribeStorageVirtualMachinesPublisher publisher = client.describeStorageVirtualMachinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesResponse 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 describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest) operation.


      This is a convenience which creates an instance of the DescribeStorageVirtualMachinesRequest.Builder avoiding the need to create one manually via DescribeStorageVirtualMachinesRequest.builder()

      Parameters:
      describeStorageVirtualMachinesRequest - A Consumer that will call methods on DescribeStorageVirtualMachinesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVolumes

      default CompletableFuture<DescribeVolumesResponse> describeVolumes(DescribeVolumesRequest describeVolumesRequest)

      Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.

      Parameters:
      describeVolumesRequest -
      Returns:
      A Java Future containing the result of the DescribeVolumes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVolumes

      default CompletableFuture<DescribeVolumesResponse> describeVolumes(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest)

      Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.


      This is a convenience which creates an instance of the DescribeVolumesRequest.Builder avoiding the need to create one manually via DescribeVolumesRequest.builder()

      Parameters:
      describeVolumesRequest - A Consumer that will call methods on DescribeVolumesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeVolumes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVolumesPaginator

      default DescribeVolumesPublisher describeVolumesPaginator(DescribeVolumesRequest describeVolumesRequest)

      This is a variant of describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest) 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.DescribeVolumesPublisher publisher = client.describeVolumesPaginator(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.DescribeVolumesPublisher publisher = client.describeVolumesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse 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 describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest) operation.

      Parameters:
      describeVolumesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVolumesPaginator

      default DescribeVolumesPublisher describeVolumesPaginator(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest)

      This is a variant of describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest) 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.DescribeVolumesPublisher publisher = client.describeVolumesPaginator(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.DescribeVolumesPublisher publisher = client.describeVolumesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse 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 describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest) operation.


      This is a convenience which creates an instance of the DescribeVolumesRequest.Builder avoiding the need to create one manually via DescribeVolumesRequest.builder()

      Parameters:
      describeVolumesRequest - A Consumer that will call methods on DescribeVolumesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateFileSystemAliases

      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 an HTTP status code 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.

      Parameters:
      disassociateFileSystemAliasesRequest - The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
      Returns:
      A Java Future containing the result of the DisassociateFileSystemAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateFileSystemAliases

      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 an HTTP status code 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()

      Parameters:
      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.
      Returns:
      A Java Future containing the result of the DisassociateFileSystemAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists tags for Amazon FSx resources.

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

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

      When using this action, keep the following in mind:

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

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

      Parameters:
      listTagsForResourceRequest - The request object for ListTagsForResource operation.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists tags for Amazon FSx resources.

      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()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. The request object for ListTagsForResource operation.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) 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.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(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.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.ListTagsForResourceResponse 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 listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest - The request object for ListTagsForResource operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) 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.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(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.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fsx.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.fsx.model.ListTagsForResourceResponse 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 listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) operation.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. The request object for ListTagsForResource operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • releaseFileSystemNfsV3Locks

      default CompletableFuture<ReleaseFileSystemNfsV3LocksResponse> releaseFileSystemNfsV3Locks(ReleaseFileSystemNfsV3LocksRequest releaseFileSystemNfsV3LocksRequest)

      Releases the file system lock from an Amazon FSx for OpenZFS file system.

      Parameters:
      releaseFileSystemNfsV3LocksRequest -
      Returns:
      A Java Future containing the result of the ReleaseFileSystemNfsV3Locks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • releaseFileSystemNfsV3Locks

      default CompletableFuture<ReleaseFileSystemNfsV3LocksResponse> releaseFileSystemNfsV3Locks(Consumer<ReleaseFileSystemNfsV3LocksRequest.Builder> releaseFileSystemNfsV3LocksRequest)

      Releases the file system lock from an Amazon FSx for OpenZFS file system.


      This is a convenience which creates an instance of the ReleaseFileSystemNfsV3LocksRequest.Builder avoiding the need to create one manually via ReleaseFileSystemNfsV3LocksRequest.builder()

      Parameters:
      releaseFileSystemNfsV3LocksRequest - A Consumer that will call methods on ReleaseFileSystemNfsV3LocksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ReleaseFileSystemNfsV3Locks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreVolumeFromSnapshot

      default CompletableFuture<RestoreVolumeFromSnapshotResponse> restoreVolumeFromSnapshot(RestoreVolumeFromSnapshotRequest restoreVolumeFromSnapshotRequest)

      Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

      Parameters:
      restoreVolumeFromSnapshotRequest -
      Returns:
      A Java Future containing the result of the RestoreVolumeFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • restoreVolumeFromSnapshot

      default CompletableFuture<RestoreVolumeFromSnapshotResponse> restoreVolumeFromSnapshot(Consumer<RestoreVolumeFromSnapshotRequest.Builder> restoreVolumeFromSnapshotRequest)

      Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.


      This is a convenience which creates an instance of the RestoreVolumeFromSnapshotRequest.Builder avoiding the need to create one manually via RestoreVolumeFromSnapshotRequest.builder()

      Parameters:
      restoreVolumeFromSnapshotRequest - A Consumer that will call methods on RestoreVolumeFromSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestoreVolumeFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startMisconfiguredStateRecovery

      default CompletableFuture<StartMisconfiguredStateRecoveryResponse> startMisconfiguredStateRecovery(StartMisconfiguredStateRecoveryRequest startMisconfiguredStateRecoveryRequest)

      After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.

      Parameters:
      startMisconfiguredStateRecoveryRequest -
      Returns:
      A Java Future containing the result of the StartMisconfiguredStateRecovery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startMisconfiguredStateRecovery

      default CompletableFuture<StartMisconfiguredStateRecoveryResponse> startMisconfiguredStateRecovery(Consumer<StartMisconfiguredStateRecoveryRequest.Builder> startMisconfiguredStateRecoveryRequest)

      After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.


      This is a convenience which creates an instance of the StartMisconfiguredStateRecoveryRequest.Builder avoiding the need to create one manually via StartMisconfiguredStateRecoveryRequest.builder()

      Parameters:
      startMisconfiguredStateRecoveryRequest - A Consumer that will call methods on StartMisconfiguredStateRecoveryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartMisconfiguredStateRecovery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Tags an Amazon FSx resource.

      Parameters:
      tagResourceRequest - The request object for the TagResource operation.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      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()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. The request object for the TagResource operation.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      This action removes a tag from an Amazon FSx resource.

      Parameters:
      untagResourceRequest - The request object for UntagResource action.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      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()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. The request object for UntagResource action.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • ResourceNotFoundException The resource specified by the Amazon Resource Name (ARN) can't be found.
      • NotServiceResourceErrorException The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
      • ResourceDoesNotSupportTaggingException The resource specified does not support tagging.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataRepositoryAssociation

      default CompletableFuture<UpdateDataRepositoryAssociationResponse> updateDataRepositoryAssociation(UpdateDataRepositoryAssociationRequest updateDataRepositoryAssociationRequest)

      Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

      Parameters:
      updateDataRepositoryAssociationRequest -
      Returns:
      A Java Future containing the result of the UpdateDataRepositoryAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataRepositoryAssociation

      default CompletableFuture<UpdateDataRepositoryAssociationResponse> updateDataRepositoryAssociation(Consumer<UpdateDataRepositoryAssociationRequest.Builder> updateDataRepositoryAssociationRequest)

      Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.


      This is a convenience which creates an instance of the UpdateDataRepositoryAssociationRequest.Builder avoiding the need to create one manually via UpdateDataRepositoryAssociationRequest.builder()

      Parameters:
      updateDataRepositoryAssociationRequest - A Consumer that will call methods on UpdateDataRepositoryAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataRepositoryAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • DataRepositoryAssociationNotFoundException No data repository associations were found based upon the supplied parameters.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileCache

      default CompletableFuture<UpdateFileCacheResponse> updateFileCache(UpdateFileCacheRequest updateFileCacheRequest)

      Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.

      Parameters:
      updateFileCacheRequest -
      Returns:
      A Java Future containing the result of the UpdateFileCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • MissingFileCacheConfigurationException A cache configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileCache

      default CompletableFuture<UpdateFileCacheResponse> updateFileCache(Consumer<UpdateFileCacheRequest.Builder> updateFileCacheRequest)

      Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.


      This is a convenience which creates an instance of the UpdateFileCacheRequest.Builder avoiding the need to create one manually via UpdateFileCacheRequest.builder()

      Parameters:
      updateFileCacheRequest - A Consumer that will call methods on UpdateFileCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFileCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • FileCacheNotFoundException No caches were found based upon supplied parameters.
      • MissingFileCacheConfigurationException A cache configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystem

      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 FSx for Windows File Server file systems, you can update the following properties:

      • AuditLogConfiguration

      • AutomaticBackupRetentionDays

      • DailyAutomaticBackupStartTime

      • SelfManagedActiveDirectoryConfiguration

      • StorageCapacity

      • StorageType

      • ThroughputCapacity

      • DiskIopsConfiguration

      • WeeklyMaintenanceStartTime

      For FSx for Lustre file systems, you can update the following properties:

      • AutoImportPolicy

      • AutomaticBackupRetentionDays

      • DailyAutomaticBackupStartTime

      • DataCompressionType

      • LogConfiguration

      • LustreRootSquashConfiguration

      • PerUnitStorageThroughput

      • StorageCapacity

      • WeeklyMaintenanceStartTime

      For FSx for ONTAP file systems, you can update the following properties:

      • AddRouteTableIds

      • AutomaticBackupRetentionDays

      • DailyAutomaticBackupStartTime

      • DiskIopsConfiguration

      • FsxAdminPassword

      • HAPairs

      • RemoveRouteTableIds

      • StorageCapacity

      • ThroughputCapacity

      • ThroughputCapacityPerHAPair

      • WeeklyMaintenanceStartTime

      For FSx for OpenZFS file systems, you can update the following properties:

      • AddRouteTableIds

      • AutomaticBackupRetentionDays

      • CopyTagsToBackups

      • CopyTagsToVolumes

      • DailyAutomaticBackupStartTime

      • DiskIopsConfiguration

      • RemoveRouteTableIds

      • StorageCapacity

      • ThroughputCapacity

      • WeeklyMaintenanceStartTime

      Parameters:
      updateFileSystemRequest - The request object for the UpdateFileSystem operation.
      Returns:
      A Java Future containing the result of the UpdateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • MissingFileSystemConfigurationException A file system configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFileSystem

      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 FSx for Windows File Server file systems, you can update the following properties:

      • AuditLogConfiguration

      • AutomaticBackupRetentionDays

      • DailyAutomaticBackupStartTime

      • SelfManagedActiveDirectoryConfiguration

      • StorageCapacity

      • StorageType

      • ThroughputCapacity

      • DiskIopsConfiguration

      • WeeklyMaintenanceStartTime

      For FSx for Lustre file systems, you can update the following properties:

      • AutoImportPolicy

      • AutomaticBackupRetentionDays

      • DailyAutomaticBackupStartTime

      • DataCompressionType

      • LogConfiguration

      • LustreRootSquashConfiguration

      • PerUnitStorageThroughput

      • StorageCapacity

      • WeeklyMaintenanceStartTime

      For FSx for ONTAP file systems, you can update the following properties:

      • AddRouteTableIds

      • AutomaticBackupRetentionDays

      • DailyAutomaticBackupStartTime

      • DiskIopsConfiguration

      • FsxAdminPassword

      • HAPairs

      • RemoveRouteTableIds

      • StorageCapacity

      • ThroughputCapacity

      • ThroughputCapacityPerHAPair

      • WeeklyMaintenanceStartTime

      For FSx for OpenZFS file systems, you can update the following properties:

      • AddRouteTableIds

      • AutomaticBackupRetentionDays

      • CopyTagsToBackups

      • CopyTagsToVolumes

      • DailyAutomaticBackupStartTime

      • DiskIopsConfiguration

      • RemoveRouteTableIds

      • StorageCapacity

      • ThroughputCapacity

      • WeeklyMaintenanceStartTime


      This is a convenience which creates an instance of the UpdateFileSystemRequest.Builder avoiding the need to create one manually via UpdateFileSystemRequest.builder()

      Parameters:
      updateFileSystemRequest - A Consumer that will call methods on UpdateFileSystemRequest.Builder to create a request. The request object for the UpdateFileSystem operation.
      Returns:
      A Java Future containing the result of the UpdateFileSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InvalidNetworkSettingsException One or more network settings specified in the request are invalid.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • FileSystemNotFoundException No Amazon FSx file systems were found based upon supplied parameters.
      • MissingFileSystemConfigurationException A file system configuration is required for this operation.
      • ServiceLimitExceededException An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSharedVpcConfiguration

      default CompletableFuture<UpdateSharedVpcConfigurationResponse> updateSharedVpcConfiguration(UpdateSharedVpcConfigurationRequest updateSharedVpcConfigurationRequest)

      Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.

      We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems.

      Parameters:
      updateSharedVpcConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateSharedVpcConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSharedVpcConfiguration

      default CompletableFuture<UpdateSharedVpcConfigurationResponse> updateSharedVpcConfiguration(Consumer<UpdateSharedVpcConfigurationRequest.Builder> updateSharedVpcConfigurationRequest)

      Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.

      We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems.


      This is a convenience which creates an instance of the UpdateSharedVpcConfigurationRequest.Builder avoiding the need to create one manually via UpdateSharedVpcConfigurationRequest.builder()

      Parameters:
      updateSharedVpcConfigurationRequest - A Consumer that will call methods on UpdateSharedVpcConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSharedVpcConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSnapshot

      default CompletableFuture<UpdateSnapshotResponse> updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)

      Updates the name of an Amazon FSx for OpenZFS snapshot.

      Parameters:
      updateSnapshotRequest -
      Returns:
      A Java Future containing the result of the UpdateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSnapshot

      default CompletableFuture<UpdateSnapshotResponse> updateSnapshot(Consumer<UpdateSnapshotRequest.Builder> updateSnapshotRequest)

      Updates the name of an Amazon FSx for OpenZFS snapshot.


      This is a convenience which creates an instance of the UpdateSnapshotRequest.Builder avoiding the need to create one manually via UpdateSnapshotRequest.builder()

      Parameters:
      updateSnapshotRequest - A Consumer that will call methods on UpdateSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • SnapshotNotFoundException No Amazon FSx snapshots were found based on the supplied parameters.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStorageVirtualMachine

      default CompletableFuture<UpdateStorageVirtualMachineResponse> updateStorageVirtualMachine(UpdateStorageVirtualMachineRequest updateStorageVirtualMachineRequest)

      Updates an FSx for ONTAP storage virtual machine (SVM).

      Parameters:
      updateStorageVirtualMachineRequest -
      Returns:
      A Java Future containing the result of the UpdateStorageVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStorageVirtualMachine

      default CompletableFuture<UpdateStorageVirtualMachineResponse> updateStorageVirtualMachine(Consumer<UpdateStorageVirtualMachineRequest.Builder> updateStorageVirtualMachineRequest)

      Updates an FSx for ONTAP storage virtual machine (SVM).


      This is a convenience which creates an instance of the UpdateStorageVirtualMachineRequest.Builder avoiding the need to create one manually via UpdateStorageVirtualMachineRequest.builder()

      Parameters:
      updateStorageVirtualMachineRequest - A Consumer that will call methods on UpdateStorageVirtualMachineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateStorageVirtualMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • StorageVirtualMachineNotFoundException No FSx for ONTAP SVMs were found based upon the supplied parameters.
      • UnsupportedOperationException The requested operation is not supported for this resource or API.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVolume

      default CompletableFuture<UpdateVolumeResponse> updateVolume(UpdateVolumeRequest updateVolumeRequest)

      Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

      Parameters:
      updateVolumeRequest -
      Returns:
      A Java Future containing the result of the UpdateVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingVolumeConfigurationException A volume configuration is required for this operation.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVolume

      default CompletableFuture<UpdateVolumeResponse> updateVolume(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest)

      Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.


      This is a convenience which creates an instance of the UpdateVolumeRequest.Builder avoiding the need to create one manually via UpdateVolumeRequest.builder()

      Parameters:
      updateVolumeRequest - A Consumer that will call methods on UpdateVolumeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVolume operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • BadRequestException A generic error indicating a failure with a client request.
      • IncompatibleParameterErrorException The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
      • InternalServerErrorException A generic error indicating a server-side failure.
      • MissingVolumeConfigurationException A volume configuration is required for this operation.
      • VolumeNotFoundException No Amazon FSx volumes were found based upon the supplied parameters.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • FSxException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default FSxServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static FSxAsyncClient create()
      Create a FSxAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static FSxAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a FSxAsyncClient.