Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-fsx

Description

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

Installation

NPM

npm install @aws-sdk/client-fsx

Yarn

yarn add @aws-sdk/client-fsx

pnpm

pnpm add @aws-sdk/client-fsx

Types

Type Name	Type
ActiveDirectoryBackupAttributes	Interface
ActiveDirectoryError	Class
ActiveDirectoryErrorType	TypeAlias
ActiveDirectoryErrorTypeenum	Variable
AdministrativeAction	Interface
AdministrativeActionFailureDetails	Interface
AdministrativeActionType	TypeAlias
AdministrativeActionTypeenum	Variable
AggregateConfiguration	Interface
Alias	Interface
AliasLifecycle	TypeAlias
AliasLifecycleenum	Variable
AssociateFileSystemAliasesCommand	Class
AssociateFileSystemAliasesCommandInput	Interface
AssociateFileSystemAliasesCommandOutput	Interface
AssociateFileSystemAliasesRequest	Interface
AssociateFileSystemAliasesResponse	Interface
AutocommitPeriod	Interface
AutocommitPeriodType	TypeAlias
AutocommitPeriodTypeenum	Variable
AutoExportPolicy	Interface
AutoImportPolicy	Interface
AutoImportPolicyType	TypeAlias
AutoImportPolicyTypeenum	Variable
Backup	Interface
BackupBeingCopied	Class
BackupFailureDetails	Interface
BackupInProgress	Class
BackupLifecycle	TypeAlias
BackupLifecycleenum	Variable
BackupNotFound	Class
BackupRestoring	Class
BackupType	TypeAlias
BackupTypeenum	Variable
BadRequest	Class
CancelDataRepositoryTaskCommand	Class
CancelDataRepositoryTaskCommandInput	Interface
CancelDataRepositoryTaskCommandOutput	Interface
CancelDataRepositoryTaskRequest	Interface
CancelDataRepositoryTaskResponse	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
CompletionReport	Interface
CopyBackupCommand	Class
CopyBackupCommandInput	Interface
CopyBackupCommandOutput	Interface
CopyBackupRequest	Interface
CopyBackupResponse	Interface
CopySnapshotAndUpdateVolumeCommand	Class
CopySnapshotAndUpdateVolumeCommandInput	Interface
CopySnapshotAndUpdateVolumeCommandOutput	Interface
CopySnapshotAndUpdateVolumeRequest	Interface
CopySnapshotAndUpdateVolumeResponse	Interface
CreateAggregateConfiguration	Interface
CreateBackupCommand	Class
CreateBackupCommandInput	Interface
CreateBackupCommandOutput	Interface
CreateBackupRequest	Interface
CreateBackupResponse	Interface
CreateDataRepositoryAssociationCommand	Class
CreateDataRepositoryAssociationCommandInput	Interface
CreateDataRepositoryAssociationCommandOutput	Interface
CreateDataRepositoryAssociationRequest	Interface
CreateDataRepositoryAssociationResponse	Interface
CreateDataRepositoryTaskCommand	Class
CreateDataRepositoryTaskCommandInput	Interface
CreateDataRepositoryTaskCommandOutput	Interface
CreateDataRepositoryTaskRequest	Interface
CreateDataRepositoryTaskResponse	Interface
CreateFileCacheCommand	Class
CreateFileCacheCommandInput	Interface
CreateFileCacheCommandOutput	Interface
CreateFileCacheLustreConfiguration	Interface
CreateFileCacheRequest	Interface
CreateFileCacheResponse	Interface
CreateFileSystemCommand	Class
CreateFileSystemCommandInput	Interface
CreateFileSystemCommandOutput	Interface
CreateFileSystemFromBackupCommand	Class
CreateFileSystemFromBackupCommandInput	Interface
CreateFileSystemFromBackupCommandOutput	Interface
CreateFileSystemFromBackupRequest	Interface
CreateFileSystemFromBackupResponse	Interface
CreateFileSystemLustreConfiguration	Interface
CreateFileSystemLustreMetadataConfiguration	Interface
CreateFileSystemOntapConfiguration	Interface
CreateFileSystemOpenZFSConfiguration	Interface
CreateFileSystemRequest	Interface
CreateFileSystemResponse	Interface
CreateFileSystemWindowsConfiguration	Interface
CreateOntapVolumeConfiguration	Interface
CreateOpenZFSOriginSnapshotConfiguration	Interface
CreateOpenZFSVolumeConfiguration	Interface
CreateSnaplockConfiguration	Interface
CreateSnapshotCommand	Class
CreateSnapshotCommandInput	Interface
CreateSnapshotCommandOutput	Interface
CreateSnapshotRequest	Interface
CreateSnapshotResponse	Interface
CreateStorageVirtualMachineCommand	Class
CreateStorageVirtualMachineCommandInput	Interface
CreateStorageVirtualMachineCommandOutput	Interface
CreateStorageVirtualMachineRequest	Interface
CreateStorageVirtualMachineResponse	Interface
CreateSvmActiveDirectoryConfiguration	Interface
CreateVolumeCommand	Class
CreateVolumeCommandInput	Interface
CreateVolumeCommandOutput	Interface
CreateVolumeFromBackupCommand	Class
CreateVolumeFromBackupCommandInput	Interface
CreateVolumeFromBackupCommandOutput	Interface
CreateVolumeFromBackupRequest	Interface
CreateVolumeFromBackupResponse	Interface
CreateVolumeRequest	Interface
CreateVolumeResponse	Interface
DataCompressionType	TypeAlias
DataCompressionTypeenum	Variable
DataRepositoryAssociation	Interface
DataRepositoryAssociationNotFound	Class
DataRepositoryConfiguration	Interface
DataRepositoryFailureDetails	Interface
DataRepositoryLifecycle	TypeAlias
DataRepositoryLifecycleenum	Variable
DataRepositoryTask	Interface
DataRepositoryTaskEnded	Class
DataRepositoryTaskExecuting	Class
DataRepositoryTaskFailureDetails	Interface
DataRepositoryTaskFilter	Interface
DataRepositoryTaskFilterName	TypeAlias
DataRepositoryTaskFilterNameenum	Variable
DataRepositoryTaskLifecycle	TypeAlias
DataRepositoryTaskLifecycleenum	Variable
DataRepositoryTaskNotFound	Class
DataRepositoryTaskStatus	Interface
DataRepositoryTaskType	TypeAlias
DataRepositoryTaskTypeenum	Variable
DeleteBackupCommand	Class
DeleteBackupCommandInput	Interface
DeleteBackupCommandOutput	Interface
DeleteBackupRequest	Interface
DeleteBackupResponse	Interface
DeleteDataRepositoryAssociationCommand	Class
DeleteDataRepositoryAssociationCommandInput	Interface
DeleteDataRepositoryAssociationCommandOutput	Interface
DeleteDataRepositoryAssociationRequest	Interface
DeleteDataRepositoryAssociationResponse	Interface
DeleteFileCacheCommand	Class
DeleteFileCacheCommandInput	Interface
DeleteFileCacheCommandOutput	Interface
DeleteFileCacheRequest	Interface
DeleteFileCacheResponse	Interface
DeleteFileSystemCommand	Class
DeleteFileSystemCommandInput	Interface
DeleteFileSystemCommandOutput	Interface
DeleteFileSystemLustreConfiguration	Interface
DeleteFileSystemLustreResponse	Interface
DeleteFileSystemOpenZFSConfiguration	Interface
DeleteFileSystemOpenZFSOption	TypeAlias
DeleteFileSystemOpenZFSOptionenum	Variable
DeleteFileSystemOpenZFSResponse	Interface
DeleteFileSystemRequest	Interface
DeleteFileSystemResponse	Interface
DeleteFileSystemWindowsConfiguration	Interface
DeleteFileSystemWindowsResponse	Interface
DeleteOpenZFSVolumeOption	TypeAlias
DeleteOpenZFSVolumeOptionenum	Variable
DeleteSnapshotCommand	Class
DeleteSnapshotCommandInput	Interface
DeleteSnapshotCommandOutput	Interface
DeleteSnapshotRequest	Interface
DeleteSnapshotResponse	Interface
DeleteStorageVirtualMachineCommand	Class
DeleteStorageVirtualMachineCommandInput	Interface
DeleteStorageVirtualMachineCommandOutput	Interface
DeleteStorageVirtualMachineRequest	Interface
DeleteStorageVirtualMachineResponse	Interface
DeleteVolumeCommand	Class
DeleteVolumeCommandInput	Interface
DeleteVolumeCommandOutput	Interface
DeleteVolumeOntapConfiguration	Interface
DeleteVolumeOntapResponse	Interface
DeleteVolumeOpenZFSConfiguration	Interface
DeleteVolumeRequest	Interface
DeleteVolumeResponse	Interface
DescribeBackupsCommand	Class
DescribeBackupsCommandInput	Interface
DescribeBackupsCommandOutput	Interface
DescribeBackupsRequest	Interface
DescribeBackupsResponse	Interface
DescribeDataRepositoryAssociationsCommand	Class
DescribeDataRepositoryAssociationsCommandInput	Interface
DescribeDataRepositoryAssociationsCommandOutput	Interface
DescribeDataRepositoryAssociationsRequest	Interface
DescribeDataRepositoryAssociationsResponse	Interface
DescribeDataRepositoryTasksCommand	Class
DescribeDataRepositoryTasksCommandInput	Interface
DescribeDataRepositoryTasksCommandOutput	Interface
DescribeDataRepositoryTasksRequest	Interface
DescribeDataRepositoryTasksResponse	Interface
DescribeFileCachesCommand	Class
DescribeFileCachesCommandInput	Interface
DescribeFileCachesCommandOutput	Interface
DescribeFileCachesRequest	Interface
DescribeFileCachesResponse	Interface
DescribeFileSystemAliasesCommand	Class
DescribeFileSystemAliasesCommandInput	Interface
DescribeFileSystemAliasesCommandOutput	Interface
DescribeFileSystemAliasesRequest	Interface
DescribeFileSystemAliasesResponse	Interface
DescribeFileSystemsCommand	Class
DescribeFileSystemsCommandInput	Interface
DescribeFileSystemsCommandOutput	Interface
DescribeFileSystemsRequest	Interface
DescribeFileSystemsResponse	Interface
DescribeSharedVpcConfigurationCommand	Class
DescribeSharedVpcConfigurationCommandInput	Interface
DescribeSharedVpcConfigurationCommandOutput	Interface
DescribeSharedVpcConfigurationRequest	Interface
DescribeSharedVpcConfigurationResponse	Interface
DescribeSnapshotsCommand	Class
DescribeSnapshotsCommandInput	Interface
DescribeSnapshotsCommandOutput	Interface
DescribeSnapshotsRequest	Interface
DescribeSnapshotsResponse	Interface
DescribeStorageVirtualMachinesCommand	Class
DescribeStorageVirtualMachinesCommandInput	Interface
DescribeStorageVirtualMachinesCommandOutput	Interface
DescribeStorageVirtualMachinesRequest	Interface
DescribeStorageVirtualMachinesResponse	Interface
DescribeVolumesCommand	Class
DescribeVolumesCommandInput	Interface
DescribeVolumesCommandOutput	Interface
DescribeVolumesRequest	Interface
DescribeVolumesResponse	Interface
DisassociateFileSystemAliasesCommand	Class
DisassociateFileSystemAliasesCommandInput	Interface
DisassociateFileSystemAliasesCommandOutput	Interface
DisassociateFileSystemAliasesRequest	Interface
DisassociateFileSystemAliasesResponse	Interface
DiskIopsConfiguration	Interface
DiskIopsConfigurationMode	TypeAlias
DiskIopsConfigurationModeenum	Variable
DriveCacheType	TypeAlias
DriveCacheTypeenum	Variable
DurationSinceLastAccess	Interface
EventType	TypeAlias
EventTypeenum	Variable
FileCache	Interface
FileCacheCreating	Interface
FileCacheDataRepositoryAssociation	Interface
FileCacheFailureDetails	Interface
FileCacheLifecycle	TypeAlias
FileCacheLifecycleenum	Variable
FileCacheLustreConfiguration	Interface
FileCacheLustreDeploymentType	TypeAlias
FileCacheLustreDeploymentTypeenum	Variable
FileCacheLustreMetadataConfiguration	Interface
FileCacheNFSConfiguration	Interface
FileCacheNotFound	Class
FileCacheType	TypeAlias
FileCacheTypeenum	Variable
FileSystem	Interface
FileSystemEndpoint	Interface
FileSystemEndpoints	Interface
FileSystemFailureDetails	Interface
FileSystemLifecycle	TypeAlias
FileSystemLifecycleenum	Variable
FileSystemLustreMetadataConfiguration	Interface
FileSystemMaintenanceOperation	TypeAlias
FileSystemMaintenanceOperationenum	Variable
FileSystemNotFound	Class
FileSystemType	TypeAlias
FileSystemTypeenum	Variable
Filter	Interface
FilterName	TypeAlias
FilterNameenum	Variable
FlexCacheEndpointType	TypeAlias
FlexCacheEndpointTypeenum	Variable
FSx	Class
FSx	Interface
FSxClient	Class
FSxClientConfig	Interface
FSxClientConfigType	TypeAlias
FSxClientResolvedConfig	Interface
FSxClientResolvedConfigType	TypeAlias
FSxPaginationConfiguration	Interface
FSxServiceException	Class
IncompatibleParameterError	Class
IncompatibleRegionForMultiAZ	Class
InputOntapVolumeType	TypeAlias
InputOntapVolumeTypeenum	Variable
InternalServerError	Class
InvalidDataRepositoryType	Class
InvalidDestinationKmsKey	Class
InvalidExportPath	Class
InvalidImportPath	Class
InvalidNetworkSettings	Class
InvalidPerUnitStorageThroughput	Class
InvalidRegion	Class
InvalidSourceKmsKey	Class
LifecycleTransitionReason	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
LustreAccessAuditLogLevel	TypeAlias
LustreAccessAuditLogLevelenum	Variable
LustreDeploymentType	TypeAlias
LustreDeploymentTypeenum	Variable
LustreFileSystemConfiguration	Interface
LustreLogConfiguration	Interface
LustreLogCreateConfiguration	Interface
LustreRootSquashConfiguration	Interface
MetadataConfigurationMode	TypeAlias
MetadataConfigurationModeenum	Variable
MissingFileCacheConfiguration	Class
MissingFileSystemConfiguration	Class
MissingVolumeConfiguration	Class
NFSDataRepositoryConfiguration	Interface
NfsVersion	TypeAlias
NfsVersionenum	Variable
NotServiceResourceError	Class
OntapDeploymentType	TypeAlias
OntapDeploymentTypeenum	Variable
OntapFileSystemConfiguration	Interface
OntapVolumeConfiguration	Interface
OntapVolumeType	TypeAlias
OntapVolumeTypeenum	Variable
OpenZFSClientConfiguration	Interface
OpenZFSCopyStrategy	TypeAlias
OpenZFSCopyStrategyenum	Variable
OpenZFSCreateRootVolumeConfiguration	Interface
OpenZFSDataCompressionType	TypeAlias
OpenZFSDataCompressionTypeenum	Variable
OpenZFSDeploymentType	TypeAlias
OpenZFSDeploymentTypeenum	Variable
OpenZFSFileSystemConfiguration	Interface
OpenZFSNfsExport	Interface
OpenZFSOriginSnapshotConfiguration	Interface
OpenZFSQuotaType	TypeAlias
OpenZFSQuotaTypeenum	Variable
OpenZFSReadCacheConfiguration	Interface
OpenZFSReadCacheSizingMode	TypeAlias
OpenZFSReadCacheSizingModeenum	Variable
OpenZFSUserOrGroupQuota	Interface
OpenZFSVolumeConfiguration	Interface
paginateDescribeBackups	Variable
paginateDescribeDataRepositoryAssociations	Variable
paginateDescribeDataRepositoryTasks	Variable
paginateDescribeFileCaches	Variable
paginateDescribeFileSystemAliases	Variable
paginateDescribeFileSystems	Variable
paginateDescribeSnapshots	Variable
paginateDescribeStorageVirtualMachines	Variable
paginateDescribeVolumes	Variable
paginateListTagsForResource	Variable
PrivilegedDelete	TypeAlias
PrivilegedDeleteenum	Variable
ReleaseConfiguration	Interface
ReleaseFileSystemNfsV3LocksCommand	Class
ReleaseFileSystemNfsV3LocksCommandInput	Interface
ReleaseFileSystemNfsV3LocksCommandOutput	Interface
ReleaseFileSystemNfsV3LocksRequest	Interface
ReleaseFileSystemNfsV3LocksResponse	Interface
ReportFormat	TypeAlias
ReportFormatenum	Variable
ReportScope	TypeAlias
ReportScopeenum	Variable
ResourceDoesNotSupportTagging	Class
ResourceNotFound	Class
ResourceType	TypeAlias
ResourceTypeenum	Variable
RestoreOpenZFSVolumeOption	TypeAlias
RestoreOpenZFSVolumeOptionenum	Variable
RestoreVolumeFromSnapshotCommand	Class
RestoreVolumeFromSnapshotCommandInput	Interface
RestoreVolumeFromSnapshotCommandOutput	Interface
RestoreVolumeFromSnapshotRequest	Interface
RestoreVolumeFromSnapshotResponse	Interface
RetentionPeriod	Interface
RetentionPeriodType	TypeAlias
RetentionPeriodTypeenum	Variable
RuntimeExtension	Interface
S3DataRepositoryConfiguration	Interface
SecurityStyle	TypeAlias
SecurityStyleenum	Variable
SelfManagedActiveDirectoryAttributes	Interface
SelfManagedActiveDirectoryConfiguration	Interface
SelfManagedActiveDirectoryConfigurationUpdates	Interface
ServiceInputTypes	TypeAlias
ServiceLimit	TypeAlias
ServiceLimitenum	Variable
ServiceLimitExceeded	Class
ServiceOutputTypes	TypeAlias
SnaplockConfiguration	Interface
SnaplockRetentionPeriod	Interface
SnaplockType	TypeAlias
SnaplockTypeenum	Variable
Snapshot	Interface
SnapshotFilter	Interface
SnapshotFilterName	TypeAlias
SnapshotFilterNameenum	Variable
SnapshotLifecycle	TypeAlias
SnapshotLifecycleenum	Variable
SnapshotNotFound	Class
SourceBackupUnavailable	Class
StartMisconfiguredStateRecoveryCommand	Class
StartMisconfiguredStateRecoveryCommandInput	Interface
StartMisconfiguredStateRecoveryCommandOutput	Interface
StartMisconfiguredStateRecoveryRequest	Interface
StartMisconfiguredStateRecoveryResponse	Interface
Status	TypeAlias
Statusenum	Variable
StorageType	TypeAlias
StorageTypeenum	Variable
StorageVirtualMachine	Interface
StorageVirtualMachineFilter	Interface
StorageVirtualMachineFilterName	TypeAlias
StorageVirtualMachineFilterNameenum	Variable
StorageVirtualMachineLifecycle	TypeAlias
StorageVirtualMachineLifecycleenum	Variable
StorageVirtualMachineNotFound	Class
StorageVirtualMachineRootVolumeSecurityStyle	TypeAlias
StorageVirtualMachineRootVolumeSecurityStyleenum	Variable
StorageVirtualMachineSubtype	TypeAlias
StorageVirtualMachineSubtypeenum	Variable
SvmActiveDirectoryConfiguration	Interface
SvmEndpoint	Interface
SvmEndpoints	Interface
Tag	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
TieringPolicy	Interface
TieringPolicyName	TypeAlias
TieringPolicyNameenum	Variable
Unit	TypeAlias
Unitenum	Variable
UnsupportedOperation	Class
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateDataRepositoryAssociationCommand	Class
UpdateDataRepositoryAssociationCommandInput	Interface
UpdateDataRepositoryAssociationCommandOutput	Interface
UpdateDataRepositoryAssociationRequest	Interface
UpdateDataRepositoryAssociationResponse	Interface
UpdateFileCacheCommand	Class
UpdateFileCacheCommandInput	Interface
UpdateFileCacheCommandOutput	Interface
UpdateFileCacheLustreConfiguration	Interface
UpdateFileCacheRequest	Interface
UpdateFileCacheResponse	Interface
UpdateFileSystemCommand	Class
UpdateFileSystemCommandInput	Interface
UpdateFileSystemCommandOutput	Interface
UpdateFileSystemLustreConfiguration	Interface
UpdateFileSystemLustreMetadataConfiguration	Interface
UpdateFileSystemOntapConfiguration	Interface
UpdateFileSystemOpenZFSConfiguration	Interface
UpdateFileSystemRequest	Interface
UpdateFileSystemResponse	Interface
UpdateFileSystemWindowsConfiguration	Interface
UpdateOntapVolumeConfiguration	Interface
UpdateOpenZFSVolumeConfiguration	Interface
UpdateOpenZFSVolumeOption	TypeAlias
UpdateOpenZFSVolumeOptionenum	Variable
UpdateSharedVpcConfigurationCommand	Class
UpdateSharedVpcConfigurationCommandInput	Interface
UpdateSharedVpcConfigurationCommandOutput	Interface
UpdateSharedVpcConfigurationRequest	Interface
UpdateSharedVpcConfigurationResponse	Interface
UpdateSnaplockConfiguration	Interface
UpdateSnapshotCommand	Class
UpdateSnapshotCommandInput	Interface
UpdateSnapshotCommandOutput	Interface
UpdateSnapshotRequest	Interface
UpdateSnapshotResponse	Interface
UpdateStorageVirtualMachineCommand	Class
UpdateStorageVirtualMachineCommandInput	Interface
UpdateStorageVirtualMachineCommandOutput	Interface
UpdateStorageVirtualMachineRequest	Interface
UpdateStorageVirtualMachineResponse	Interface
UpdateSvmActiveDirectoryConfiguration	Interface
UpdateVolumeCommand	Class
UpdateVolumeCommandInput	Interface
UpdateVolumeCommandOutput	Interface
UpdateVolumeRequest	Interface
UpdateVolumeResponse	Interface
Volume	Interface
VolumeFilter	Interface
VolumeFilterName	TypeAlias
VolumeFilterNameenum	Variable
VolumeLifecycle	TypeAlias
VolumeLifecycleenum	Variable
VolumeNotFound	Class
VolumeStyle	TypeAlias
VolumeStyleenum	Variable
VolumeType	TypeAlias
VolumeTypeenum	Variable
WindowsAccessAuditLogLevel	TypeAlias
WindowsAccessAuditLogLevelenum	Variable
WindowsAuditLogConfiguration	Interface
WindowsAuditLogCreateConfiguration	Interface
WindowsDeploymentType	TypeAlias
WindowsDeploymentTypeenum	Variable
WindowsFileSystemConfiguration	Interface

Getting Started

References

@aws-sdk/client-fsx

Description

Installation

Types

Table of Contents

Search