@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface FSxClient extends AwsClient
builder() method.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateFileSystemAliasesResponse |
associateFileSystemAliases(AssociateFileSystemAliasesRequest associateFileSystemAliasesRequest)
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows
File Server file system.
|
default AssociateFileSystemAliasesResponse |
associateFileSystemAliases(Consumer<AssociateFileSystemAliasesRequest.Builder> associateFileSystemAliasesRequest)
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows
File Server file system.
|
static FSxClientBuilder |
builder()
Create a builder that can be used to configure and create a
FSxClient. |
default CancelDataRepositoryTaskResponse |
cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING state. |
default CancelDataRepositoryTaskResponse |
cancelDataRepositoryTask(Consumer<CancelDataRepositoryTaskRequest.Builder> cancelDataRepositoryTaskRequest)
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
PENDING
or EXECUTING state. |
default CopyBackupResponse |
copyBackup(Consumer<CopyBackupRequest.Builder> copyBackupRequest)
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region
(cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).
|
default CopyBackupResponse |
copyBackup(CopyBackupRequest copyBackupRequest)
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region
(cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).
|
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, Amazon FSx for Lustre file
system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.
|
default CreateBackupResponse |
createBackup(CreateBackupRequest createBackupRequest)
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file
system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.
|
default CreateDataRepositoryAssociationResponse |
createDataRepositoryAssociation(Consumer<CreateDataRepositoryAssociationRequest.Builder> createDataRepositoryAssociationRequest)
Creates an Amazon FSx for Lustre data repository association (DRA).
|
default CreateDataRepositoryAssociationResponse |
createDataRepositoryAssociation(CreateDataRepositoryAssociationRequest createDataRepositoryAssociationRequest)
Creates an Amazon FSx for Lustre data repository association (DRA).
|
default CreateDataRepositoryTaskResponse |
createDataRepositoryTask(Consumer<CreateDataRepositoryTaskRequest.Builder> createDataRepositoryTaskRequest)
Creates an Amazon FSx for Lustre data repository task.
|
default CreateDataRepositoryTaskResponse |
createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest)
Creates an Amazon FSx for Lustre data repository task.
|
default CreateFileCacheResponse |
createFileCache(Consumer<CreateFileCacheRequest.Builder> createFileCacheRequest)
Creates a new Amazon File Cache resource.
|
default CreateFileCacheResponse |
createFileCache(CreateFileCacheRequest createFileCacheRequest)
Creates a new Amazon File Cache resource.
|
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 for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system
from an existing Amazon FSx backup.
|
default CreateFileSystemFromBackupResponse |
createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest)
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system
from an existing Amazon FSx backup.
|
default CreateSnapshotResponse |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a snapshot of an existing Amazon FSx for OpenZFS volume.
|
default CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a snapshot of an existing Amazon FSx for OpenZFS volume.
|
default CreateStorageVirtualMachineResponse |
createStorageVirtualMachine(Consumer<CreateStorageVirtualMachineRequest.Builder> createStorageVirtualMachineRequest)
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
|
default CreateStorageVirtualMachineResponse |
createStorageVirtualMachine(CreateStorageVirtualMachineRequest createStorageVirtualMachineRequest)
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
|
default CreateVolumeResponse |
createVolume(Consumer<CreateVolumeRequest.Builder> createVolumeRequest)
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
|
default CreateVolumeResponse |
createVolume(CreateVolumeRequest createVolumeRequest)
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
|
default CreateVolumeFromBackupResponse |
createVolumeFromBackup(Consumer<CreateVolumeFromBackupRequest.Builder> createVolumeFromBackupRequest)
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
|
default CreateVolumeFromBackupResponse |
createVolumeFromBackup(CreateVolumeFromBackupRequest createVolumeFromBackupRequest)
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
|
default DeleteBackupResponse |
deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes an Amazon FSx backup.
|
default DeleteBackupResponse |
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes an Amazon FSx backup.
|
default DeleteDataRepositoryAssociationResponse |
deleteDataRepositoryAssociation(Consumer<DeleteDataRepositoryAssociationRequest.Builder> deleteDataRepositoryAssociationRequest)
Deletes a data repository association on an Amazon FSx for Lustre file system.
|
default DeleteDataRepositoryAssociationResponse |
deleteDataRepositoryAssociation(DeleteDataRepositoryAssociationRequest deleteDataRepositoryAssociationRequest)
Deletes a data repository association on an Amazon FSx for Lustre file system.
|
default DeleteFileCacheResponse |
deleteFileCache(Consumer<DeleteFileCacheRequest.Builder> deleteFileCacheRequest)
Deletes an Amazon File Cache resource.
|
default DeleteFileCacheResponse |
deleteFileCache(DeleteFileCacheRequest deleteFileCacheRequest)
Deletes an Amazon File Cache resource.
|
default DeleteFileSystemResponse |
deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest)
Deletes a file system.
|
default DeleteFileSystemResponse |
deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest)
Deletes a file system.
|
default DeleteSnapshotResponse |
deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
Deletes an Amazon FSx for OpenZFS snapshot.
|
default DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes an Amazon FSx for OpenZFS snapshot.
|
default DeleteStorageVirtualMachineResponse |
deleteStorageVirtualMachine(Consumer<DeleteStorageVirtualMachineRequest.Builder> deleteStorageVirtualMachineRequest)
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).
|
default DeleteStorageVirtualMachineResponse |
deleteStorageVirtualMachine(DeleteStorageVirtualMachineRequest deleteStorageVirtualMachineRequest)
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).
|
default DeleteVolumeResponse |
deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
|
default DeleteVolumeResponse |
deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
|
default DescribeBackupsResponse |
describeBackups()
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsResponse |
describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsResponse |
describeBackups(DescribeBackupsRequest describeBackupsRequest)
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsIterable |
describeBackupsPaginator()
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsIterable |
describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that
backup. |
default DescribeBackupsIterable |
describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that
backup. |
default DescribeDataRepositoryAssociationsResponse |
describeDataRepositoryAssociations(Consumer<DescribeDataRepositoryAssociationsRequest.Builder> describeDataRepositoryAssociationsRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more
AssociationIds values are provided in the request, or if filters are used in the
request. |
default DescribeDataRepositoryAssociationsResponse |
describeDataRepositoryAssociations(DescribeDataRepositoryAssociationsRequest describeDataRepositoryAssociationsRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more
AssociationIds values are provided in the request, or if filters are used in the
request. |
default DescribeDataRepositoryAssociationsIterable |
describeDataRepositoryAssociationsPaginator(Consumer<DescribeDataRepositoryAssociationsRequest.Builder> describeDataRepositoryAssociationsRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more
AssociationIds values are provided in the request, or if filters are used in the
request. |
default DescribeDataRepositoryAssociationsIterable |
describeDataRepositoryAssociationsPaginator(DescribeDataRepositoryAssociationsRequest describeDataRepositoryAssociationsRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more
AssociationIds values are provided in the request, or if filters are used in the
request. |
default DescribeDataRepositoryTasksResponse |
describeDataRepositoryTasks(Consumer<DescribeDataRepositoryTasksRequest.Builder> describeDataRepositoryTasksRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more
TaskIds values are provided in the request, or if filters are used in the request. |
default DescribeDataRepositoryTasksResponse |
describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more
TaskIds values are provided in the request, or if filters are used in the request. |
default DescribeDataRepositoryTasksIterable |
describeDataRepositoryTasksPaginator(Consumer<DescribeDataRepositoryTasksRequest.Builder> describeDataRepositoryTasksRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more
TaskIds values are provided in the request, or if filters are used in the request. |
default DescribeDataRepositoryTasksIterable |
describeDataRepositoryTasksPaginator(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest)
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more
TaskIds values are provided in the request, or if filters are used in the request. |
default DescribeFileCachesResponse |
describeFileCaches(Consumer<DescribeFileCachesRequest.Builder> describeFileCachesRequest)
Returns the description of a specific Amazon File Cache resource, if a
FileCacheIds value is
provided for that cache. |
default DescribeFileCachesResponse |
describeFileCaches(DescribeFileCachesRequest describeFileCachesRequest)
Returns the description of a specific Amazon File Cache resource, if a
FileCacheIds value is
provided for that cache. |
default DescribeFileCachesIterable |
describeFileCachesPaginator(Consumer<DescribeFileCachesRequest.Builder> describeFileCachesRequest)
Returns the description of a specific Amazon File Cache resource, if a
FileCacheIds value is
provided for that cache. |
default DescribeFileCachesIterable |
describeFileCachesPaginator(DescribeFileCachesRequest describeFileCachesRequest)
Returns the description of a specific Amazon File Cache resource, if a
FileCacheIds value is
provided for that cache. |
default DescribeFileSystemAliasesResponse |
describeFileSystemAliases(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default DescribeFileSystemAliasesResponse |
describeFileSystemAliases(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default DescribeFileSystemAliasesIterable |
describeFileSystemAliasesPaginator(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
default DescribeFileSystemAliasesIterable |
describeFileSystemAliasesPaginator(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest)
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.
|
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 DescribeSnapshotsResponse |
describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds value is
provided. |
default DescribeSnapshotsResponse |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds value is
provided. |
default DescribeSnapshotsIterable |
describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds value is
provided. |
default DescribeSnapshotsIterable |
describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds value is
provided. |
default DescribeStorageVirtualMachinesResponse |
describeStorageVirtualMachines(Consumer<DescribeStorageVirtualMachinesRequest.Builder> describeStorageVirtualMachinesRequest)
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
default DescribeStorageVirtualMachinesResponse |
describeStorageVirtualMachines(DescribeStorageVirtualMachinesRequest describeStorageVirtualMachinesRequest)
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
default DescribeStorageVirtualMachinesIterable |
describeStorageVirtualMachinesPaginator(Consumer<DescribeStorageVirtualMachinesRequest.Builder> describeStorageVirtualMachinesRequest)
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
default DescribeStorageVirtualMachinesIterable |
describeStorageVirtualMachinesPaginator(DescribeStorageVirtualMachinesRequest describeStorageVirtualMachinesRequest)
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
default DescribeVolumesResponse |
describeVolumes(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest)
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
|
default DescribeVolumesResponse |
describeVolumes(DescribeVolumesRequest describeVolumesRequest)
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
|
default DescribeVolumesIterable |
describeVolumesPaginator(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest)
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
|
default DescribeVolumesIterable |
describeVolumesPaginator(DescribeVolumesRequest describeVolumesRequest)
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
|
default DisassociateFileSystemAliasesResponse |
disassociateFileSystemAliases(Consumer<DisassociateFileSystemAliasesRequest.Builder> disassociateFileSystemAliasesRequest)
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for
Windows File Server file system.
|
default DisassociateFileSystemAliasesResponse |
disassociateFileSystemAliases(DisassociateFileSystemAliasesRequest disassociateFileSystemAliasesRequest)
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for
Windows File Server file system.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists tags for Amazon FSx resources.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for Amazon FSx resources.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists tags for Amazon FSx resources.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for Amazon FSx resources.
|
default ReleaseFileSystemNfsV3LocksResponse |
releaseFileSystemNfsV3Locks(Consumer<ReleaseFileSystemNfsV3LocksRequest.Builder> releaseFileSystemNfsV3LocksRequest)
Releases the file system lock from an Amazon FSx for OpenZFS file system.
|
default ReleaseFileSystemNfsV3LocksResponse |
releaseFileSystemNfsV3Locks(ReleaseFileSystemNfsV3LocksRequest releaseFileSystemNfsV3LocksRequest)
Releases the file system lock from an Amazon FSx for OpenZFS file system.
|
default RestoreVolumeFromSnapshotResponse |
restoreVolumeFromSnapshot(Consumer<RestoreVolumeFromSnapshotRequest.Builder> restoreVolumeFromSnapshotRequest)
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
|
default RestoreVolumeFromSnapshotResponse |
restoreVolumeFromSnapshot(RestoreVolumeFromSnapshotRequest restoreVolumeFromSnapshotRequest)
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
|
default FSxServiceClientConfiguration |
serviceClientConfiguration() |
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 UpdateDataRepositoryAssociationResponse |
updateDataRepositoryAssociation(Consumer<UpdateDataRepositoryAssociationRequest.Builder> updateDataRepositoryAssociationRequest)
Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.
|
default UpdateDataRepositoryAssociationResponse |
updateDataRepositoryAssociation(UpdateDataRepositoryAssociationRequest updateDataRepositoryAssociationRequest)
Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.
|
default UpdateFileCacheResponse |
updateFileCache(Consumer<UpdateFileCacheRequest.Builder> updateFileCacheRequest)
Updates the configuration of an existing Amazon File Cache resource.
|
default UpdateFileCacheResponse |
updateFileCache(UpdateFileCacheRequest updateFileCacheRequest)
Updates the configuration of an existing Amazon File Cache resource.
|
default UpdateFileSystemResponse |
updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
default UpdateFileSystemResponse |
updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest)
Use this operation to update the configuration of an existing Amazon FSx file system.
|
default UpdateSnapshotResponse |
updateSnapshot(Consumer<UpdateSnapshotRequest.Builder> updateSnapshotRequest)
Updates the name of an Amazon FSx for OpenZFS snapshot.
|
default UpdateSnapshotResponse |
updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest)
Updates the name of an Amazon FSx for OpenZFS snapshot.
|
default UpdateStorageVirtualMachineResponse |
updateStorageVirtualMachine(Consumer<UpdateStorageVirtualMachineRequest.Builder> updateStorageVirtualMachineRequest)
Updates an FSx for ONTAP storage virtual machine (SVM).
|
default UpdateStorageVirtualMachineResponse |
updateStorageVirtualMachine(UpdateStorageVirtualMachineRequest updateStorageVirtualMachineRequest)
Updates an FSx for ONTAP storage virtual machine (SVM).
|
default UpdateVolumeResponse |
updateVolume(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest)
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
|
default UpdateVolumeResponse |
updateVolume(UpdateVolumeRequest updateVolumeRequest)
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AssociateFileSystemAliasesResponse associateFileSystemAliases(AssociateFileSystemAliasesRequest associateFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
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.
associateFileSystemAliasesRequest - The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File
Server file system.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.AwsServiceExceptiondefault AssociateFileSystemAliasesResponse associateFileSystemAliases(Consumer<AssociateFileSystemAliasesRequest.Builder> associateFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
This is a convenience which creates an instance of the AssociateFileSystemAliasesRequest.Builder avoiding
the need to create one manually via AssociateFileSystemAliasesRequest.builder()
associateFileSystemAliasesRequest - A Consumer that will call methods on
AssociateFileSystemAliasesRequest.Builder to create a
request. The request object specifying one or more DNS alias names to associate with an Amazon FSx for
Windows File Server file system.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.AwsServiceExceptiondefault CancelDataRepositoryTaskResponse cancelDataRepositoryTask(CancelDataRepositoryTaskRequest cancelDataRepositoryTaskRequest) throws BadRequestException, UnsupportedOperationException, DataRepositoryTaskNotFoundException, DataRepositoryTaskEndedException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING
or EXECUTING state. When you cancel am export task, Amazon FSx does the following.
Any files that FSx has already exported are not reverted.
FSx continues to export any files that are in-flight when the cancel operation is received.
FSx does not export any files that have not yet been exported.
For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.
cancelDataRepositoryTaskRequest - Cancels a data repository task.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.DataRepositoryTaskEndedException - The data repository task could not be canceled because the task has already ended.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CancelDataRepositoryTaskResponse cancelDataRepositoryTask(Consumer<CancelDataRepositoryTaskRequest.Builder> cancelDataRepositoryTaskRequest) throws BadRequestException, UnsupportedOperationException, DataRepositoryTaskNotFoundException, DataRepositoryTaskEndedException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING
or EXECUTING state. When you cancel am export task, Amazon FSx does the following.
Any files that FSx has already exported are not reverted.
FSx continues to export any files that are in-flight when the cancel operation is received.
FSx does not export any files that have not yet been exported.
For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.
This is a convenience which creates an instance of the CancelDataRepositoryTaskRequest.Builder avoiding
the need to create one manually via CancelDataRepositoryTaskRequest.builder()
cancelDataRepositoryTaskRequest - A Consumer that will call methods on
CancelDataRepositoryTaskRequest.Builder to create a
request. Cancels a data repository task.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.DataRepositoryTaskEndedException - The data repository task could not be canceled because the task has already ended.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CopyBackupResponse copyBackup(CopyBackupRequest copyBackupRequest) throws BadRequestException, BackupNotFoundException, ServiceLimitExceededException, UnsupportedOperationException, IncompatibleParameterErrorException, InternalServerErrorException, InvalidSourceKmsKeyException, InvalidDestinationKmsKeyException, InvalidRegionException, SourceBackupUnavailableException, IncompatibleRegionForMultiAzException, AwsServiceException, SdkClientException, FSxException
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and
copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup
and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon
Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions:
aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web
Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the
backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy
a backup from the us-east-2 Region, you specify us-east-2 in the
SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy
is created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.
copyBackupRequest - BadRequestException - A generic error indicating a failure with a client request.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.UnsupportedOperationException - The requested operation is not supported for this resource or API.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.InvalidSourceKmsKeyException - The Key Management Service (KMS) key of the source backup is not valid.InvalidDestinationKmsKeyException - The Key Management Service (KMS) key of the destination backup is not valid.InvalidRegionException - The Region provided for SourceRegion is not valid or is in a different Amazon Web Services
partition.SourceBackupUnavailableException - The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.IncompatibleRegionForMultiAzException - Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the
copied backup can't be restored.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CopyBackupResponse copyBackup(Consumer<CopyBackupRequest.Builder> copyBackupRequest) throws BadRequestException, BackupNotFoundException, ServiceLimitExceededException, UnsupportedOperationException, IncompatibleParameterErrorException, InternalServerErrorException, InvalidSourceKmsKeyException, InvalidDestinationKmsKeyException, InvalidRegionException, SourceBackupUnavailableException, IncompatibleRegionForMultiAzException, AwsServiceException, SdkClientException, FSxException
Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and
copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup
and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon
Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions:
aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web
Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the
backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy
a backup from the us-east-2 Region, you specify us-east-2 in the
SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy
is created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.
This is a convenience which creates an instance of the CopyBackupRequest.Builder avoiding the need to
create one manually via CopyBackupRequest.builder()
copyBackupRequest - A Consumer that will call methods on
CopyBackupRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.UnsupportedOperationException - The requested operation is not supported for this resource or API.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.InvalidSourceKmsKeyException - The Key Management Service (KMS) key of the source backup is not valid.InvalidDestinationKmsKeyException - The Key Management Service (KMS) key of the destination backup is not valid.InvalidRegionException - The Region provided for SourceRegion is not valid or is in a different Amazon Web Services
partition.SourceBackupUnavailableException - The request was rejected because the lifecycle status of the source backup isn't AVAILABLE.IncompatibleRegionForMultiAzException - Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the
copied backup can't be restored.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateBackupResponse createBackup(CreateBackupRequest createBackupRequest) throws BadRequestException, UnsupportedOperationException, FileSystemNotFoundException, VolumeNotFoundException, BackupInProgressException, IncompatibleParameterErrorException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:
A Persistent deployment type
Are not linked to a data repository
For more information about backups, see the following:
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.
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS 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 with the specified client request token exists and the parameters
don't match, this operation returns IncompatibleParameterError. If a backup with the specified
client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of
creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear
whether a backup was created. If you use the same client request token and the initial call created a backup, the
operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's lifecycle state is still CREATING
. You can check the backup creation status by calling the DescribeBackups
operation, which returns the backup state along with other information.
createBackupRequest - The request object for the CreateBackup operation.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupInProgressException - Another backup is already under way. Wait for completion before initiating additional backups of this
file system.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateBackupResponse createBackup(Consumer<CreateBackupRequest.Builder> createBackupRequest) throws BadRequestException, UnsupportedOperationException, FileSystemNotFoundException, VolumeNotFoundException, BackupInProgressException, IncompatibleParameterErrorException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:
A Persistent deployment type
Are not linked to a data repository
For more information about backups, see the following:
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.
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS 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 with the specified client request token exists and the parameters
don't match, this operation returns IncompatibleParameterError. If a backup with the specified
client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of
creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear
whether a backup was created. If you use the same client request token and the initial call created a backup, the
operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's lifecycle state is still CREATING
. You can check the backup creation status by calling the DescribeBackups
operation, which returns the backup state along with other information.
This is a convenience which creates an instance of the CreateBackupRequest.Builder avoiding the need to
create one manually via CreateBackupRequest.builder()
createBackupRequest - A Consumer that will call methods on
CreateBackupRequest.Builder to create a request. The
request object for the CreateBackup operation.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupInProgressException - Another backup is already under way. Wait for completion before initiating additional backups of this
file system.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateDataRepositoryAssociationResponse createDataRepositoryAssociation(CreateDataRepositoryAssociationRequest createDataRepositoryAssociationRequest) throws BadRequestException, UnsupportedOperationException, FileSystemNotFoundException, IncompatibleParameterErrorException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link
between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data
repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12
and 2.15 file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on
Amazon File Cache, use the CreateFileCache operation.
createDataRepositoryAssociationRequest - BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateDataRepositoryAssociationResponse createDataRepositoryAssociation(Consumer<CreateDataRepositoryAssociationRequest.Builder> createDataRepositoryAssociationRequest) throws BadRequestException, UnsupportedOperationException, FileSystemNotFoundException, IncompatibleParameterErrorException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link
between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data
repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12
and 2.15 file systems, excluding scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on
Amazon File Cache, use the CreateFileCache operation.
This is a convenience which creates an instance of the CreateDataRepositoryAssociationRequest.Builder
avoiding the need to create one manually via CreateDataRepositoryAssociationRequest.builder()
createDataRepositoryAssociationRequest - A Consumer that will call methods on
CreateDataRepositoryAssociationRequest.Builder to create
a request.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateDataRepositoryTaskResponse createDataRepositoryTask(CreateDataRepositoryTaskRequest createDataRepositoryTaskRequest) throws BadRequestException, UnsupportedOperationException, FileSystemNotFoundException, IncompatibleParameterErrorException, ServiceLimitExceededException, InternalServerErrorException, DataRepositoryTaskExecutingException, AwsServiceException, SdkClientException, FSxException
Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will
fail if a data repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.
You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system.
To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
createDataRepositoryTaskRequest - BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.DataRepositoryTaskExecutingException - An existing data repository task is currently executing on the file system. Wait until the existing task
has completed, then create the new task.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateDataRepositoryTaskResponse createDataRepositoryTask(Consumer<CreateDataRepositoryTaskRequest.Builder> createDataRepositoryTaskRequest) throws BadRequestException, UnsupportedOperationException, FileSystemNotFoundException, IncompatibleParameterErrorException, ServiceLimitExceededException, InternalServerErrorException, DataRepositoryTaskExecutingException, AwsServiceException, SdkClientException, FSxException
Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will
fail if a data repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.
You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system.
To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
This is a convenience which creates an instance of the CreateDataRepositoryTaskRequest.Builder avoiding
the need to create one manually via CreateDataRepositoryTaskRequest.builder()
createDataRepositoryTaskRequest - A Consumer that will call methods on
CreateDataRepositoryTaskRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.DataRepositoryTaskExecutingException - An existing data repository task is currently executing on the file system. Wait until the existing task
has completed, then create the new task.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateFileCacheResponse createFileCache(CreateFileCacheRequest createFileCacheRequest) throws BadRequestException, IncompatibleParameterErrorException, InvalidNetworkSettingsException, InvalidPerUnitStorageThroughputException, ServiceLimitExceededException, InternalServerErrorException, MissingFileCacheConfigurationException, AwsServiceException, SdkClientException, FSxException
Creates a new Amazon File Cache resource.
You can use this operation with a client request token in the request that Amazon File Cache uses to ensure
idempotent creation. If a cache with the specified client request token exists and the parameters match,
CreateFileCache returns the description of the existing cache. If a cache with the specified client
request token exists and the parameters don't match, this call returns IncompatibleParameterError.
If a file cache with the specified client request token doesn't exist, CreateFileCache does the
following:
Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of
CREATING.
Returns the description of the cache in JSON format.
The CreateFileCache call returns while the cache's lifecycle state is still CREATING.
You can check the cache creation status by calling the DescribeFileCaches
operation, which returns the cache state along with other information.
createFileCacheRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InvalidPerUnitStorageThroughputException - An invalid value for PerUnitStorageThroughput was provided. Please create your file system
again, using a valid value.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.MissingFileCacheConfigurationException - A cache configuration is required for this operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFileCacheResponse createFileCache(Consumer<CreateFileCacheRequest.Builder> createFileCacheRequest) throws BadRequestException, IncompatibleParameterErrorException, InvalidNetworkSettingsException, InvalidPerUnitStorageThroughputException, ServiceLimitExceededException, InternalServerErrorException, MissingFileCacheConfigurationException, AwsServiceException, SdkClientException, FSxException
Creates a new Amazon File Cache resource.
You can use this operation with a client request token in the request that Amazon File Cache uses to ensure
idempotent creation. If a cache with the specified client request token exists and the parameters match,
CreateFileCache returns the description of the existing cache. If a cache with the specified client
request token exists and the parameters don't match, this call returns IncompatibleParameterError.
If a file cache with the specified client request token doesn't exist, CreateFileCache does the
following:
Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of
CREATING.
Returns the description of the cache in JSON format.
The CreateFileCache call returns while the cache's lifecycle state is still CREATING.
You can check the cache creation status by calling the DescribeFileCaches
operation, which returns the cache state along with other information.
This is a convenience which creates an instance of the CreateFileCacheRequest.Builder avoiding the need
to create one manually via CreateFileCacheRequest.builder()
createFileCacheRequest - A Consumer that will call methods on
CreateFileCacheRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InvalidPerUnitStorageThroughputException - An invalid value for PerUnitStorageThroughput was provided. Please create your file system
again, using a valid value.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.MissingFileCacheConfigurationException - A cache configuration is required for this operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFileSystemResponse createFileSystem(CreateFileSystemRequest createFileSystemRequest) throws BadRequestException, ActiveDirectoryErrorException, IncompatibleParameterErrorException, InvalidImportPathException, InvalidExportPathException, InvalidNetworkSettingsException, InvalidPerUnitStorageThroughputException, ServiceLimitExceededException, InternalServerErrorException, MissingFileSystemConfigurationException, AwsServiceException, SdkClientException, FSxException
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using
the CreateFileSystem API operation:
Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation.
This means that calling the operation multiple times with the same client request token has no effect. By using
the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an
extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether
a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If
you use the same client request token and the initial call created a file system, the client receives success as
long as the parameters are the same.
If a file system with the specified client request token exists and the parameters match,
CreateFileSystem returns the description of the existing file system. If a file system with the
specified client request token exists and the parameters don't match, this call returns
IncompatibleParameterError. If a file system with the specified client request token doesn't exist,
CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of
CREATING.
Returns the description of the file system in JSON format.
The CreateFileSystem call returns while the file system's lifecycle state is still
CREATING. You can check the file-system creation status by calling the DescribeFileSystems
operation, which returns the file system state along with other information.
createFileSystemRequest - The request object used to create a new Amazon FSx file system.BadRequestException - A generic error indicating a failure with a client request.ActiveDirectoryErrorException - An Active Directory error.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidImportPathException - The path provided for data repository import isn't valid.InvalidExportPathException - The path provided for data repository export isn't valid.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InvalidPerUnitStorageThroughputException - An invalid value for PerUnitStorageThroughput was provided. Please create your file system
again, using a valid value.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.MissingFileSystemConfigurationException - A file system configuration is required for this operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFileSystemResponse createFileSystem(Consumer<CreateFileSystemRequest.Builder> createFileSystemRequest) throws BadRequestException, ActiveDirectoryErrorException, IncompatibleParameterErrorException, InvalidImportPathException, InvalidExportPathException, InvalidNetworkSettingsException, InvalidPerUnitStorageThroughputException, ServiceLimitExceededException, InternalServerErrorException, MissingFileSystemConfigurationException, AwsServiceException, SdkClientException, FSxException
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using
the CreateFileSystem API operation:
Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation.
This means that calling the operation multiple times with the same client request token has no effect. By using
the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an
extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether
a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If
you use the same client request token and the initial call created a file system, the client receives success as
long as the parameters are the same.
If a file system with the specified client request token exists and the parameters match,
CreateFileSystem returns the description of the existing file system. If a file system with the
specified client request token exists and the parameters don't match, this call returns
IncompatibleParameterError. If a file system with the specified client request token doesn't exist,
CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of
CREATING.
Returns the description of the file system in JSON format.
The CreateFileSystem call returns while the file system's lifecycle state is still
CREATING. You can check the file-system creation status by calling the DescribeFileSystems
operation, which returns the file system state along with other information.
This is a convenience which creates an instance of the CreateFileSystemRequest.Builder avoiding the need
to create one manually via CreateFileSystemRequest.builder()
createFileSystemRequest - A Consumer that will call methods on
CreateFileSystemRequest.Builder to create a request. The
request object used to create a new Amazon FSx file system.BadRequestException - A generic error indicating a failure with a client request.ActiveDirectoryErrorException - An Active Directory error.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidImportPathException - The path provided for data repository import isn't valid.InvalidExportPathException - The path provided for data repository export isn't valid.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InvalidPerUnitStorageThroughputException - An invalid value for PerUnitStorageThroughput was provided. Please create your file system
again, using a valid value.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.MissingFileSystemConfigurationException - A file system configuration is required for this operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFileSystemFromBackupResponse createFileSystemFromBackup(CreateFileSystemFromBackupRequest createFileSystemFromBackupRequest) throws BadRequestException, ActiveDirectoryErrorException, IncompatibleParameterErrorException, InvalidNetworkSettingsException, InvalidPerUnitStorageThroughputException, ServiceLimitExceededException, BackupNotFoundException, InternalServerErrorException, MissingFileSystemConfigurationException, AwsServiceException, SdkClientException, FSxException
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns
the description of the file system. If a file system with the specified client request token exists but the
parameters don't match, this call returns IncompatibleParameterError. If a file system with the
specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of
CREATING.
Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk
of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it
unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection
was reset. If you use the same client request token and the initial call created a file system, the client
receives a success message as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still
CREATING. You can check the file-system creation status by calling the DescribeFileSystems
operation, which returns the file system state along with other information.
createFileSystemFromBackupRequest - The request object for the CreateFileSystemFromBackup operation.BadRequestException - A generic error indicating a failure with a client request.ActiveDirectoryErrorException - An Active Directory error.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InvalidPerUnitStorageThroughputException - An invalid value for PerUnitStorageThroughput was provided. Please create your file system
again, using a valid value.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.MissingFileSystemConfigurationException - A file system configuration is required for this operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFileSystemFromBackupResponse createFileSystemFromBackup(Consumer<CreateFileSystemFromBackupRequest.Builder> createFileSystemFromBackupRequest) throws BadRequestException, ActiveDirectoryErrorException, IncompatibleParameterErrorException, InvalidNetworkSettingsException, InvalidPerUnitStorageThroughputException, ServiceLimitExceededException, BackupNotFoundException, InternalServerErrorException, MissingFileSystemConfigurationException, AwsServiceException, SdkClientException, FSxException
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns
the description of the file system. If a file system with the specified client request token exists but the
parameters don't match, this call returns IncompatibleParameterError. If a file system with the
specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of
CREATING.
Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk
of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it
unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection
was reset. If you use the same client request token and the initial call created a file system, the client
receives a success message as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still
CREATING. You can check the file-system creation status by calling the DescribeFileSystems
operation, which returns the file system state along with other information.
This is a convenience which creates an instance of the CreateFileSystemFromBackupRequest.Builder avoiding
the need to create one manually via CreateFileSystemFromBackupRequest.builder()
createFileSystemFromBackupRequest - A Consumer that will call methods on
CreateFileSystemFromBackupRequest.Builder to create a
request. The request object for the CreateFileSystemFromBackup operation.BadRequestException - A generic error indicating a failure with a client request.ActiveDirectoryErrorException - An Active Directory error.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InvalidPerUnitStorageThroughputException - An invalid value for PerUnitStorageThroughput was provided. Please create your file system
again, using a valid value.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.MissingFileSystemConfigurationException - A file system configuration is required for this operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws BadRequestException, VolumeNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
If a snapshot with the specified client request token exists, and the parameters match, this operation returns
the description of the existing snapshot. If a snapshot with the specified client request token exists, and the
parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the
specified client request token doesn't exist, CreateSnapshot does the following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of
creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear
whether a snapshot was created. If you use the same client request token and the initial call created a snapshot,
the operation returns a successful result because all the parameters are the same.
The CreateSnapshot operation returns while the snapshot's lifecycle state is still
CREATING. You can check the snapshot creation status by calling the DescribeSnapshots
operation, which returns the snapshot state along with other information.
createSnapshotRequest - BadRequestException - A generic error indicating a failure with a client request.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws BadRequestException, VolumeNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
If a snapshot with the specified client request token exists, and the parameters match, this operation returns
the description of the existing snapshot. If a snapshot with the specified client request token exists, and the
parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the
specified client request token doesn't exist, CreateSnapshot does the following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of
creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear
whether a snapshot was created. If you use the same client request token and the initial call created a snapshot,
the operation returns a successful result because all the parameters are the same.
The CreateSnapshot operation returns while the snapshot's lifecycle state is still
CREATING. You can check the snapshot creation status by calling the DescribeSnapshots
operation, which returns the snapshot state along with other information.
This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest - A Consumer that will call methods on
CreateSnapshotRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStorageVirtualMachineResponse createStorageVirtualMachine(CreateStorageVirtualMachineRequest createStorageVirtualMachineRequest) throws ActiveDirectoryErrorException, BadRequestException, FileSystemNotFoundException, IncompatibleParameterErrorException, InternalServerErrorException, ServiceLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, FSxException
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
createStorageVirtualMachineRequest - ActiveDirectoryErrorException - An Active Directory error.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.UnsupportedOperationException - The requested operation is not supported for this resource or API.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateStorageVirtualMachineResponse createStorageVirtualMachine(Consumer<CreateStorageVirtualMachineRequest.Builder> createStorageVirtualMachineRequest) throws ActiveDirectoryErrorException, BadRequestException, FileSystemNotFoundException, IncompatibleParameterErrorException, InternalServerErrorException, ServiceLimitExceededException, UnsupportedOperationException, AwsServiceException, SdkClientException, FSxException
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
This is a convenience which creates an instance of the CreateStorageVirtualMachineRequest.Builder
avoiding the need to create one manually via CreateStorageVirtualMachineRequest.builder()
createStorageVirtualMachineRequest - A Consumer that will call methods on
CreateStorageVirtualMachineRequest.Builder to create a
request.ActiveDirectoryErrorException - An Active Directory error.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.UnsupportedOperationException - The requested operation is not supported for this resource or API.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateVolumeResponse createVolume(CreateVolumeRequest createVolumeRequest) throws BadRequestException, FileSystemNotFoundException, IncompatibleParameterErrorException, InternalServerErrorException, MissingVolumeConfigurationException, ServiceLimitExceededException, StorageVirtualMachineNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, FSxException
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
createVolumeRequest - BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.MissingVolumeConfigurationException - A volume configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.UnsupportedOperationException - The requested operation is not supported for this resource or API.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateVolumeResponse createVolume(Consumer<CreateVolumeRequest.Builder> createVolumeRequest) throws BadRequestException, FileSystemNotFoundException, IncompatibleParameterErrorException, InternalServerErrorException, MissingVolumeConfigurationException, ServiceLimitExceededException, StorageVirtualMachineNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, FSxException
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
This is a convenience which creates an instance of the CreateVolumeRequest.Builder avoiding the need to
create one manually via CreateVolumeRequest.builder()
createVolumeRequest - A Consumer that will call methods on
CreateVolumeRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.MissingVolumeConfigurationException - A volume configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.UnsupportedOperationException - The requested operation is not supported for this resource or API.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault CreateVolumeFromBackupResponse createVolumeFromBackup(CreateVolumeFromBackupRequest createVolumeFromBackupRequest) throws BackupNotFoundException, BadRequestException, FileSystemNotFoundException, IncompatibleParameterErrorException, InternalServerErrorException, MissingVolumeConfigurationException, ServiceLimitExceededException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
createVolumeFromBackupRequest - BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.MissingVolumeConfigurationException - A volume configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateVolumeFromBackupResponse createVolumeFromBackup(Consumer<CreateVolumeFromBackupRequest.Builder> createVolumeFromBackupRequest) throws BackupNotFoundException, BadRequestException, FileSystemNotFoundException, IncompatibleParameterErrorException, InternalServerErrorException, MissingVolumeConfigurationException, ServiceLimitExceededException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
This is a convenience which creates an instance of the CreateVolumeFromBackupRequest.Builder avoiding the
need to create one manually via CreateVolumeFromBackupRequest.builder()
createVolumeFromBackupRequest - A Consumer that will call methods on
CreateVolumeFromBackupRequest.Builder to create a
request.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.MissingVolumeConfigurationException - A volume configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest) throws BadRequestException, BackupInProgressException, BackupNotFoundException, BackupRestoringException, IncompatibleParameterErrorException, InternalServerErrorException, BackupBeingCopiedException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup won't show up in later
DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
deleteBackupRequest - The request object for the DeleteBackup operation.BadRequestException - A generic error indicating a failure with a client request.BackupInProgressException - Another backup is already under way. Wait for completion before initiating additional backups of this
file system.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.BackupRestoringException - You can't delete a backup while it's being used to restore a file system.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.BackupBeingCopiedException - You can't delete a backup while it's being copied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) throws BadRequestException, BackupInProgressException, BackupNotFoundException, BackupRestoringException, IncompatibleParameterErrorException, InternalServerErrorException, BackupBeingCopiedException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup won't show up in later
DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
This is a convenience which creates an instance of the DeleteBackupRequest.Builder avoiding the need to
create one manually via DeleteBackupRequest.builder()
deleteBackupRequest - A Consumer that will call methods on
DeleteBackupRequest.Builder to create a request. The
request object for the DeleteBackup operation.BadRequestException - A generic error indicating a failure with a client request.BackupInProgressException - Another backup is already under way. Wait for completion before initiating additional backups of this
file system.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.BackupRestoringException - You can't delete a backup while it's being used to restore a file system.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.BackupBeingCopiedException - You can't delete a backup while it's being copied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataRepositoryAssociationResponse deleteDataRepositoryAssociation(DeleteDataRepositoryAssociationRequest deleteDataRepositoryAssociationRequest) throws BadRequestException, IncompatibleParameterErrorException, DataRepositoryAssociationNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository
association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you
have the option of deleting the data in the file system that corresponds to the data repository association. Data
repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding
scratch_1 deployment type.
deleteDataRepositoryAssociationRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataRepositoryAssociationResponse deleteDataRepositoryAssociation(Consumer<DeleteDataRepositoryAssociationRequest.Builder> deleteDataRepositoryAssociationRequest) throws BadRequestException, IncompatibleParameterErrorException, DataRepositoryAssociationNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository
association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you
have the option of deleting the data in the file system that corresponds to the data repository association. Data
repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding
scratch_1 deployment type.
This is a convenience which creates an instance of the DeleteDataRepositoryAssociationRequest.Builder
avoiding the need to create one manually via DeleteDataRepositoryAssociationRequest.builder()
deleteDataRepositoryAssociationRequest - A Consumer that will call methods on
DeleteDataRepositoryAssociationRequest.Builder to create
a request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFileCacheResponse deleteFileCache(DeleteFileCacheRequest deleteFileCacheRequest) throws BadRequestException, IncompatibleParameterErrorException, FileCacheNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.
The DeleteFileCache operation returns while the cache has the DELETING status. You can
check the cache deletion status by calling the DescribeFileCaches
operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the
DescribeFileCaches operation returns a FileCacheNotFound error.
The data in a deleted cache is also deleted and can't be recovered by any means.
deleteFileCacheRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.FileCacheNotFoundException - No caches were found based upon supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFileCacheResponse deleteFileCache(Consumer<DeleteFileCacheRequest.Builder> deleteFileCacheRequest) throws BadRequestException, IncompatibleParameterErrorException, FileCacheNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.
The DeleteFileCache operation returns while the cache has the DELETING status. You can
check the cache deletion status by calling the DescribeFileCaches
operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the
DescribeFileCaches operation returns a FileCacheNotFound error.
The data in a deleted cache is also deleted and can't be recovered by any means.
This is a convenience which creates an instance of the DeleteFileCacheRequest.Builder avoiding the need
to create one manually via DeleteFileCacheRequest.builder()
deleteFileCacheRequest - A Consumer that will call methods on
DeleteFileCacheRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.FileCacheNotFoundException - No caches were found based upon supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest deleteFileSystemRequest) throws BadRequestException, IncompatibleParameterErrorException, FileSystemNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines
(SVMs) on the file system. Then provide a FileSystemId value to the DeleFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.
To delete an Amazon FSx for Lustre file system, first unmount it from every connected
Amazon EC2 instance, then provide a FileSystemId value to the DeleFileSystem operation.
By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked.
On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take
a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To
ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the
AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository
task. If you have automatic export enabled and want to use an export data repository task, you have to
disable automatic export before executing the export data repository task.
The DeleteFileSystem operation returns while the file system has the DELETING status.
You can check the file system deletion status by calling the DescribeFileSystems
operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted
file system, the DescribeFileSystems operation returns a FileSystemNotFound error.
If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx
for Lustre file system will fail with an HTTP status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
deleteFileSystemRequest - The request object for DeleteFileSystem operation.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFileSystemResponse deleteFileSystem(Consumer<DeleteFileSystemRequest.Builder> deleteFileSystemRequest) throws BadRequestException, IncompatibleParameterErrorException, FileSystemNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines
(SVMs) on the file system. Then provide a FileSystemId value to the DeleFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.
To delete an Amazon FSx for Lustre file system, first unmount it from every connected
Amazon EC2 instance, then provide a FileSystemId value to the DeleFileSystem operation.
By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked.
On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take
a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To
ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the
AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository
task. If you have automatic export enabled and want to use an export data repository task, you have to
disable automatic export before executing the export data repository task.
The DeleteFileSystem operation returns while the file system has the DELETING status.
You can check the file system deletion status by calling the DescribeFileSystems
operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted
file system, the DescribeFileSystems operation returns a FileSystemNotFound error.
If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx
for Lustre file system will fail with an HTTP status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
This is a convenience which creates an instance of the DeleteFileSystemRequest.Builder avoiding the need
to create one manually via DeleteFileSystemRequest.builder()
deleteFileSystemRequest - A Consumer that will call methods on
DeleteFileSystemRequest.Builder to create a request. The
request object for DeleteFileSystem operation.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws BadRequestException, InternalServerErrorException, SnapshotNotFoundException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of
DELETING until the deletion is complete.
deleteSnapshotRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteSnapshotResponse deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) throws BadRequestException, InternalServerErrorException, SnapshotNotFoundException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of
DELETING until the deletion is complete.
This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder avoiding the need to
create one manually via DeleteSnapshotRequest.builder()
deleteSnapshotRequest - A Consumer that will call methods on
DeleteSnapshotRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStorageVirtualMachineResponse deleteStorageVirtualMachine(DeleteStorageVirtualMachineRequest deleteStorageVirtualMachineRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
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.
deleteStorageVirtualMachineRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStorageVirtualMachineResponse deleteStorageVirtualMachine(Consumer<DeleteStorageVirtualMachineRequest.Builder> deleteStorageVirtualMachineRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
This is a convenience which creates an instance of the DeleteStorageVirtualMachineRequest.Builder
avoiding the need to create one manually via DeleteStorageVirtualMachineRequest.builder()
deleteStorageVirtualMachineRequest - A Consumer that will call methods on
DeleteStorageVirtualMachineRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVolumeResponse deleteVolume(DeleteVolumeRequest deleteVolumeRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, VolumeNotFoundException, ServiceLimitExceededException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
deleteVolumeRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVolumeResponse deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, VolumeNotFoundException, ServiceLimitExceededException, AwsServiceException, SdkClientException, FSxException
Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
This is a convenience which creates an instance of the DeleteVolumeRequest.Builder avoiding the need to
create one manually via DeleteVolumeRequest.builder()
deleteVolumeRequest - A Consumer that will call methods on
DeleteVolumeRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBackupsResponse describeBackups(DescribeBackupsRequest describeBackupsRequest) throws BadRequestException, FileSystemNotFoundException, VolumeNotFoundException, BackupNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still
including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the
backups returned across the responses of a multi-call iteration is unspecified.
describeBackupsRequest - The request object for the DescribeBackups operation.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBackupsResponse describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws BadRequestException, FileSystemNotFoundException, VolumeNotFoundException, BackupNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still
including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the
backups returned across the responses of a multi-call iteration is unspecified.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest - A Consumer that will call methods on
DescribeBackupsRequest.Builder to create a request. The
request object for the DescribeBackups operation.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBackupsResponse describeBackups() throws BadRequestException, FileSystemNotFoundException, VolumeNotFoundException, BackupNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still
including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the
backups returned across the responses of a multi-call iteration is unspecified.
BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeBackups(DescribeBackupsRequest),
AWS API
Documentationdefault DescribeBackupsIterable describeBackupsPaginator() throws BadRequestException, FileSystemNotFoundException, VolumeNotFoundException, BackupNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still
including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the
backups returned across the responses of a multi-call iteration is unspecified.
This is a 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation.
BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeBackupsPaginator(DescribeBackupsRequest),
AWS API
Documentationdefault DescribeBackupsIterable describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest) throws BadRequestException, FileSystemNotFoundException, VolumeNotFoundException, BackupNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still
including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the
backups returned across the responses of a multi-call iteration is unspecified.
This is a 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation.
describeBackupsRequest - The request object for the DescribeBackups operation.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeBackupsIterable describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws BadRequestException, FileSystemNotFoundException, VolumeNotFoundException, BackupNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that
backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services
Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number
of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the
response. In this case, send a later request with the NextToken request parameter set to the value
of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still
including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the
backups returned across the responses of a multi-call iteration is unspecified.
This is a 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.fsx.model.DescribeBackupsRequest) operation.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest - A Consumer that will call methods on
DescribeBackupsRequest.Builder to create a request. The
request object for the DescribeBackups operation.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.BackupNotFoundException - No Amazon FSx backups were found based upon the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryAssociationsResponse describeDataRepositoryAssociations(DescribeDataRepositoryAssociationsRequest describeDataRepositoryAssociationsRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryAssociationNotFoundException, InvalidDataRepositoryTypeException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more AssociationIds values are provided in the request, or if filters are used in the
request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12
and 2,15 file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository associations for specific file systems
(use the file-system-id filter with the ID of the file system) or caches (use the
file-cache-id filter with the ID of the cache), or data repository associations for a specific
repository type (use the data-repository-type filter with a value of S3 or
NFS). If you don't use filters, the response returns all data repository associations owned by your
Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using the optional
MaxResults parameter to limit the number of data repository associations returned in a response. If
more data repository associations remain, a NextToken value is returned in the response. In this
case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
describeDataRepositoryAssociationsRequest - BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.InvalidDataRepositoryTypeException - You have filtered the response to a data repository type that is not supported.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryAssociationsResponse describeDataRepositoryAssociations(Consumer<DescribeDataRepositoryAssociationsRequest.Builder> describeDataRepositoryAssociationsRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryAssociationNotFoundException, InvalidDataRepositoryTypeException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more AssociationIds values are provided in the request, or if filters are used in the
request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12
and 2,15 file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository associations for specific file systems
(use the file-system-id filter with the ID of the file system) or caches (use the
file-cache-id filter with the ID of the cache), or data repository associations for a specific
repository type (use the data-repository-type filter with a value of S3 or
NFS). If you don't use filters, the response returns all data repository associations owned by your
Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using the optional
MaxResults parameter to limit the number of data repository associations returned in a response. If
more data repository associations remain, a NextToken value is returned in the response. In this
case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This is a convenience which creates an instance of the DescribeDataRepositoryAssociationsRequest.Builder
avoiding the need to create one manually via DescribeDataRepositoryAssociationsRequest.builder()
describeDataRepositoryAssociationsRequest - A Consumer that will call methods on
DescribeDataRepositoryAssociationsRequest.Builder to
create a request.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.InvalidDataRepositoryTypeException - You have filtered the response to a data repository type that is not supported.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryAssociationsIterable describeDataRepositoryAssociationsPaginator(DescribeDataRepositoryAssociationsRequest describeDataRepositoryAssociationsRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryAssociationNotFoundException, InvalidDataRepositoryTypeException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more AssociationIds values are provided in the request, or if filters are used in the
request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12
and 2,15 file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository associations for specific file systems
(use the file-system-id filter with the ID of the file system) or caches (use the
file-cache-id filter with the ID of the cache), or data repository associations for a specific
repository type (use the data-repository-type filter with a value of S3 or
NFS). If you don't use filters, the response returns all data repository associations owned by your
Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using the optional
MaxResults parameter to limit the number of data repository associations returned in a response. If
more data repository associations remain, a NextToken value is returned in the response. In this
case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This is a variant of
describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest)
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.DescribeDataRepositoryAssociationsIterable responses = client.describeDataRepositoryAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryAssociationsIterable responses = client
.describeDataRepositoryAssociationsPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryAssociationsIterable responses = client.describeDataRepositoryAssociationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest)
operation.
describeDataRepositoryAssociationsRequest - BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.InvalidDataRepositoryTypeException - You have filtered the response to a data repository type that is not supported.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryAssociationsIterable describeDataRepositoryAssociationsPaginator(Consumer<DescribeDataRepositoryAssociationsRequest.Builder> describeDataRepositoryAssociationsRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryAssociationNotFoundException, InvalidDataRepositoryTypeException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if
one or more AssociationIds values are provided in the request, or if filters are used in the
request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12
and 2,15 file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository associations for specific file systems
(use the file-system-id filter with the ID of the file system) or caches (use the
file-cache-id filter with the ID of the cache), or data repository associations for a specific
repository type (use the data-repository-type filter with a value of S3 or
NFS). If you don't use filters, the response returns all data repository associations owned by your
Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using the optional
MaxResults parameter to limit the number of data repository associations returned in a response. If
more data repository associations remain, a NextToken value is returned in the response. In this
case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This is a variant of
describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest)
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.DescribeDataRepositoryAssociationsIterable responses = client.describeDataRepositoryAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryAssociationsIterable responses = client
.describeDataRepositoryAssociationsPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryAssociationsIterable responses = client.describeDataRepositoryAssociationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataRepositoryAssociations(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryAssociationsRequest)
operation.
This is a convenience which creates an instance of the DescribeDataRepositoryAssociationsRequest.Builder
avoiding the need to create one manually via DescribeDataRepositoryAssociationsRequest.builder()
describeDataRepositoryAssociationsRequest - A Consumer that will call methods on
DescribeDataRepositoryAssociationsRequest.Builder to
create a request.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.InvalidDataRepositoryTypeException - You have filtered the response to a data repository type that is not supported.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryTasksResponse describeDataRepositoryTasks(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryTaskNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more TaskIds values are provided in the request, or if filters are used in the request. You can use
filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific
lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the
Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter
to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is
returned in the response. In this case, send a later request with the NextToken request parameter
set to the value of NextToken from the last response.
describeDataRepositoryTasksRequest - BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryTasksResponse describeDataRepositoryTasks(Consumer<DescribeDataRepositoryTasksRequest.Builder> describeDataRepositoryTasksRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryTaskNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more TaskIds values are provided in the request, or if filters are used in the request. You can use
filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific
lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the
Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter
to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is
returned in the response. In this case, send a later request with the NextToken request parameter
set to the value of NextToken from the last response.
This is a convenience which creates an instance of the DescribeDataRepositoryTasksRequest.Builder
avoiding the need to create one manually via DescribeDataRepositoryTasksRequest.builder()
describeDataRepositoryTasksRequest - A Consumer that will call methods on
DescribeDataRepositoryTasksRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryTasksIterable describeDataRepositoryTasksPaginator(DescribeDataRepositoryTasksRequest describeDataRepositoryTasksRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryTaskNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more TaskIds values are provided in the request, or if filters are used in the request. You can use
filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific
lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the
Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter
to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is
returned in the response. In this case, send a later request with the NextToken request parameter
set to the value of NextToken from the last response.
This is a variant of
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
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.DescribeDataRepositoryTasksIterable responses = client.describeDataRepositoryTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksIterable responses = client
.describeDataRepositoryTasksPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksIterable responses = client.describeDataRepositoryTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
operation.
describeDataRepositoryTasksRequest - BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDataRepositoryTasksIterable describeDataRepositoryTasksPaginator(Consumer<DescribeDataRepositoryTasksRequest.Builder> describeDataRepositoryTasksRequest) throws BadRequestException, FileSystemNotFoundException, DataRepositoryTaskNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or
more TaskIds values are provided in the request, or if filters are used in the request. You can use
filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific
lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the
Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter
to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is
returned in the response. In this case, send a later request with the NextToken request parameter
set to the value of NextToken from the last response.
This is a variant of
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
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.DescribeDataRepositoryTasksIterable responses = client.describeDataRepositoryTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksIterable responses = client
.describeDataRepositoryTasksPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeDataRepositoryTasksIterable responses = client.describeDataRepositoryTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDataRepositoryTasks(software.amazon.awssdk.services.fsx.model.DescribeDataRepositoryTasksRequest)
operation.
This is a convenience which creates an instance of the DescribeDataRepositoryTasksRequest.Builder
avoiding the need to create one manually via DescribeDataRepositoryTasksRequest.builder()
describeDataRepositoryTasksRequest - A Consumer that will call methods on
DescribeDataRepositoryTasksRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.DataRepositoryTaskNotFoundException - The data repository task or tasks you specified could not be found.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFileCachesResponse describeFileCaches(DescribeFileCachesRequest describeFileCachesRequest) throws BadRequestException, FileCacheNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is
provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit
the number of descriptions in a response. If more cache descriptions remain, the operation returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache descriptions.
DescribeFileCaches is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults cache descriptions while still including a
NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches
returned across the responses of a multicall iteration is unspecified.
describeFileCachesRequest - BadRequestException - A generic error indicating a failure with a client request.FileCacheNotFoundException - No caches were found based upon supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFileCachesResponse describeFileCaches(Consumer<DescribeFileCachesRequest.Builder> describeFileCachesRequest) throws BadRequestException, FileCacheNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is
provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit
the number of descriptions in a response. If more cache descriptions remain, the operation returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache descriptions.
DescribeFileCaches is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults cache descriptions while still including a
NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches
returned across the responses of a multicall iteration is unspecified.
This is a convenience which creates an instance of the DescribeFileCachesRequest.Builder avoiding the
need to create one manually via DescribeFileCachesRequest.builder()
describeFileCachesRequest - A Consumer that will call methods on
DescribeFileCachesRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.FileCacheNotFoundException - No caches were found based upon supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFileCachesIterable describeFileCachesPaginator(DescribeFileCachesRequest describeFileCachesRequest) throws BadRequestException, FileCacheNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is
provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit
the number of descriptions in a response. If more cache descriptions remain, the operation returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache descriptions.
DescribeFileCaches is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults cache descriptions while still including a
NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches
returned across the responses of a multicall iteration is unspecified.
This is a variant of
describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) 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.DescribeFileCachesIterable responses = client.describeFileCachesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client
.describeFileCachesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client.describeFileCachesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) operation.
describeFileCachesRequest - BadRequestException - A generic error indicating a failure with a client request.FileCacheNotFoundException - No caches were found based upon supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFileCachesIterable describeFileCachesPaginator(Consumer<DescribeFileCachesRequest.Builder> describeFileCachesRequest) throws BadRequestException, FileCacheNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is
provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit
the number of descriptions in a response. If more cache descriptions remain, the operation returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache descriptions.
DescribeFileCaches is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults cache descriptions while still including a
NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches
returned across the responses of a multicall iteration is unspecified.
This is a variant of
describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) 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.DescribeFileCachesIterable responses = client.describeFileCachesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client
.describeFileCachesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeFileCachesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeFileCachesIterable responses = client.describeFileCachesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileCaches(software.amazon.awssdk.services.fsx.model.DescribeFileCachesRequest) operation.
This is a convenience which creates an instance of the DescribeFileCachesRequest.Builder avoiding the
need to create one manually via DescribeFileCachesRequest.builder()
describeFileCachesRequest - A Consumer that will call methods on
DescribeFileCachesRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.FileCacheNotFoundException - No caches were found based upon supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFileSystemAliasesResponse describeFileSystemAliases(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
describeFileSystemAliasesRequest - The request object for DescribeFileSystemAliases operation.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.AwsServiceExceptiondefault DescribeFileSystemAliasesResponse describeFileSystemAliases(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
This is a convenience which creates an instance of the DescribeFileSystemAliasesRequest.Builder avoiding
the need to create one manually via DescribeFileSystemAliasesRequest.builder()
describeFileSystemAliasesRequest - A Consumer that will call methods on
DescribeFileSystemAliasesRequest.Builder to create a
request. The request object for DescribeFileSystemAliases operation.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.AwsServiceExceptiondefault DescribeFileSystemAliasesIterable describeFileSystemAliasesPaginator(DescribeFileSystemAliasesRequest describeFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
This is a variant of
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation. The return type is a custom 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.DescribeFileSystemAliasesIterable responses = client.describeFileSystemAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesIterable responses = client
.describeFileSystemAliasesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesIterable responses = client.describeFileSystemAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation.
describeFileSystemAliasesRequest - The request object for DescribeFileSystemAliases operation.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.AwsServiceExceptiondefault DescribeFileSystemAliasesIterable describeFileSystemAliasesPaginator(Consumer<DescribeFileSystemAliasesRequest.Builder> describeFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
This is a variant of
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation. The return type is a custom 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.DescribeFileSystemAliasesIterable responses = client.describeFileSystemAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesIterable responses = client
.describeFileSystemAliasesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeFileSystemAliasesIterable responses = client.describeFileSystemAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystemAliases(software.amazon.awssdk.services.fsx.model.DescribeFileSystemAliasesRequest)
operation.
This is a convenience which creates an instance of the DescribeFileSystemAliasesRequest.Builder avoiding
the need to create one manually via DescribeFileSystemAliasesRequest.builder()
describeFileSystemAliasesRequest - A Consumer that will call methods on
DescribeFileSystemAliasesRequest.Builder to create a
request. The request object for DescribeFileSystemAliases operation.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.AwsServiceExceptiondefault 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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
describeFileSystemsRequest - The request object for DescribeFileSystems operation.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.AwsServiceExceptiondefault 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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the
need to create one manually via DescribeFileSystemsRequest.builder()
describeFileSystemsRequest - A Consumer that will call methods on
DescribeFileSystemsRequest.Builder to create a request.
The request object for DescribeFileSystems operation.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.AwsServiceExceptiondefault 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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
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.AwsServiceExceptiondescribeFileSystems(DescribeFileSystemsRequest),
AWS API
Documentationdefault 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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
This is a 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation.
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.AwsServiceExceptiondescribeFileSystemsPaginator(DescribeFileSystemsRequest),
AWS API
Documentationdefault 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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
This is a 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation.
describeFileSystemsRequest - The request object for DescribeFileSystems operation.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.AwsServiceExceptiondefault 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 Amazon Web Services
account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to
limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions.
DescribeFileSystems is called first without a NextTokenvalue. Then the operation
continues to be called with the NextToken parameter set to the value of the last
NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of
file systems returned across the responses of a multicall iteration is unspecified.
This is a 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(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFileSystems(software.amazon.awssdk.services.fsx.model.DescribeFileSystemsRequest) operation.
This is a convenience which creates an instance of the DescribeFileSystemsRequest.Builder avoiding the
need to create one manually via DescribeFileSystemsRequest.builder()
describeFileSystemsRequest - A Consumer that will call methods on
DescribeFileSystemsRequest.Builder to create a request.
The request object for DescribeFileSystems operation.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.AwsServiceExceptiondefault DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws BadRequestException, InternalServerErrorException, SnapshotNotFoundException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is
provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon
Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the
number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in
the response. In this case, send a later request with the NextToken request parameter set to the
value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still
including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of
backups returned across the responses of a multi-call iteration is unspecified.
describeSnapshotsRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotsResponse describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws BadRequestException, InternalServerErrorException, SnapshotNotFoundException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is
provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon
Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the
number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in
the response. In this case, send a later request with the NextToken request parameter set to the
value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still
including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of
backups returned across the responses of a multi-call iteration is unspecified.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on
DescribeSnapshotsRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotsIterable describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest) throws BadRequestException, InternalServerErrorException, SnapshotNotFoundException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is
provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon
Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the
number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in
the response. In this case, send a later request with the NextToken request parameter set to the
value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still
including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of
backups returned across the responses of a multi-call iteration is unspecified.
This is a variant of
describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) 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.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeSnapshotsIterable responses = client
.describeSnapshotsPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) operation.
describeSnapshotsRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotsIterable describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws BadRequestException, InternalServerErrorException, SnapshotNotFoundException, AwsServiceException, SdkClientException, FSxException
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is
provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon
Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the
number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in
the response. In this case, send a later request with the NextToken request parameter set to the
value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots
is called first without a NextToken value. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still
including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of
backups returned across the responses of a multi-call iteration is unspecified.
This is a variant of
describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) 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.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeSnapshotsIterable responses = client
.describeSnapshotsPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.fsx.model.DescribeSnapshotsRequest) operation.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on
DescribeSnapshotsRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageVirtualMachinesResponse describeStorageVirtualMachines(DescribeStorageVirtualMachinesRequest describeStorageVirtualMachinesRequest) throws BadRequestException, InternalServerErrorException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
describeStorageVirtualMachinesRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageVirtualMachinesResponse describeStorageVirtualMachines(Consumer<DescribeStorageVirtualMachinesRequest.Builder> describeStorageVirtualMachinesRequest) throws BadRequestException, InternalServerErrorException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
This is a convenience which creates an instance of the DescribeStorageVirtualMachinesRequest.Builder
avoiding the need to create one manually via DescribeStorageVirtualMachinesRequest.builder()
describeStorageVirtualMachinesRequest - A Consumer that will call methods on
DescribeStorageVirtualMachinesRequest.Builder to create
a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageVirtualMachinesIterable describeStorageVirtualMachinesPaginator(DescribeStorageVirtualMachinesRequest describeStorageVirtualMachinesRequest) throws BadRequestException, InternalServerErrorException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
This is a variant of
describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest)
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.DescribeStorageVirtualMachinesIterable responses = client.describeStorageVirtualMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeStorageVirtualMachinesIterable responses = client
.describeStorageVirtualMachinesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeStorageVirtualMachinesIterable responses = client.describeStorageVirtualMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest)
operation.
describeStorageVirtualMachinesRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStorageVirtualMachinesIterable describeStorageVirtualMachinesPaginator(Consumer<DescribeStorageVirtualMachinesRequest.Builder> describeStorageVirtualMachinesRequest) throws BadRequestException, InternalServerErrorException, StorageVirtualMachineNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
This is a variant of
describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest)
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.DescribeStorageVirtualMachinesIterable responses = client.describeStorageVirtualMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeStorageVirtualMachinesIterable responses = client
.describeStorageVirtualMachinesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeStorageVirtualMachinesIterable responses = client.describeStorageVirtualMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStorageVirtualMachines(software.amazon.awssdk.services.fsx.model.DescribeStorageVirtualMachinesRequest)
operation.
This is a convenience which creates an instance of the DescribeStorageVirtualMachinesRequest.Builder
avoiding the need to create one manually via DescribeStorageVirtualMachinesRequest.builder()
describeStorageVirtualMachinesRequest - A Consumer that will call methods on
DescribeStorageVirtualMachinesRequest.Builder to create
a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVolumesResponse describeVolumes(DescribeVolumesRequest describeVolumesRequest) throws BadRequestException, InternalServerErrorException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
describeVolumesRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVolumesResponse describeVolumes(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest) throws BadRequestException, InternalServerErrorException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
This is a convenience which creates an instance of the DescribeVolumesRequest.Builder avoiding the need
to create one manually via DescribeVolumesRequest.builder()
describeVolumesRequest - A Consumer that will call methods on
DescribeVolumesRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVolumesIterable describeVolumesPaginator(DescribeVolumesRequest describeVolumesRequest) throws BadRequestException, InternalServerErrorException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
This is a variant of describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest)
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.DescribeVolumesIterable responses = client.describeVolumesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeVolumesIterable responses = client.describeVolumesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeVolumesIterable responses = client.describeVolumesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest) operation.
describeVolumesRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVolumesIterable describeVolumesPaginator(Consumer<DescribeVolumesRequest.Builder> describeVolumesRequest) throws BadRequestException, InternalServerErrorException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
This is a variant of describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest)
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.DescribeVolumesIterable responses = client.describeVolumesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.DescribeVolumesIterable responses = client.describeVolumesPaginator(request);
for (software.amazon.awssdk.services.fsx.model.DescribeVolumesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.DescribeVolumesIterable responses = client.describeVolumesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeVolumes(software.amazon.awssdk.services.fsx.model.DescribeVolumesRequest) operation.
This is a convenience which creates an instance of the DescribeVolumesRequest.Builder avoiding the need
to create one manually via DescribeVolumesRequest.builder()
describeVolumesRequest - A Consumer that will call methods on
DescribeVolumesRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateFileSystemAliasesResponse disassociateFileSystemAliases(DisassociateFileSystemAliasesRequest disassociateFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
disassociateFileSystemAliasesRequest - The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.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.AwsServiceExceptiondefault DisassociateFileSystemAliasesResponse disassociateFileSystemAliases(Consumer<DisassociateFileSystemAliasesRequest.Builder> disassociateFileSystemAliasesRequest) throws BadRequestException, FileSystemNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
This is a convenience which creates an instance of the DisassociateFileSystemAliasesRequest.Builder
avoiding the need to create one manually via DisassociateFileSystemAliasesRequest.builder()
disassociateFileSystemAliasesRequest - A Consumer that will call methods on
DisassociateFileSystemAliasesRequest.Builder to create a
request. The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file
system.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, ResourceNotFoundException, NotServiceResourceErrorException, ResourceDoesNotSupportTaggingException, AwsServiceException, SdkClientException, FSxException
Lists tags for Amazon FSx resources.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of
tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In
this case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags
returned across the responses of a multi-call iteration is unspecified.
listTagsForResourceRequest - The request object for ListTagsForResource operation.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, ResourceNotFoundException, NotServiceResourceErrorException, ResourceDoesNotSupportTaggingException, AwsServiceException, SdkClientException, FSxException
Lists tags for Amazon FSx resources.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of
tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In
this case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags
returned across the responses of a multi-call iteration is unspecified.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a request.
The request object for ListTagsForResource operation.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.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, ResourceNotFoundException, NotServiceResourceErrorException, ResourceDoesNotSupportTaggingException, AwsServiceException, SdkClientException, FSxException
Lists tags for Amazon FSx resources.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of
tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In
this case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags
returned across the responses of a multi-call iteration is unspecified.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) 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.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.fsx.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) operation.
listTagsForResourceRequest - The request object for ListTagsForResource operation.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.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, InternalServerErrorException, ResourceNotFoundException, NotServiceResourceErrorException, ResourceDoesNotSupportTaggingException, AwsServiceException, SdkClientException, FSxException
Lists tags for Amazon FSx resources.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of
tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In
this case, send a later request with the NextToken request parameter set to the value of
NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is
called first without a NextTokenvalue. Then the action continues to be called with the
NextToken parameter set to the value of the last NextToken value until a response has
no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including
a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags
returned across the responses of a multi-call iteration is unspecified.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) 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.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.fsx.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.fsx.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.fsx.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.fsx.model.ListTagsForResourceRequest) operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a request.
The request object for ListTagsForResource operation.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.AwsServiceExceptiondefault ReleaseFileSystemNfsV3LocksResponse releaseFileSystemNfsV3Locks(ReleaseFileSystemNfsV3LocksRequest releaseFileSystemNfsV3LocksRequest) throws BadRequestException, IncompatibleParameterErrorException, FileSystemNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Releases the file system lock from an Amazon FSx for OpenZFS file system.
releaseFileSystemNfsV3LocksRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ReleaseFileSystemNfsV3LocksResponse releaseFileSystemNfsV3Locks(Consumer<ReleaseFileSystemNfsV3LocksRequest.Builder> releaseFileSystemNfsV3LocksRequest) throws BadRequestException, IncompatibleParameterErrorException, FileSystemNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Releases the file system lock from an Amazon FSx for OpenZFS file system.
This is a convenience which creates an instance of the ReleaseFileSystemNfsV3LocksRequest.Builder
avoiding the need to create one manually via ReleaseFileSystemNfsV3LocksRequest.builder()
releaseFileSystemNfsV3LocksRequest - A Consumer that will call methods on
ReleaseFileSystemNfsV3LocksRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreVolumeFromSnapshotResponse restoreVolumeFromSnapshot(RestoreVolumeFromSnapshotRequest restoreVolumeFromSnapshotRequest) throws BadRequestException, InternalServerErrorException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
restoreVolumeFromSnapshotRequest - BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreVolumeFromSnapshotResponse restoreVolumeFromSnapshot(Consumer<RestoreVolumeFromSnapshotRequest.Builder> restoreVolumeFromSnapshotRequest) throws BadRequestException, InternalServerErrorException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
This is a convenience which creates an instance of the RestoreVolumeFromSnapshotRequest.Builder avoiding
the need to create one manually via RestoreVolumeFromSnapshotRequest.builder()
restoreVolumeFromSnapshotRequest - A Consumer that will call methods on
RestoreVolumeFromSnapshotRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.InternalServerErrorException - A generic error indicating a server-side failure.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, InternalServerErrorException, ResourceNotFoundException, NotServiceResourceErrorException, ResourceDoesNotSupportTaggingException, AwsServiceException, SdkClientException, FSxException
Tags an Amazon FSx resource.
tagResourceRequest - The request object for the TagResource operation.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.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request. The
request object for the TagResource operation.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws BadRequestException, InternalServerErrorException, ResourceNotFoundException, NotServiceResourceErrorException, ResourceDoesNotSupportTaggingException, AwsServiceException, SdkClientException, FSxException
This action removes a tag from an Amazon FSx resource.
untagResourceRequest - The request object for UntagResource action.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.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request. The
request object for UntagResource action.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.AwsServiceExceptiondefault UpdateDataRepositoryAssociationResponse updateDataRepositoryAssociation(UpdateDataRepositoryAssociationRequest updateDataRepositoryAssociationRequest) throws BadRequestException, IncompatibleParameterErrorException, DataRepositoryAssociationNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.
Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding
scratch_1 deployment type.
updateDataRepositoryAssociationRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataRepositoryAssociationResponse updateDataRepositoryAssociation(Consumer<UpdateDataRepositoryAssociationRequest.Builder> updateDataRepositoryAssociationRequest) throws BadRequestException, IncompatibleParameterErrorException, DataRepositoryAssociationNotFoundException, ServiceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.
Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding
scratch_1 deployment type.
This is a convenience which creates an instance of the UpdateDataRepositoryAssociationRequest.Builder
avoiding the need to create one manually via UpdateDataRepositoryAssociationRequest.builder()
updateDataRepositoryAssociationRequest - A Consumer that will call methods on
UpdateDataRepositoryAssociationRequest.Builder to create
a request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.DataRepositoryAssociationNotFoundException - No data repository associations were found based upon the supplied parameters.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFileCacheResponse updateFileCache(UpdateFileCacheRequest updateFileCacheRequest) throws BadRequestException, UnsupportedOperationException, IncompatibleParameterErrorException, InternalServerErrorException, FileCacheNotFoundException, MissingFileCacheConfigurationException, ServiceLimitExceededException, AwsServiceException, SdkClientException, FSxException
Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
updateFileCacheRequest - BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.FileCacheNotFoundException - No caches were found based upon supplied parameters.MissingFileCacheConfigurationException - A cache configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateFileCacheResponse updateFileCache(Consumer<UpdateFileCacheRequest.Builder> updateFileCacheRequest) throws BadRequestException, UnsupportedOperationException, IncompatibleParameterErrorException, InternalServerErrorException, FileCacheNotFoundException, MissingFileCacheConfigurationException, ServiceLimitExceededException, AwsServiceException, SdkClientException, FSxException
Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
This is a convenience which creates an instance of the UpdateFileCacheRequest.Builder avoiding the need
to create one manually via UpdateFileCacheRequest.builder()
updateFileCacheRequest - A Consumer that will call methods on
UpdateFileCacheRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.FileCacheNotFoundException - No caches were found based upon supplied parameters.MissingFileCacheConfigurationException - A cache configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest updateFileSystemRequest) throws BadRequestException, UnsupportedOperationException, IncompatibleParameterErrorException, InvalidNetworkSettingsException, InternalServerErrorException, FileSystemNotFoundException, MissingFileSystemConfigurationException, ServiceLimitExceededException, AwsServiceException, SdkClientException, FSxException
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
updateFileSystemRequest - The request object for the UpdateFileSystem operation.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InternalServerErrorException - A generic error indicating a server-side failure.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.MissingFileSystemConfigurationException - A file system configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateFileSystemResponse updateFileSystem(Consumer<UpdateFileSystemRequest.Builder> updateFileSystemRequest) throws BadRequestException, UnsupportedOperationException, IncompatibleParameterErrorException, InvalidNetworkSettingsException, InternalServerErrorException, FileSystemNotFoundException, MissingFileSystemConfigurationException, ServiceLimitExceededException, AwsServiceException, SdkClientException, FSxException
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
This is a convenience which creates an instance of the UpdateFileSystemRequest.Builder avoiding the need
to create one manually via UpdateFileSystemRequest.builder()
updateFileSystemRequest - A Consumer that will call methods on
UpdateFileSystemRequest.Builder to create a request. The
request object for the UpdateFileSystem operation.BadRequestException - A generic error indicating a failure with a client request.UnsupportedOperationException - The requested operation is not supported for this resource or API.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InvalidNetworkSettingsException - One or more network settings specified in the request are invalid.InternalServerErrorException - A generic error indicating a server-side failure.FileSystemNotFoundException - No Amazon FSx file systems were found based upon supplied parameters.MissingFileSystemConfigurationException - A file system configuration is required for this operation.ServiceLimitExceededException - An error indicating that a particular service limit was exceeded. You can increase some service limits by
contacting Amazon Web Services Support.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateSnapshotResponse updateSnapshot(UpdateSnapshotRequest updateSnapshotRequest) throws BadRequestException, SnapshotNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Updates the name of an Amazon FSx for OpenZFS snapshot.
updateSnapshotRequest - BadRequestException - A generic error indicating a failure with a client request.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateSnapshotResponse updateSnapshot(Consumer<UpdateSnapshotRequest.Builder> updateSnapshotRequest) throws BadRequestException, SnapshotNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, FSxException
Updates the name of an Amazon FSx for OpenZFS snapshot.
This is a convenience which creates an instance of the UpdateSnapshotRequest.Builder avoiding the need to
create one manually via UpdateSnapshotRequest.builder()
updateSnapshotRequest - A Consumer that will call methods on
UpdateSnapshotRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.SnapshotNotFoundException - No Amazon FSx snapshots were found based on the supplied parameters.InternalServerErrorException - A generic error indicating a server-side failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStorageVirtualMachineResponse updateStorageVirtualMachine(UpdateStorageVirtualMachineRequest updateStorageVirtualMachineRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, StorageVirtualMachineNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, FSxException
Updates an FSx for ONTAP storage virtual machine (SVM).
updateStorageVirtualMachineRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.UnsupportedOperationException - The requested operation is not supported for this resource or API.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateStorageVirtualMachineResponse updateStorageVirtualMachine(Consumer<UpdateStorageVirtualMachineRequest.Builder> updateStorageVirtualMachineRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, StorageVirtualMachineNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, FSxException
Updates an FSx for ONTAP storage virtual machine (SVM).
This is a convenience which creates an instance of the UpdateStorageVirtualMachineRequest.Builder
avoiding the need to create one manually via UpdateStorageVirtualMachineRequest.builder()
updateStorageVirtualMachineRequest - A Consumer that will call methods on
UpdateStorageVirtualMachineRequest.Builder to create a
request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.StorageVirtualMachineNotFoundException - No FSx for ONTAP SVMs were found based upon the supplied parameters.UnsupportedOperationException - The requested operation is not supported for this resource or API.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault UpdateVolumeResponse updateVolume(UpdateVolumeRequest updateVolumeRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, MissingVolumeConfigurationException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
updateVolumeRequest - BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.MissingVolumeConfigurationException - A volume configuration is required for this operation.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateVolumeResponse updateVolume(Consumer<UpdateVolumeRequest.Builder> updateVolumeRequest) throws BadRequestException, IncompatibleParameterErrorException, InternalServerErrorException, MissingVolumeConfigurationException, VolumeNotFoundException, AwsServiceException, SdkClientException, FSxException
Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
This is a convenience which creates an instance of the UpdateVolumeRequest.Builder avoiding the need to
create one manually via UpdateVolumeRequest.builder()
updateVolumeRequest - A Consumer that will call methods on
UpdateVolumeRequest.Builder to create a request.BadRequestException - A generic error indicating a failure with a client request.IncompatibleParameterErrorException - The error returned when a second request is received with the same client request token but different
parameters settings. A client request token should always uniquely identify a single request.InternalServerErrorException - A generic error indicating a server-side failure.MissingVolumeConfigurationException - A volume configuration is required for this operation.VolumeNotFoundException - No Amazon FSx volumes were found based upon the supplied parameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.FSxException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic FSxClient create()
FSxClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static FSxClientBuilder builder()
FSxClient.static ServiceMetadata serviceMetadata()
default FSxServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.