| Class | Description |
|---|---|
| ActiveDirectoryBackupAttributes |
The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.
|
| AdministrativeAction |
Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system
or volume.
|
| AdministrativeActionFailureDetails |
Provides information about a failed administrative action.
|
| AggregateConfiguration |
Used to specify configuration options for a volume’s storage aggregate or aggregates.
|
| Alias |
A DNS alias that is associated 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.
|
| AssociateFileSystemAliasesResult |
The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file
system.
|
| AutocommitPeriod |
Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines how long the files must
remain unmodified before they're automatically transitioned to the write once, read many (WORM) state.
|
| AutoExportPolicy |
Describes a data repository association's automatic export policy.
|
| AutoImportPolicy |
Describes the data repository association's automatic import policy.
|
| Backup |
A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP
volume, or Amazon FSx for OpenZFS file system.
|
| BackupFailureDetails |
If backup creation fails, this structure contains the details of that failure.
|
| CancelDataRepositoryTaskRequest |
Cancels a data repository task.
|
| CancelDataRepositoryTaskResult | |
| CompletionReport |
Provides a report detailing the data repository task results of the files processed that match the criteria specified
in the report
Scope parameter. |
| CopyBackupRequest | |
| CopyBackupResult | |
| CopySnapshotAndUpdateVolumeRequest | |
| CopySnapshotAndUpdateVolumeResult | |
| CreateAggregateConfiguration |
Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
|
| CreateBackupRequest |
The request object for the
CreateBackup operation. |
| CreateBackupResult |
The response object for the
CreateBackup operation. |
| CreateDataRepositoryAssociationRequest | |
| CreateDataRepositoryAssociationResult | |
| CreateDataRepositoryTaskRequest | |
| CreateDataRepositoryTaskResult | |
| CreateFileCacheLustreConfiguration |
The Amazon File Cache configuration for the cache that you are creating.
|
| CreateFileCacheRequest | |
| CreateFileCacheResult | |
| CreateFileSystemFromBackupRequest |
The request object for the
CreateFileSystemFromBackup operation. |
| CreateFileSystemFromBackupResult |
The response object for the
CreateFileSystemFromBackup operation. |
| CreateFileSystemLustreConfiguration |
The Lustre configuration for the file system being created.
|
| CreateFileSystemLustreMetadataConfiguration |
The Lustre metadata performance configuration for the creation of an Amazon FSx for Lustre file system using a
PERSISTENT_2 deployment type. |
| CreateFileSystemOntapConfiguration |
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
|
| CreateFileSystemOpenZFSConfiguration |
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
|
| CreateFileSystemRequest |
The request object used to create a new Amazon FSx file system.
|
| CreateFileSystemResult |
The response object returned after the file system is created.
|
| CreateFileSystemWindowsConfiguration |
The configuration object for the Microsoft Windows file system used in
CreateFileSystem and
CreateFileSystemFromBackup operations. |
| CreateOntapVolumeConfiguration |
Specifies the configuration of the ONTAP volume that you are creating.
|
| CreateOpenZFSOriginSnapshotConfiguration |
The snapshot configuration to use when creating an Amazon FSx for OpenZFS volume from a snapshot.
|
| CreateOpenZFSVolumeConfiguration |
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
|
| CreateSnaplockConfiguration |
Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.
|
| CreateSnapshotRequest | |
| CreateSnapshotResult | |
| CreateStorageVirtualMachineRequest | |
| CreateStorageVirtualMachineResult | |
| CreateSvmActiveDirectoryConfiguration |
The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed
(including on-premises) Microsoft Active Directory directory.
|
| CreateVolumeFromBackupRequest | |
| CreateVolumeFromBackupResult | |
| CreateVolumeRequest | |
| CreateVolumeResult | |
| DataRepositoryAssociation |
The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3
bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system.
|
| DataRepositoryConfiguration |
The data repository configuration object for Lustre file systems returned in the response of the
CreateFileSystem operation. |
| DataRepositoryFailureDetails |
Provides detailed information about the data repository if its
Lifecycle is set to
MISCONFIGURED or FAILED. |
| DataRepositoryTask |
A description of the data repository task.
|
| DataRepositoryTaskFailureDetails |
Provides information about why a data repository task failed.
|
| DataRepositoryTaskFilter |
(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the
the response.
|
| DataRepositoryTaskStatus |
Provides the task status showing a running total of the total number of files to be processed, the number
successfully processed, and the number of files the task failed to process.
|
| DeleteBackupRequest |
The request object for the
DeleteBackup operation. |
| DeleteBackupResult |
The response object for the
DeleteBackup operation. |
| DeleteDataRepositoryAssociationRequest | |
| DeleteDataRepositoryAssociationResult | |
| DeleteFileCacheRequest | |
| DeleteFileCacheResult | |
| DeleteFileSystemLustreConfiguration |
The configuration object for the Amazon FSx for Lustre file system being deleted in the
DeleteFileSystem
operation. |
| DeleteFileSystemLustreResponse |
The response object for the Amazon FSx for Lustre file system being deleted in the
DeleteFileSystem
operation. |
| DeleteFileSystemOpenZFSConfiguration |
The configuration object for the Amazon FSx for OpenZFS file system used in the
DeleteFileSystem
operation. |
| DeleteFileSystemOpenZFSResponse |
The response object for the Amazon FSx for OpenZFS file system that's being deleted in the
DeleteFileSystem operation. |
| DeleteFileSystemRequest |
The request object for
DeleteFileSystem operation. |
| DeleteFileSystemResult |
The response object for the
DeleteFileSystem operation. |
| DeleteFileSystemWindowsConfiguration |
The configuration object for the Microsoft Windows file system used in the
DeleteFileSystem operation. |
| DeleteFileSystemWindowsResponse |
The response object for the Microsoft Windows file system used in the
DeleteFileSystem operation. |
| DeleteSnapshotRequest | |
| DeleteSnapshotResult | |
| DeleteStorageVirtualMachineRequest | |
| DeleteStorageVirtualMachineResult | |
| DeleteVolumeOntapConfiguration |
Use to specify skipping a final backup, adding tags to a final backup, or bypassing the retention period of an FSx
for ONTAP SnapLock Enterprise volume when deleting an FSx for ONTAP volume.
|
| DeleteVolumeOntapResponse |
The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the
DeleteVolume
operation. |
| DeleteVolumeOpenZFSConfiguration |
A value that specifies whether to delete all child volumes and snapshots.
|
| DeleteVolumeRequest | |
| DeleteVolumeResult | |
| DescribeBackupsRequest |
The request object for the
DescribeBackups operation. |
| DescribeBackupsResult |
Response object for the
DescribeBackups operation. |
| DescribeDataRepositoryAssociationsRequest | |
| DescribeDataRepositoryAssociationsResult | |
| DescribeDataRepositoryTasksRequest | |
| DescribeDataRepositoryTasksResult | |
| DescribeFileCachesRequest | |
| DescribeFileCachesResult | |
| DescribeFileSystemAliasesRequest |
The request object for
DescribeFileSystemAliases operation. |
| DescribeFileSystemAliasesResult |
The response object for
DescribeFileSystemAliases operation. |
| DescribeFileSystemsRequest |
The request object for
DescribeFileSystems operation. |
| DescribeFileSystemsResult |
The response object for
DescribeFileSystems operation. |
| DescribeSharedVpcConfigurationRequest | |
| DescribeSharedVpcConfigurationResult | |
| DescribeSnapshotsRequest | |
| DescribeSnapshotsResult | |
| DescribeStorageVirtualMachinesRequest | |
| DescribeStorageVirtualMachinesResult | |
| DescribeVolumesRequest | |
| DescribeVolumesResult | |
| DisassociateFileSystemAliasesRequest |
The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
|
| DisassociateFileSystemAliasesResult |
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file
system.
|
| DiskIopsConfiguration |
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for
Windows File Server, or FSx for OpenZFS file system.
|
| DurationSinceLastAccess |
Defines the minimum amount of time since last access for a file to be eligible for release.
|
| FileCache |
A description of a specific Amazon File Cache resource, which is a response object from the
DescribeFileCaches operation. |
| FileCacheCreating |
The response object for the Amazon File Cache resource being created in the
CreateFileCache operation. |
| FileCacheDataRepositoryAssociation |
The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource
creation.
|
| FileCacheFailureDetails |
A structure providing details of any failures that occurred.
|
| FileCacheLustreConfiguration |
The configuration for the Amazon File Cache resource.
|
| FileCacheLustreMetadataConfiguration |
The configuration for a Lustre MDT (Metadata Target) storage volume.
|
| FileCacheNFSConfiguration |
The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache
resource.
|
| FileSystem |
A description of a specific Amazon FSx file system.
|
| FileSystemEndpoint |
An Amazon FSx for NetApp ONTAP file system has two endpoints that are used to access data or to manage the file
system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
|
| FileSystemEndpoints |
An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the
file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
|
| FileSystemFailureDetails |
A structure providing details of any failures that occurred.
|
| FileSystemLustreMetadataConfiguration |
The Lustre metadata performance configuration of an Amazon FSx for Lustre file system using a
PERSISTENT_2 deployment type. |
| Filter |
A filter used to restrict the results of describe calls.
|
| LifecycleTransitionReason |
Describes why a resource lifecycle state changed.
|
| ListTagsForResourceRequest |
The request object for
ListTagsForResource operation. |
| ListTagsForResourceResult |
The response object for
ListTagsForResource operation. |
| LustreFileSystemConfiguration |
The configuration for the Amazon FSx for Lustre file system.
|
| LustreLogConfiguration |
The configuration for Lustre logging used to write the enabled logging events for your Amazon FSx for Lustre file
system or Amazon File Cache resource to Amazon CloudWatch Logs.
|
| LustreLogCreateConfiguration |
The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system.
|
| LustreRootSquashConfiguration |
The configuration for Lustre root squash used to restrict root-level access from clients that try to access your FSx
for Lustre file system as root.
|
| NFSDataRepositoryConfiguration |
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data
repository.
|
| OntapFileSystemConfiguration |
Configuration for the FSx for NetApp ONTAP file system.
|
| OntapVolumeConfiguration |
The configuration of an Amazon FSx for NetApp ONTAP volume.
|
| OpenZFSClientConfiguration |
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
|
| OpenZFSCreateRootVolumeConfiguration |
The configuration of an Amazon FSx for OpenZFS root volume.
|
| OpenZFSFileSystemConfiguration |
The configuration for the Amazon FSx for OpenZFS file system.
|
| OpenZFSNfsExport |
The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.
|
| OpenZFSOriginSnapshotConfiguration |
The snapshot configuration used when creating an Amazon FSx for OpenZFS volume from a snapshot.
|
| OpenZFSUserOrGroupQuota |
Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume.
|
| OpenZFSVolumeConfiguration |
The configuration of an Amazon FSx for OpenZFS volume.
|
| ReleaseConfiguration |
The configuration that specifies a minimum amount of time since last access for an exported file to be eligible for
release from an Amazon FSx for Lustre file system.
|
| ReleaseFileSystemNfsV3LocksRequest | |
| ReleaseFileSystemNfsV3LocksResult | |
| RestoreVolumeFromSnapshotRequest | |
| RestoreVolumeFromSnapshotResult | |
| RetentionPeriod |
Specifies the retention period of an FSx for ONTAP SnapLock volume.
|
| S3DataRepositoryConfiguration |
The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data
repository association.
|
| SelfManagedActiveDirectoryAttributes |
The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or
ONTAP storage virtual machine (SVM) instance is joined.
|
| SelfManagedActiveDirectoryConfiguration |
The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage
virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.
|
| SelfManagedActiveDirectoryConfigurationUpdates |
Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which an FSx for
Windows File Server file system or an FSx for ONTAP SVM is joined.
|
| SnaplockConfiguration |
Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.
|
| SnaplockRetentionPeriod |
The configuration to set the retention period of an FSx for ONTAP SnapLock volume.
|
| Snapshot |
A snapshot of an Amazon FSx for OpenZFS volume.
|
| SnapshotFilter |
A filter used to restrict the results of
DescribeSnapshots calls. |
| StartMisconfiguredStateRecoveryRequest | |
| StartMisconfiguredStateRecoveryResult | |
| StorageVirtualMachine |
Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.
|
| StorageVirtualMachineFilter |
A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines
(SVMs).
|
| SvmActiveDirectoryConfiguration |
Describes the Microsoft Active Directory (AD) directory configuration to which the FSx for ONTAP storage virtual
machine (SVM) is joined.
|
| SvmEndpoint |
An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints that are used to access data or to
manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
|
| SvmEndpoints |
An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data
or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
|
| Tag |
Specifies a key-value pair for a resource tag.
|
| TagResourceRequest |
The request object for the
TagResource operation. |
| TagResourceResult |
The response object for the
TagResource operation. |
| TieringPolicy |
Describes the data tiering policy for an ONTAP volume.
|
| UntagResourceRequest |
The request object for
UntagResource action. |
| UntagResourceResult |
The response object for
UntagResource action. |
| UpdateDataRepositoryAssociationRequest | |
| UpdateDataRepositoryAssociationResult | |
| UpdateFileCacheLustreConfiguration |
The configuration update for an Amazon File Cache resource.
|
| UpdateFileCacheRequest | |
| UpdateFileCacheResult | |
| UpdateFileSystemLustreConfiguration |
The configuration object for Amazon FSx for Lustre file systems used in the
UpdateFileSystem operation. |
| UpdateFileSystemLustreMetadataConfiguration |
The Lustre metadata performance configuration update for an Amazon FSx for Lustre file system using a
PERSISTENT_2 deployment type. |
| UpdateFileSystemOntapConfiguration |
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
|
| UpdateFileSystemOpenZFSConfiguration |
The configuration updates for an Amazon FSx for OpenZFS file system.
|
| UpdateFileSystemRequest |
The request object for the
UpdateFileSystem operation. |
| UpdateFileSystemResult |
The response object for the
UpdateFileSystem operation. |
| UpdateFileSystemWindowsConfiguration |
Updates the configuration for an existing Amazon FSx for Windows File Server file system.
|
| UpdateOntapVolumeConfiguration |
Used to specify changes to the ONTAP configuration for the volume you are updating.
|
| UpdateOpenZFSVolumeConfiguration |
Used to specify changes to the OpenZFS configuration for the volume that you are updating.
|
| UpdateSharedVpcConfigurationRequest | |
| UpdateSharedVpcConfigurationResult | |
| UpdateSnaplockConfiguration |
Updates the SnapLock configuration for an existing FSx for ONTAP volume.
|
| UpdateSnapshotRequest | |
| UpdateSnapshotResult | |
| UpdateStorageVirtualMachineRequest | |
| UpdateStorageVirtualMachineResult | |
| UpdateSvmActiveDirectoryConfiguration |
Specifies updates to an FSx for ONTAP storage virtual machine's (SVM) Microsoft Active Directory (AD) configuration.
|
| UpdateVolumeRequest | |
| UpdateVolumeResult | |
| Volume |
Describes an Amazon FSx volume.
|
| VolumeFilter |
A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
volumes.
|
| WindowsAuditLogConfiguration |
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and
file shares on the Amazon FSx for Windows File Server file system.
|
| WindowsAuditLogCreateConfiguration |
The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server
file system.
|
| WindowsFileSystemConfiguration |
The configuration for this Microsoft Windows file system.
|
| Exception | Description |
|---|---|
| ActiveDirectoryErrorException |
An Active Directory error.
|
| AmazonFSxException |
Base exception for all service exceptions thrown by Amazon FSx
|
| BackupBeingCopiedException |
You can't delete a backup while it's being copied.
|
| BackupInProgressException |
Another backup is already under way.
|
| 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.
|
| BadRequestException |
A generic error indicating a failure with a client request.
|
| DataRepositoryAssociationNotFoundException |
No data repository associations were found based upon the supplied parameters.
|
| DataRepositoryTaskEndedException |
The data repository task could not be canceled because the task has already ended.
|
| DataRepositoryTaskExecutingException |
An existing data repository task is currently executing on the file system.
|
| DataRepositoryTaskNotFoundException |
The data repository task or tasks you specified could not be found.
|
| FileCacheNotFoundException |
No caches were found based upon supplied parameters.
|
| 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.
|
| 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.
|
| InternalServerErrorException |
A generic error indicating a server-side failure.
|
| InvalidDataRepositoryTypeException |
You have filtered the response to a data repository type that is not supported.
|
| InvalidDestinationKmsKeyException |
The Key Management Service (KMS) key of the destination backup is not valid.
|
| InvalidExportPathException |
The path provided for data repository export isn't valid.
|
| InvalidImportPathException |
The path provided for data repository import isn't valid.
|
| InvalidNetworkSettingsException |
One or more network settings specified in the request are invalid.
|
| InvalidPerUnitStorageThroughputException |
An invalid value for
PerUnitStorageThroughput was provided. |
| InvalidRegionException |
The Region provided for
SourceRegion is not valid or is in a different Amazon Web Services partition. |
| InvalidSourceKmsKeyException |
The Key Management Service (KMS) key of the source backup is not valid.
|
| MissingFileCacheConfigurationException |
A cache configuration is required for this operation.
|
| MissingFileSystemConfigurationException |
A file system configuration is required for this operation.
|
| MissingVolumeConfigurationException |
A volume configuration is required for this operation.
|
| NotServiceResourceErrorException |
The resource specified for the tagging operation is not a resource type owned by Amazon FSx.
|
| ResourceDoesNotSupportTaggingException |
The resource specified does not support tagging.
|
| ResourceNotFoundException |
The resource specified by the Amazon Resource Name (ARN) can't be found.
|
| ServiceLimitExceededException |
An error indicating that a particular service limit was exceeded.
|
| SnapshotNotFoundException |
No Amazon FSx snapshots were found based on the supplied parameters.
|
| SourceBackupUnavailableException |
The request was rejected because the lifecycle status of the source backup isn't
AVAILABLE. |
| 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.
|
| VolumeNotFoundException |
No Amazon FSx volumes were found based upon the supplied parameters.
|