AbstractAmazonFSx (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.AbstractAmazonFSx

All Implemented Interfaces:

AmazonFSx

Direct Known Subclasses:

AbstractAmazonFSxAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonFSx
extends Object
implements AmazonFSx
```
Abstract implementation of AmazonFSx. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.fsx.AmazonFSx
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateFileSystemAliasesResult`	`associateFileSystemAliases(AssociateFileSystemAliasesRequest request)` Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system.
`CancelDataRepositoryTaskResult`	`cancelDataRepositoryTask(CancelDataRepositoryTaskRequest request)` Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the `PENDING` or `EXECUTING` state.
`CopyBackupResult`	`copyBackup(CopyBackupRequest request)` Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).
`CreateBackupResult`	`createBackup(CreateBackupRequest request)` Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume.
`CreateDataRepositoryTaskResult`	`createDataRepositoryTask(CreateDataRepositoryTaskRequest request)` Creates an Amazon FSx for Lustre data repository task.
`CreateFileSystemResult`	`createFileSystem(CreateFileSystemRequest request)` Creates a new, empty Amazon FSx file system.
`CreateFileSystemFromBackupResult`	`createFileSystemFromBackup(CreateFileSystemFromBackupRequest request)` Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx backup.
`CreateStorageVirtualMachineResult`	`createStorageVirtualMachine(CreateStorageVirtualMachineRequest request)` Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
`CreateVolumeResult`	`createVolume(CreateVolumeRequest request)` Creates an Amazon FSx for NetApp ONTAP storage volume.
`CreateVolumeFromBackupResult`	`createVolumeFromBackup(CreateVolumeFromBackupRequest request)` Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
`DeleteBackupResult`	`deleteBackup(DeleteBackupRequest request)` Deletes an Amazon FSx backup, deleting its contents.
`DeleteFileSystemResult`	`deleteFileSystem(DeleteFileSystemRequest request)` Deletes a file system, deleting its contents.
`DeleteStorageVirtualMachineResult`	`deleteStorageVirtualMachine(DeleteStorageVirtualMachineRequest request)` Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).
`DeleteVolumeResult`	`deleteVolume(DeleteVolumeRequest request)` Deletes an Amazon FSx for NetApp ONTAP volume.
`DescribeBackupsResult`	`describeBackups(DescribeBackupsRequest request)` Returns the description of specific Amazon FSx backups, if a `BackupIds` value is provided for that backup.
`DescribeDataRepositoryTasksResult`	`describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest request)` Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more `TaskIds` values are provided in the request, or if filters are used in the request.
`DescribeFileSystemAliasesResult`	`describeFileSystemAliases(DescribeFileSystemAliasesRequest request)` Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
`DescribeFileSystemsResult`	`describeFileSystems(DescribeFileSystemsRequest request)` Returns the description of specific Amazon FSx file systems, if a `FileSystemIds` value is provided for that file system.
`DescribeStorageVirtualMachinesResult`	`describeStorageVirtualMachines(DescribeStorageVirtualMachinesRequest request)` Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
`DescribeVolumesResult`	`describeVolumes(DescribeVolumesRequest request)` Describes one or more Amazon FSx for NetApp ONTAP volumes.
`DisassociateFileSystemAliasesResult`	`disassociateFileSystemAliases(DisassociateFileSystemAliasesRequest request)` Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Tags an Amazon FSx resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` This action removes a tag from an Amazon FSx resource.
`UpdateFileSystemResult`	`updateFileSystem(UpdateFileSystemRequest request)` Use this operation to update the configuration of an existing Amazon FSx file system.
`UpdateStorageVirtualMachineResult`	`updateStorageVirtualMachine(UpdateStorageVirtualMachineRequest request)` Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
`UpdateVolumeResult`	`updateVolume(UpdateVolumeRequest request)` Updates an Amazon FSx for NetApp ONTAP volume's configuration.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateFileSystemAliases
```
public AssociateFileSystemAliasesResult associateFileSystemAliases(AssociateFileSystemAliasesRequest request)
```
    Description copied from interface: AmazonFSx
    
    Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
    
    The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
    
    Specified by:
    
    associateFileSystemAliases in interface AmazonFSx
    
    Parameters:
    
    request - The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
    
    Returns:
    
    Result of the AssociateFileSystemAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelDataRepositoryTask
```
public CancelDataRepositoryTaskResult cancelDataRepositoryTask(CancelDataRepositoryTaskRequest request)
```
    Description copied from interface: AmazonFSx
    Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.
    - Any files that FSx has already exported are not reverted.
    - FSx continues to export any files that are "in-flight" when the cancel operation is received.
    - FSx does not export any files that have not yet been exported.
    Specified by:
    
    cancelDataRepositoryTask in interface AmazonFSx
    
    Parameters:
    
    request - Cancels a data repository task.
    
    Returns:
    
    Result of the CancelDataRepositoryTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copyBackup
```
public CopyBackupResult copyBackup(CopyBackupRequest request)
```
    Description copied from interface: AmazonFSx
    
    Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
    
    You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition.
    
    You can also use backup copies to clone your file data set to another Region or within the same Region.
    
    You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).
    
    For more information on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide.
    
    Specified by:
    
    copyBackup in interface AmazonFSx
    
    Returns:
    
    Result of the CopyBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackup
```
public CreateBackupResult createBackup(CreateBackupRequest request)
```
    Description copied from interface: AmazonFSx
    Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume.
    
    For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
    - a Persistent deployment type
    - is not linked to a data repository.
    For more information about backups, see the following:
    - For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
    - For Amazon FSx for Windows, see Working with FSx for Windows backups.
    - For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
    If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
    - Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the backup.
    By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
    
    The CreateBackup operation returns while the backup's lifecycle state is still CREATING . You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
    Specified by:
    
    createBackup in interface AmazonFSx
    
    Parameters:
    
    request - The request object for the CreateBackup operation.
    
    Returns:
    
    Result of the CreateBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataRepositoryTask
```
public CreateDataRepositoryTaskResult createDataRepositoryTask(CreateDataRepositoryTaskRequest request)
```
    Description copied from interface: AmazonFSx
    
    Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
    
    Specified by:
    
    createDataRepositoryTask in interface AmazonFSx
    
    Returns:
    
    Result of the CreateDataRepositoryTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFileSystem
```
public CreateFileSystemResult createFileSystem(CreateFileSystemRequest request)
```
    Description copied from interface: AmazonFSx
    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.
    Specified by:
    
    createFileSystem in interface AmazonFSx
    
    Parameters:
    
    request - The request object used to create a new Amazon FSx file system.
    
    Returns:
    
    Result of the CreateFileSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFileSystemFromBackup
```
public CreateFileSystemFromBackupResult createFileSystemFromBackup(CreateFileSystemFromBackupRequest request)
```
    Description copied from interface: AmazonFSx
    Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx backup.
    
    If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
    - Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
    - Returns the description of the file system.
    Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
    
    By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
    
    The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
    Specified by:
    
    createFileSystemFromBackup in interface AmazonFSx
    
    Parameters:
    
    request - The request object for the CreateFileSystemFromBackup operation.
    
    Returns:
    
    Result of the CreateFileSystemFromBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStorageVirtualMachine
```
public CreateStorageVirtualMachineResult createStorageVirtualMachine(CreateStorageVirtualMachineRequest request)
```
    Description copied from interface: AmazonFSx
    
    Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
    
    Specified by:
    
    createStorageVirtualMachine in interface AmazonFSx
    
    Returns:
    
    Result of the CreateStorageVirtualMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createVolume
```
public CreateVolumeResult createVolume(CreateVolumeRequest request)
```
    Description copied from interface: AmazonFSx
    
    Creates an Amazon FSx for NetApp ONTAP storage volume.
    
    Specified by:
    
    createVolume in interface AmazonFSx
    
    Returns:
    
    Result of the CreateVolume operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createVolumeFromBackup
```
public CreateVolumeFromBackupResult createVolumeFromBackup(CreateVolumeFromBackupRequest request)
```
    Description copied from interface: AmazonFSx
    
    Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
    
    Specified by:
    
    createVolumeFromBackup in interface AmazonFSx
    
    Returns:
    
    Result of the CreateVolumeFromBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackup
```
public DeleteBackupResult deleteBackup(DeleteBackupRequest request)
```
    Description copied from interface: AmazonFSx
    
    Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.
    
    The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.
    
    The data in a deleted backup is also deleted and can't be recovered by any means.
    
    Specified by:
    
    deleteBackup in interface AmazonFSx
    
    Parameters:
    
    request - The request object for DeleteBackup operation.
    
    Returns:
    
    Result of the DeleteBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFileSystem
```
public DeleteFileSystemResult deleteFileSystem(DeleteFileSystemRequest request)
```
    Description copied from interface: AmazonFSx
    
    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.
    
    To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.
    
    By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
    
    The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
    
    Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.
    
    The data in a deleted file system is also deleted and can't be recovered by any means.
    
    Specified by:
    
    deleteFileSystem in interface AmazonFSx
    
    Parameters:
    
    request - The request object for DeleteFileSystem operation.
    
    Returns:
    
    Result of the DeleteFileSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStorageVirtualMachine
```
public DeleteStorageVirtualMachineResult deleteStorageVirtualMachine(DeleteStorageVirtualMachineRequest request)
```
    Description copied from interface: AmazonFSx
    
    Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
    
    Specified by:
    
    deleteStorageVirtualMachine in interface AmazonFSx
    
    Returns:
    
    Result of the DeleteStorageVirtualMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteVolume
```
public DeleteVolumeResult deleteVolume(DeleteVolumeRequest request)
```
    Description copied from interface: AmazonFSx
    
    Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have fsx:TagResource permission in order to apply tags to the backup.
    
    Specified by:
    
    deleteVolume in interface AmazonFSx
    
    Returns:
    
    Result of the DeleteVolume operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBackups
```
public DescribeBackupsResult describeBackups(DescribeBackupsRequest request)
```
    Description copied from interface: AmazonFSx
    Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
    
    When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of 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 backup 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.
    Specified by:
    
    describeBackups in interface AmazonFSx
    
    Parameters:
    
    request - The request object for DescribeBackups operation.
    
    Returns:
    
    Result of the DescribeBackups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataRepositoryTasks
```
public DescribeDataRepositoryTasksResult describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest request)
```
    Description copied from interface: AmazonFSx
    
    Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
    
    When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, 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.
    
    Specified by:
    
    describeDataRepositoryTasks in interface AmazonFSx
    
    Returns:
    
    Result of the DescribeDataRepositoryTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeFileSystemAliases
```
public DescribeFileSystemAliasesResult describeFileSystemAliases(DescribeFileSystemAliasesRequest request)
```
    Description copied from interface: AmazonFSx
    
    Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
    
    Specified by:
    
    describeFileSystemAliases in interface AmazonFSx
    
    Parameters:
    
    request - The request object for DescribeFileSystemAliases operation.
    
    Returns:
    
    Result of the DescribeFileSystemAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeFileSystems
```
public DescribeFileSystemsResult describeFileSystems(DescribeFileSystemsRequest request)
```
    Description copied from interface: AmazonFSx
    Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
    
    When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
    
    This 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.
    Specified by:
    
    describeFileSystems in interface AmazonFSx
    
    Parameters:
    
    request - The request object for DescribeFileSystems operation.
    
    Returns:
    
    Result of the DescribeFileSystems operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStorageVirtualMachines
```
public DescribeStorageVirtualMachinesResult describeStorageVirtualMachines(DescribeStorageVirtualMachinesRequest request)
```
    Description copied from interface: AmazonFSx
    
    Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
    
    Specified by:
    
    describeStorageVirtualMachines in interface AmazonFSx
    
    Returns:
    
    Result of the DescribeStorageVirtualMachines operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeVolumes
```
public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
```
    Description copied from interface: AmazonFSx
    
    Describes one or more Amazon FSx for NetApp ONTAP volumes.
    
    Specified by:
    
    describeVolumes in interface AmazonFSx
    
    Returns:
    
    Result of the DescribeVolumes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateFileSystemAliases
```
public DisassociateFileSystemAliasesResult disassociateFileSystemAliases(DisassociateFileSystemAliasesRequest request)
```
    Description copied from interface: AmazonFSx
    
    Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.
    
    The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
    
    Specified by:
    
    disassociateFileSystemAliases in interface AmazonFSx
    
    Parameters:
    
    request - The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
    
    Returns:
    
    Result of the DisassociateFileSystemAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonFSx
    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.
    Specified by:
    
    listTagsForResource in interface AmazonFSx
    
    Parameters:
    
    request - The request object for ListTagsForResource operation.
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonFSx
    
    Tags an Amazon FSx resource.
    
    Specified by:
    
    tagResource in interface AmazonFSx
    
    Parameters:
    
    request - The request object for the TagResource operation.
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonFSx
    
    This action removes a tag from an Amazon FSx resource.
    
    Specified by:
    
    untagResource in interface AmazonFSx
    
    Parameters:
    
    request - The request object for UntagResource action.
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFileSystem
```
public UpdateFileSystemResult updateFileSystem(UpdateFileSystemRequest request)
```
    Description copied from interface: AmazonFSx
    Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
    
    For Amazon FSx for Windows File Server file systems, you can update the following properties:
    - AuditLogConfiguration
    - AutomaticBackupRetentionDays
    - DailyAutomaticBackupStartTime
    - SelfManagedActiveDirectoryConfiguration
    - StorageCapacity
    - ThroughputCapacity
    - WeeklyMaintenanceStartTime
    For Amazon FSx for Lustre file systems, you can update the following properties:
    - AutoImportPolicy
    - AutomaticBackupRetentionDays
    - DailyAutomaticBackupStartTime
    - DataCompressionType
    - StorageCapacity
    - WeeklyMaintenanceStartTime
    For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
    - AutomaticBackupRetentionDays
    - DailyAutomaticBackupStartTime
    - FsxAdminPassword
    - WeeklyMaintenanceStartTime
    Specified by:
    
    updateFileSystem in interface AmazonFSx
    
    Parameters:
    
    request - The request object for the UpdateFileSystem operation.
    
    Returns:
    
    Result of the UpdateFileSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStorageVirtualMachine
```
public UpdateStorageVirtualMachineResult updateStorageVirtualMachine(UpdateStorageVirtualMachineRequest request)
```
    Description copied from interface: AmazonFSx
    
    Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
    
    Specified by:
    
    updateStorageVirtualMachine in interface AmazonFSx
    
    Returns:
    
    Result of the UpdateStorageVirtualMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateVolume
```
public UpdateVolumeResult updateVolume(UpdateVolumeRequest request)
```
    Description copied from interface: AmazonFSx
    
    Updates an Amazon FSx for NetApp ONTAP volume's configuration.
    
    Specified by:
    
    updateVolume in interface AmazonFSx
    
    Returns:
    
    Result of the UpdateVolume operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonFSx
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonFSx
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonFSx
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonFSx
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonFSx

Field Summary

Fields inherited from interface com.amazonaws.services.fsx.AmazonFSx

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateFileSystemAliases

cancelDataRepositoryTask

copyBackup

createBackup

createDataRepositoryTask

createFileSystem

createFileSystemFromBackup

createStorageVirtualMachine

createVolume

createVolumeFromBackup

deleteBackup

deleteFileSystem

deleteStorageVirtualMachine

deleteVolume

describeBackups

describeDataRepositoryTasks

describeFileSystemAliases

describeFileSystems

describeStorageVirtualMachines

describeVolumes

disassociateFileSystemAliases

listTagsForResource

tagResource

untagResource

updateFileSystem

updateStorageVirtualMachine

updateVolume

shutdown

getCachedResponseMetadata