FSxClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient
```
@Generated(value="software.amazon.awssdk:codegen")
public interface FSxClient
extends SdkClient
```
Service client for accessing Amazon FSx. This can be created using the static builder() method.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Field Summary

Fields
Modifier and Type Field and Description

static String SERVICE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static FSxClientBuilder`	`builder()` Create a builder that can be used to configure and create a `FSxClient`.
`static FSxClient`	`create()` Create a `FSxClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CreateBackupResponse`	`createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)` Creates a backup of an existing Amazon FSx for Windows File Server file system.
`default CreateBackupResponse`	`createBackup(CreateBackupRequest createBackupRequest)` Creates a backup of an existing Amazon FSx for Windows File Server file system.
`default CreateFileSystemResponse`	`createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)` Creates a new, empty Amazon FSx file system.
`default CreateFileSystemResponse`	`createFileSystem(CreateFileSystemRequest createFileSystemRequest)` Creates a new, empty Amazon FSx file system.
`default CreateFileSystemFromBackupResponse`	`createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> createFileSystemFromBackupRequest)` Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
`default CreateFileSystemFromBackupResponse`	`createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)` Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
`default DeleteBackupResponse`	`deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)` Deletes an Amazon FSx for Windows File Server backup, deleting its contents.
`default DeleteBackupResponse`	`deleteBackup(DeleteBackupRequest deleteBackupRequest)` Deletes an Amazon FSx for Windows File Server backup, deleting its contents.
`default DeleteFileSystemResponse`	`deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)` Deletes a file system, deleting its contents.
`default DeleteFileSystemResponse`	`deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)` Deletes a file system, deleting its contents.
`default DescribeBackupsResponse`	`describeBackups()` Returns the description of specific Amazon FSx for Windows File Server backups, if a `BackupIds` value is provided for that backup.
`default DescribeBackupsResponse`	`describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)` Returns the description of specific Amazon FSx for Windows File Server backups, if a `BackupIds` value is provided for that backup.
`default DescribeBackupsResponse`	`describeBackups(DescribeBackupsRequest describeBackupsRequest)` Returns the description of specific Amazon FSx for Windows File Server backups, if a `BackupIds` value is provided for that backup.
`default DescribeBackupsIterable`	`describeBackupsPaginator()` Returns the description of specific Amazon FSx for Windows File Server backups, if a `BackupIds` value is provided for that backup.
`default DescribeBackupsIterable`	`describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)` Returns the description of specific Amazon FSx for Windows File Server backups, if a `BackupIds` value is provided for that backup.
`default DescribeBackupsIterable`	`describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)` Returns the description of specific Amazon FSx for Windows File Server backups, if a `BackupIds` value is provided for that backup.
`default DescribeFileSystemsResponse`	`describeFileSystems()` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`default DescribeFileSystemsResponse`	`describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`default DescribeFileSystemsResponse`	`describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`default DescribeFileSystemsIterable`	`describeFileSystemsPaginator()` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`default DescribeFileSystemsIterable`	`describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`default DescribeFileSystemsIterable`	`describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`default ListTagsForResourceResponse`	`listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)` Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
`default ListTagsForResourceResponse`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
`static ServiceMetadata`	`serviceMetadata()`
`default TagResourceResponse`	`tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)` Tags an Amazon FSx resource.
`default TagResourceResponse`	`tagResource(TagResourceRequest tagResourceRequest)` Tags an Amazon FSx resource.
`default UntagResourceResponse`	`untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)` This action removes a tag from an Amazon FSx resource.
`default UntagResourceResponse`	`untagResource(UntagResourceRequest untagResourceRequest)` This action removes a tag from an Amazon FSx resource.
`default UpdateFileSystemResponse`	`updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)` Updates a file system configuration.
`default UpdateFileSystemResponse`	`updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)` Updates a file system configuration.

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
static FSxClient create()
```
    Create a FSxClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
  - builder
```
static FSxClientBuilder builder()
```
    Create a builder that can be used to configure and create a FSxClient.
  - createBackup
