Amazon FSx

Amazon FSx API

The Amazon FSx API enables programmatic access to create, manage, and monitor fully managed file systems. You can create file systems, manage backups, configure data repositories, create snapshots, and manage storage virtual machines across multiple file system types.

Documentation GitHub OpenAPI

Documentation

https://docs.aws.amazon.com/fsx/latest/APIReference/Welcome.html

https://aws.amazon.com/fsx/getting-started/

https://docs.aws.amazon.com/fsx/latest/APIReference/Welcome.html

Specifications

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/openapi/amazon-fsx-openapi.yml

Examples

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/examples/amazon-fsx-file-system-example.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/examples/amazon-fsx-backup-example.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/examples/amazon-fsx-snapshot-example.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/examples/amazon-fsx-storage-virtual-machine-example.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/examples/amazon-fsx-tag-example.json

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-schema/amazon-fsx-file-system-schema.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-schema/amazon-fsx-backup-schema.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-schema/amazon-fsx-snapshot-schema.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-schema/amazon-fsx-storage-virtual-machine-schema.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-schema/amazon-fsx-tag-schema.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-structure/amazon-fsx-file-system-structure.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-structure/amazon-fsx-backup-structure.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-structure/amazon-fsx-snapshot-structure.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-structure/amazon-fsx-storage-virtual-machine-structure.json

https://raw.githubusercontent.com/api-evangelist/amazon-fsx/refs/heads/main/json-structure/amazon-fsx-tag-structure.json

Other Resources

https://aws.amazon.com/fsx/pricing/

https://aws.amazon.com/fsx/faqs/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon FSx API
  description: >-
    Amazon FSx provides fully managed file systems optimized for a variety of
    workloads. This API enables you to create and manage file systems,
    configure backups and snapshots, manage data repositories, and monitor
    file system health across Lustre, Windows File Server, NetApp ONTAP,
    and OpenZFS file system types.
  version: '2018-03-01'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
externalDocs:
  description: Amazon FSx API Reference
  url: https://docs.aws.amazon.com/fsx/latest/APIReference/Welcome.html
servers:
  - url: https://fsx.{region}.amazonaws.com
    description: Amazon FSx Regional Endpoint
    variables:
      region:
        default: us-east-1
        description: AWS Region
tags:
  - name: File Systems
    description: Operations for creating and managing file systems
paths:
  /:
    post:
      operationId: CreateFileSystem
      summary: Amazon FSx Create a new file system
      description: Creates a new Amazon FSx file system of the specified type.
      tags:
        - File Systems
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - FileSystemType
                - StorageCapacity
                - SubnetIds
              properties:
                FileSystemType:
                  type: string
                  enum: [WINDOWS, LUSTRE, ONTAP, OPENZFS]
                  description: The type of file system to create
                StorageCapacity:
                  type: integer
                  description: Storage capacity in GiB
                SubnetIds:
                  type: array
                  items:
                    type: string
                  description: Subnet IDs for the file system
                SecurityGroupIds:
                  type: array
                  items:
                    type: string
                  description: Security group IDs
                Tags:
                  type: array
                  items:
                    type: object
      responses:
        '200':
          description: File system created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  FileSystem:
                    type: object
                    description: The configuration of the file system