Amazon FSx
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon FSx is a fully managed service that makes it easy for storage and
application administrators to launch and use shared file storage.
Endpoints 48
- POSTAssociate file system aliases
/#X-Amz-Target=AWSSimbaAPIService_v20180301.AssociateFileSystemAliasesUse 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… - POSTCancel data repository task
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CancelDataRepositoryTaskCancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel an export task,… - POSTCopy backup
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CopyBackupCopies 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… - POSTCopy snapshot and update volume
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CopySnapshotAndUpdateVolumeUpdates 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… - POSTCreate and attach s3 access point
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateAndAttachS3AccessPointCreates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file… - POSTCreate backup
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateBackupCreates 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… - POSTCreate data repository association
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateDataRepositoryAssociationCreates 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… - POSTCreate data repository task
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateDataRepositoryTaskCreates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file… - POSTCreate file cache
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileCacheCreates 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… - POSTCreate file system
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileSystemCreates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation: Amazon… - POSTCreate file system from backup
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileSystemFromBackupCreates 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… - POSTCreate snapshot
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateSnapshotCreates 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… - POSTCreate storage virtual machine
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateStorageVirtualMachineCreates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system. - POSTCreate volume
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateVolumeCreates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume. - POSTCreate volume from backup
/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateVolumeFromBackupCreates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup. - POSTDelete backup
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteBackupDeletes 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… - POSTDelete data repository association
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteDataRepositoryAssociationDeletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the… - POSTDelete file cache
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteFileCacheDeletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The DeleteFileCache operation returns while the cache… - POSTDelete file system
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteFileSystemDeletes 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.… - POSTDelete snapshot
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteSnapshotDeletes 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… - POSTDelete storage virtual machine
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteStorageVirtualMachineDeletes 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… - POSTDelete volume
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DeleteVolumeDeletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume. - POSTDescribe backups
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeBackupsReturns 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… - POSTDescribe data repository associations
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeDataRepositoryAssociationsReturns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided… - POSTDescribe data repository tasks
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeDataRepositoryTasksReturns 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… - POSTDescribe file caches
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileCachesReturns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of… - POSTDescribe file system aliases
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileSystemAliasesReturns 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… - POSTDescribe file systems
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeFileSystemsReturns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of… - POSTDescribe s3 access point attachments
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeS3AccessPointAttachmentsDescribes one or more S3 access points attached to Amazon FSx volumes. The requester requires the following permission to perform this action:… - POSTDescribe shared vpc configuration
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeSharedVpcConfigurationIndicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a… - POSTDescribe snapshots
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeSnapshotsReturns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots… - POSTDescribe storage virtual machines
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeStorageVirtualMachinesDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). - POSTDescribe volumes
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DescribeVolumesDescribes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. - POSTDetach and delete s3 access point
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DetachAndDeleteS3AccessPointDetaches an S3 access point from an Amazon FSx volume and deletes the S3 access point. The requester requires the following permission to perform this action:… - POSTDisassociate file system aliases
/#X-Amz-Target=AWSSimbaAPIService_v20180301.DisassociateFileSystemAliasesUse 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… - POSTList tags for resource
/#X-Amz-Target=AWSSimbaAPIService_v20180301.ListTagsForResourceLists 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.… - POSTRelease file system nfs v3 locks
/#X-Amz-Target=AWSSimbaAPIService_v20180301.ReleaseFileSystemNfsV3LocksReleases the file system lock from an Amazon FSx for OpenZFS file system. - POSTRestore volume from snapshot
/#X-Amz-Target=AWSSimbaAPIService_v20180301.RestoreVolumeFromSnapshotReturns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot. - POSTStart misconfigured state recovery
/#X-Amz-Target=AWSSimbaAPIService_v20180301.StartMisconfiguredStateRecoveryAfter 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… - POSTTag resource
/#X-Amz-Target=AWSSimbaAPIService_v20180301.TagResourceTags an Amazon FSx resource. - POSTUntag resource
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UntagResourceThis action removes a tag from an Amazon FSx resource. - POSTUpdate data repository association
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateDataRepositoryAssociationUpdates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on… - POSTUpdate file cache
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateFileCacheUpdates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request. - POSTUpdate file system
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateFileSystemUse 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… - POSTUpdate shared vpc configuration
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateSharedVpcConfigurationConfigures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a… - POSTUpdate snapshot
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateSnapshotUpdates the name of an Amazon FSx for OpenZFS snapshot. - POSTUpdate storage virtual machine
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateStorageVirtualMachineUpdates an FSx for ONTAP storage virtual machine (SVM). - POSTUpdate volume
/#X-Amz-Target=AWSSimbaAPIService_v20180301.UpdateVolumeUpdates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
API details
- Base URL
https://fsx.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 48 operations on 48 pathsPOST 48
- Description format
- AWS Smithy model, API version
2018-03-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon FSx in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon FSx collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate file system aliases” (POST /#X-Amz-Target=AWSSimbaAPIService_v20180301.AssociateFileSystemAliases), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon FSx?
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage. It is listed under Developer tools and has 48 endpoints.
Who publishes the Amazon FSx?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon FSx?
Requests go to https://fsx.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon FSx?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon FSx have?
48 operations on 48 paths (48 POST).
Is forking the Amazon FSx free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.