```
default CreateBackupResponse createBackup(CreateBackupRequest createBackupRequest)
                                   throws BadRequestException,
                                          FileSystemNotFoundException,
                                          BackupInProgressException,
                                          IncompatibleParameterErrorException,
                                          ServiceLimitExceededException,
                                          InternalServerErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FSxException
```
    Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.
    
    If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
    - Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the backup.
    By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
    
    The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
    Parameters:
    
    createBackupRequest - The request object for the CreateBackup operation.
    
    Returns:
    
    Result of the CreateBackup operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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 AWS 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createBackup
```
default CreateBackupResponse createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest)
                                   throws BadRequestException,
                                          FileSystemNotFoundException,
                                          BackupInProgressException,
                                          IncompatibleParameterErrorException,
                                          ServiceLimitExceededException,
                                          InternalServerErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FSxException
```
    Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.
    
    If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
    - Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the backup.
    By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
    
    The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
    
    This is a convenience which creates an instance of the CreateBackupRequest.Builder avoiding the need to create one manually via CreateBackupRequest.builder()
    Parameters:
    
    createBackupRequest - A Consumer that will call methods on CreateBackupRequest.Builder to create a request. The request object for the CreateBackup operation.
    
    Returns:
    
    Result of the CreateBackup operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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 AWS 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createFileSystem
```
default CreateFileSystemResponse createFileSystem(CreateFileSystemRequest createFileSystemRequest)
                                           throws BadRequestException,
                                                  ActiveDirectoryErrorException,
                                                  IncompatibleParameterErrorException,
                                                  InvalidImportPathException,
                                                  InvalidNetworkSettingsException,
                                                  ServiceLimitExceededException,
                                                  InternalServerErrorException,
                                                  MissingFileSystemConfigurationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FSxException
```
    Creates a new, empty Amazon FSx file system.
    
    If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
    - Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the file system.
    This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
    
    The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
    Parameters:
    
    createFileSystemRequest - The request object for the CreateFileSystem operation.
    
    Returns:
    
    Result of the CreateFileSystem operation returned by the service.
    
    Throws:
    
    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.
    
    InvalidNetworkSettingsException - One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.
    
    ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
    
    InternalServerErrorException - A generic error indicating a server-side failure.
    
    MissingFileSystemConfigurationException - 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createFileSystem
```
default CreateFileSystemResponse createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest)
                                           throws BadRequestException,
                                                  ActiveDirectoryErrorException,
                                                  IncompatibleParameterErrorException,
                                                  InvalidImportPathException,
                                                  InvalidNetworkSettingsException,
                                                  ServiceLimitExceededException,
                                                  InternalServerErrorException,
                                                  MissingFileSystemConfigurationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FSxException
```
    Creates a new, empty Amazon FSx file system.
    
    If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
    - Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the file system.
    This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
    
    The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
    
    This is a convenience which creates an instance of the CreateFileSystemRequest.Builder avoiding the need to create one manually via CreateFileSystemRequest.builder()
    Parameters:
    
    createFileSystemRequest - A Consumer that will call methods on CreateFileSystemRequest.Builder to create a request. The request object for the CreateFileSystem operation.
    
    Returns:
    
    Result of the CreateFileSystem operation returned by the service.
    
    Throws:
    
    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.
    
    InvalidNetworkSettingsException - One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.
    
    ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
    
    InternalServerErrorException - A generic error indicating a server-side failure.
    
    MissingFileSystemConfigurationException - 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createFileSystemFromBackup
```
default CreateFileSystemFromBackupResponse createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
                                                               throws BadRequestException,
                                                                      ActiveDirectoryErrorException,
                                                                      IncompatibleParameterErrorException,
                                                                      InvalidNetworkSettingsException,
                                                                      ServiceLimitExceededException,
                                                                      BackupNotFoundException,
                                                                      InternalServerErrorException,
                                                                      MissingFileSystemConfigurationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      FSxException
```
    Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
    
    If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
    - Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the file system.
    Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
    
    By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
    
    The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
    Parameters:
    
    createFileSystemFromBackupRequest - The request object for the CreateFileSystemFromBackup operation.
    
    Returns:
    
    Result of the CreateFileSystemFromBackup operation returned by the service.
    
    Throws:
    
    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. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.
    
    ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
    
    BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.
    
    InternalServerErrorException - A generic error indicating a server-side failure.
    
    MissingFileSystemConfigurationException - 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createFileSystemFromBackup
