- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
FSxClient
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 install @aws-sdk/client-fsx
yarn add @aws-sdk/client-fsx
pnpm add @aws-sdk/client-fsx
FSxClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AssociateFileSystemAliasesCommand | 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. |
CancelDataRepositoryTaskCommand | Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
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. |
CopyBackupCommand | 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: You can also use backup copies to clone your file dataset to another Region or within the same Region. You can use the 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. |
CopySnapshotAndUpdateVolumeCommand | Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide. |
CreateBackupCommand | 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:
For more information about backups, see the following:
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
By using the idempotent operation, you can retry a The |
CreateDataRepositoryAssociationCommand | 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 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 . |
CreateDataRepositoryTaskCommand | Creates an Amazon FSx for Lustre data repository task. A 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 . |
CreateFileCacheCommand | 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,
The |
CreateFileSystemCommand | Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the
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 If a file system with the specified client request token exists and the parameters match,
The |
CreateFileSystemFromBackupCommand | 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
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 The |
CreateSnapshotCommand | 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
By using the idempotent operation, you can retry a The |
CreateStorageVirtualMachineCommand | Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. |
CreateVolumeCommand | Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume. |
CreateVolumeFromBackupCommand | Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. |
DeleteBackupCommand | Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone. The The data in a deleted backup is also deleted and can't be recovered by any means. |
DeleteDataRepositoryAssociationCommand | 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 |
DeleteFileCacheCommand | Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The The data in a deleted cache is also deleted and can't be recovered by any means. |
DeleteFileSystemCommand | 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 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 The If a data repository task is in a The data in a deleted file system is also deleted and can't be recovered by any means. |
DeleteSnapshotCommand | 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 |
DeleteStorageVirtualMachineCommand | 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. |
DeleteVolumeCommand | Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. |
DescribeBackupsCommand | Returns the description of a specific Amazon FSx backup, if a When retrieving all backups, you can optionally specify the This operation is used in an iterative process to retrieve a list of your backups. When using this operation, keep the following in mind:
|
DescribeDataRepositoryAssociationsCommand | Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more You can use filters to narrow the response to include just data repository associations for specific file systems (use the When retrieving all data repository associations, you can paginate the response by using the optional |
DescribeDataRepositoryTasksCommand | Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more When retrieving all tasks, you can paginate the response by using the optional |
DescribeFileCachesCommand | Returns the description of a specific Amazon File Cache resource, if a When retrieving all cache descriptions, you can optionally specify the This operation is used in an iterative process to retrieve a list of your cache descriptions. When using this operation, keep the following in mind:
|
DescribeFileSystemAliasesCommand | 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. |
DescribeFileSystemsCommand | Returns the description of specific Amazon FSx file systems, if a When retrieving all file system descriptions, you can optionally specify the This operation is used in an iterative process to retrieve a list of your file system descriptions. When using this operation, keep the following in mind:
|
DescribeSharedVpcConfigurationCommand | Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets . |
DescribeSnapshotsCommand | Returns the description of specific Amazon FSx for OpenZFS snapshots, if a When retrieving all snapshots, you can optionally specify the Use this operation in an iterative process to retrieve a list of your snapshots. When using this operation, keep the following in mind:
|
DescribeStorageVirtualMachinesCommand | Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). |
DescribeVolumesCommand | Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. |
DisassociateFileSystemAliasesCommand | 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 an HTTP status code 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. |
ListTagsForResourceCommand | Lists tags for Amazon FSx resources. When retrieving all tags, you can optionally specify the This action is used in an iterative process to retrieve a list of your tags. When using this action, keep the following in mind:
|
ReleaseFileSystemNfsV3LocksCommand | Releases the file system lock from an Amazon FSx for OpenZFS file system. |
RestoreVolumeFromSnapshotCommand | Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. |
StartMisconfiguredStateRecoveryCommand | After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system. |
TagResourceCommand | Tags an Amazon FSx resource. |
UntagResourceCommand | This action removes a tag from an Amazon FSx resource. |
UpdateDataRepositoryAssociationCommand | 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 |
UpdateFileCacheCommand | Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request. |
UpdateFileSystemCommand | 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:
For FSx for Lustre file systems, you can update the following properties:
For FSx for ONTAP file systems, you can update the following properties:
For FSx for OpenZFS file systems, you can update the following properties:
|
UpdateSharedVpcConfigurationCommand | Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide . We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a |
UpdateSnapshotCommand | Updates the name of an Amazon FSx for OpenZFS snapshot. |
UpdateStorageVirtualMachineCommand | Updates an FSx for ONTAP storage virtual machine (SVM). |
UpdateVolumeCommand | Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. |
FSxClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: FSxClientConfig