```
default CreateFileSystemFromBackupResponse createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> createFileSystemFromBackupRequest)
                                                               throws BadRequestException,
                                                                      ActiveDirectoryErrorException,
                                                                      IncompatibleParameterErrorException,
                                                                      InvalidNetworkSettingsException,
                                                                      ServiceLimitExceededException,
                                                                      BackupNotFoundException,
                                                                      InternalServerErrorException,
                                                                      MissingFileSystemConfigurationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      FSxException
```
    Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.
    
    If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
    - Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the file system.
    Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
    
    By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
    
    The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
    
    This is a convenience which creates an instance of the CreateFileSystemFromBackupRequest.Builder avoiding the need to create one manually via CreateFileSystemFromBackupRequest.builder()
    Parameters:
    
    createFileSystemFromBackupRequest - A Consumer that will call methods on CreateFileSystemFromBackupRequest.Builder to create a request. The request object for the CreateFileSystemFromBackup operation.
    
    Returns:
    
    Result of the CreateFileSystemFromBackup operation returned by the service.
    
    Throws:
    
    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. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.
    
    ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
    
    BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.
    
    InternalServerErrorException - A generic error indicating a server-side failure.
    
    MissingFileSystemConfigurationException - 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteBackup
```
default DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest)
                                   throws BadRequestException,
                                          BackupNotFoundException,
                                          BackupRestoringException,
                                          IncompatibleParameterErrorException,
                                          InternalServerErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FSxException
```
    Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
    
    The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.
    
    The data in a deleted backup is also deleted and can't be recovered by any means.
    
    Parameters:
    
    deleteBackupRequest - The request object for DeleteBackup operation.
    
    Returns:
    
    Result of the DeleteBackup operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    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.
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteBackup
```
default DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
                                   throws BadRequestException,
                                          BackupNotFoundException,
                                          BackupRestoringException,
                                          IncompatibleParameterErrorException,
                                          InternalServerErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FSxException
```
    Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
    
    The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.
    
    The data in a deleted backup is also deleted and can't be recovered by any means.
    
    This is a convenience which creates an instance of the DeleteBackupRequest.Builder avoiding the need to create one manually via DeleteBackupRequest.builder()
    
    Parameters:
    
    deleteBackupRequest - A Consumer that will call methods on DeleteBackupRequest.Builder to create a request. The request object for DeleteBackup operation.
    
    Returns:
    
    Result of the DeleteBackup operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    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.
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteFileSystem
```
default DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
                                           throws BadRequestException,
                                                  IncompatibleParameterErrorException,
                                                  FileSystemNotFoundException,
                                                  ServiceLimitExceededException,
                                                  InternalServerErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FSxException
```
    Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
    
    By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
    
    The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
    
    The data in a deleted file system is also deleted and can't be recovered by any means.
    
    Parameters:
    
    deleteFileSystemRequest - The request object for DeleteFileSystem operation.
    
    Returns:
    
    Result of the DeleteFileSystem operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteFileSystem
```
default DeleteFileSystemResponse deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)
                                           throws BadRequestException,
                                                  IncompatibleParameterErrorException,
                                                  FileSystemNotFoundException,
                                                  ServiceLimitExceededException,
                                                  InternalServerErrorException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FSxException
```
    Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
    
    By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
    
    The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
    
    The data in a deleted file system is also deleted and can't be recovered by any means.
    
    This is a convenience which creates an instance of the DeleteFileSystemRequest.Builder avoiding the need to create one manually via DeleteFileSystemRequest.builder()
    
    Parameters:
    
    deleteFileSystemRequest - A Consumer that will call methods on DeleteFileSystemRequest.Builder to create a request. The request object for DeleteFileSystem operation.
    
    Returns:
    
    Result of the DeleteFileSystem operation returned by the service.
    
    Throws:
    
    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 AWS 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeBackups
```
default DescribeBackupsResponse describeBackups()
                                         throws BadRequestException,
                                                FileSystemNotFoundException,
                                                BackupNotFoundException,
                                                InternalServerErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FSxException
```
    Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
    Returns:
    
    Result of the DescribeBackups operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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.
    
    AwsServiceException
    
    See Also:
    
    describeBackups(DescribeBackupsRequest), AWS API Documentation
  - describeBackups
```
default DescribeBackupsResponse describeBackups(DescribeBackupsRequest describeBackupsRequest)
                                         throws BadRequestException,
                                                FileSystemNotFoundException,
                                                BackupNotFoundException,
                                                InternalServerErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FSxException
```
    Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
    Parameters:
    
    describeBackupsRequest - The request object for DescribeBackups operation.
    
    Returns:
    
    Result of the DescribeBackups operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeBackups
```
default DescribeBackupsResponse describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
                                         throws BadRequestException,
                                                FileSystemNotFoundException,
                                                BackupNotFoundException,
                                                InternalServerErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FSxException
```
    Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
    This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need to create one manually via DescribeBackupsRequest.builder()
    Parameters:
    
    describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request. The request object for DescribeBackups operation.
    
    Returns:
    
    Result of the DescribeBackups operation returned by the service.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeBackupsPaginator
```
default DescribeBackupsIterable describeBackupsPaginator()
                                                  throws BadRequestException,
                                                         FileSystemNotFoundException,
                                                         BackupNotFoundException,
                                                         InternalServerErrorException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         FSxException
```
    Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
    This is a variant of describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
     for (software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation.
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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.
    
    AwsServiceException
    
    See Also:
    
    describeBackupsPaginator(DescribeBackupsRequest), AWS API Documentation
  - describeBackupsPaginator
```
default DescribeBackupsIterable describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)
                                                  throws BadRequestException,
                                                         FileSystemNotFoundException,
                                                         BackupNotFoundException,
                                                         InternalServerErrorException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         FSxException
```
    Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
    This is a variant of describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
     for (software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    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 DescribeBackups operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeBackupsPaginator
```
default DescribeBackupsIterable describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
                                                  throws BadRequestException,
                                                         FileSystemNotFoundException,
                                                         BackupNotFoundException,
                                                         InternalServerErrorException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         FSxException
```
    Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
    This is a variant of describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
     for (software.amazon.awssdk.services.fsx.model.DescribeBackupsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    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 DescribeBackups operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BadRequestException - A generic error indicating a failure with a client request.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeFileSystems
```
default DescribeFileSystemsResponse describeFileSystems()
                                                 throws BadRequestException,
                                                        FileSystemNotFoundException,
                                                        InternalServerErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FSxException
```
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
    Returns:
    
    Result of the DescribeFileSystems operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    describeFileSystems(DescribeFileSystemsRequest), AWS API Documentation
  - describeFileSystems
```
default DescribeFileSystemsResponse describeFileSystems(DescribeFileSystemsRequest describeFileSystemsRequest)
                                                 throws BadRequestException,
                                                        FileSystemNotFoundException,
                                                        InternalServerErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FSxException
```
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
    Parameters:
    
    describeFileSystemsRequest - The request object for DescribeFileSystems operation.
    
    Returns:
    
    Result of the DescribeFileSystems operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeFileSystems
```
default DescribeFileSystemsResponse describeFileSystems(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)
                                                 throws BadRequestException,
                                                        FileSystemNotFoundException,
                                                        InternalServerErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FSxException
```
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
    This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the need to create one manually via DescribeFileSystemsRequest.builder()
    Parameters:
    
    describeFileSystemsRequest - A Consumer that will call methods on DescribeFileSystemsRequest.Builder to create a request. The request object for DescribeFileSystems operation.
    
    Returns:
    
    Result of the DescribeFileSystems operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeFileSystemsPaginator
```
default DescribeFileSystemsIterable describeFileSystemsPaginator()
                                                          throws BadRequestException,
                                                                 FileSystemNotFoundException,
                                                                 InternalServerErrorException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 FSxException
```
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
    This is a variant of describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client
             .describeFileSystemsPaginator(request);
     for (software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation.
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    describeFileSystemsPaginator(DescribeFileSystemsRequest), AWS API Documentation
  - describeFileSystemsPaginator
```
default DescribeFileSystemsIterable describeFileSystemsPaginator(DescribeFileSystemsRequest describeFileSystemsRequest)
                                                          throws BadRequestException,
                                                                 FileSystemNotFoundException,
                                                                 InternalServerErrorException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 FSxException
```
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
    This is a variant of describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client
             .describeFileSystemsPaginator(request);
     for (software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    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 iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeFileSystemsPaginator
```
default DescribeFileSystemsIterable describeFileSystemsPaginator(Consumer<DescribeFileSystemsRequest.Builder> describeFileSystemsRequest)
                                                          throws BadRequestException,
                                                                 FileSystemNotFoundException,
                                                                 InternalServerErrorException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 FSxException
```
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
    This is a variant of describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client
             .describeFileSystemsPaginator(request);
     for (software.amazon.awssdk.services.fsx.model.DescribeFileSystemsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemsIterable responses = client.describeFileSystemsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    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 iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        ResourceNotFoundException,
                                                        NotServiceResourceErrorException,
                                                        ResourceDoesNotSupportTaggingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FSxException
```
    Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
    
    When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.
    Parameters:
    
    listTagsForResourceRequest - The request object for ListTagsForResource operation.
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        ResourceNotFoundException,
                                                        NotServiceResourceErrorException,
                                                        ResourceDoesNotSupportTaggingException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FSxException
```
    Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
    
    When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
    
    When using this action, keep the following in mind:
    - The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
    - The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.
    This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()
    Parameters:
    
    listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. The request object for ListTagsForResource operation.
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws BadRequestException,
                                        InternalServerErrorException,
                                        ResourceNotFoundException,
                                        NotServiceResourceErrorException,
                                        ResourceDoesNotSupportTaggingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        FSxException
```
    Tags an Amazon FSx resource.
    
    Parameters:
    
    tagResourceRequest - The request object for the TagResource operation.
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws BadRequestException,
                                        InternalServerErrorException,
                                        ResourceNotFoundException,
                                        NotServiceResourceErrorException,
                                        ResourceDoesNotSupportTaggingException,
                                        AwsServiceException,
                                        SdkClientException,
                                        FSxException
```
    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:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ResourceNotFoundException,
                                            NotServiceResourceErrorException,
                                            ResourceDoesNotSupportTaggingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            FSxException
```
    This action removes a tag from an Amazon FSx resource.
    
    Parameters:
    
    untagResourceRequest - The request object for UntagResource action.
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ResourceNotFoundException,
                                            NotServiceResourceErrorException,
                                            ResourceDoesNotSupportTaggingException,
                                            AwsServiceException,
                                            SdkClientException,
                                            FSxException
```
    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:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - updateFileSystem
```
default UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
                                           throws BadRequestException,
                                                  IncompatibleParameterErrorException,
                                                  InternalServerErrorException,
                                                  FileSystemNotFoundException,
                                                  MissingFileSystemConfigurationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FSxException
```
    Updates a file system configuration.
    
    Parameters:
    
    updateFileSystemRequest - The request object for the UpdateFileSystem operation.
    
    Returns:
    
    Result of the UpdateFileSystem operation returned by the service.
    
    Throws:
    
    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.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.
    
    MissingFileSystemConfigurationException - 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - updateFileSystem
```
default UpdateFileSystemResponse updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
                                           throws BadRequestException,
                                                  IncompatibleParameterErrorException,
                                                  InternalServerErrorException,
                                                  FileSystemNotFoundException,
                                                  MissingFileSystemConfigurationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FSxException
```
    Updates a file system configuration.
    
    This is a convenience which creates an instance of the UpdateFileSystemRequest.Builder avoiding the need to create one manually via UpdateFileSystemRequest.builder()
    
    Parameters:
    
    updateFileSystemRequest - A Consumer that will call methods on UpdateFileSystemRequest.Builder to create a request. The request object for the UpdateFileSystem operation.
    
    Returns:
    
    Result of the UpdateFileSystem operation returned by the service.
    
    Throws:
    
    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.
    
    FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.
    
    MissingFileSystemConfigurationException - 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.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - serviceMetadata
```
static ServiceMetadata serviceMetadata()
```

Interface FSxClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Field Detail

SERVICE_NAME

Method Detail

create

builder

createBackup

createBackup

createFileSystem

createFileSystem

createFileSystemFromBackup

createFileSystemFromBackup

deleteBackup

deleteBackup

deleteFileSystem

deleteFileSystem

describeBackups

describeBackups

describeBackups

describeBackupsPaginator

describeBackupsPaginator

describeBackupsPaginator

describeFileSystems

describeFileSystems

describeFileSystems

describeFileSystemsPaginator

describeFileSystemsPaginator

describeFileSystemsPaginator

listTagsForResource

listTagsForResource

tagResource

tagResource

untagResource

untagResource

updateFileSystem

updateFileSystem

serviceMetadata