Amazon S3 Filesystems API

The Filesystems API from Amazon S3 — 2 operation(s) for filesystems.

GitHub OpenAPI

Operations 4

PUT /file-systems Create File System #
GET /file-systems List File Systems #
DELETE /file-systems/{fileSystemId} Delete File System #
GET /file-systems/{fileSystemId} Get File System #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-s3:amazon-s3-filesystems-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-s3-filesystems-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Simple Storage Service Filesystems API
  version: '2006-03-01'
  description: Generated from AWS's published Smithy model for Amazon Simple Storage Service. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://s3files.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /file-systems:
    put:
      operationId: CreateFileSystem
      summary: Create File System
      description: Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access
        to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access
        the bucket.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFileSystemResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFileSystemRequest'
      tags:
      - Filesystems
    get:
      operationId: ListFileSystems
      summary: List File Systems
      description: Returns a list of all S3 File Systems owned by the account with optional filtering by bucket.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFileSystemsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesInternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFileSystemsRequest'
      tags:
      - Filesystems
  /file-systems/{fileSystemId}:
    delete:
      operationId: DeleteFileSystem
      summary: Delete File System
      description: Deletes an S3 File System. You can optionally force deletion of a file system that has pending export data.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFileSystemRequest'
      tags:
      - Filesystems
    get:
      operationId: GetFileSystem
      summary: Get File System
      description: Returns resource information for the specified S3 File System including status, configuration, and metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFileSystemResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3FilesValidationException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFileSystemRequest'
      tags:
      - Filesystems
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: s3files
  schemas:
    CreateFileSystemRequest:
      type: object
      properties:
        bucket:
          type: string
          description: The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The
            bucket must exist and be in the same Amazon Web Services Region as the file system.
        prefix:
          type: string
          description: An optional prefix within the S3 bucket to scope the file system access. If specified, the file system
            provides access only to objects with keys that begin with this prefix. If not specified, the file system provides
            access to the entire bucket.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII
            characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates
            one.
        kmsKeyId:
          type: string
          description: 'The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses
            a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias,
            or key alias ARN. If you use KmsKeyId, the file system will be encrypted.'
        roleArn:
          type: string
          description: The ARN of the IAM role that grants the S3 Files service permission to read and write data between
            the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket
            and prefix.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/S3FilesTag'
          description: An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined
            key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.
        acceptBucketWarning:
          type: boolean
          description: Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified,
            the operation may fail if there are bucket configuration warnings.
      required:
      - bucket
      - roleArn
    CreateFileSystemResponse:
      type: object
      properties:
        creationTime:
          type: string
          description: The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).
        fileSystemArn:
          type: string
          description: The ARN for the S3 file system, in the format arn:aws:s3files:region:account-id:file-system/file-system-id.
        fileSystemId:
          type: string
          description: The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent
            API calls.
        bucket:
          type: string
          description: The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.
        prefix:
          type: string
          description: The prefix within the S3 bucket that scopes the file system access.
        clientToken:
          type: string
          description: The client token used for idempotency.
        kmsKeyId:
          type: string
          description: The ARN or alias of the KMS key used for encryption.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: 'The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available
            for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the
            file system has been deleted), ERROR (the file system is in an error state), MISCONFIGURED (the file system has
            a misconfiguration), or UPDATING (the file system is being updated).'
        statusMessage:
          type: string
          description: Additional information about the file system status. This field provides more details when the status
            is ERROR, or during state transitions.
        roleArn:
          type: string
          description: The ARN of the IAM role used for S3 access.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the file system owner.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/S3FilesTag'
          description: The tags associated with the file system.
        name:
          type: string
          description: The name of the file system, derived from the Name tag if present.
    DeleteFileSystemRequest:
      type: object
      properties:
        fileSystemId:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the S3 File System to delete.
        forceDelete:
          type: boolean
          description: If true, allows deletion of a file system that contains data pending export to S3. If false (the default),
            the deletion will fail if there is data that has not yet been exported to the S3 bucket. Use this parameter with
            caution as it may result in data loss.
      required:
      - fileSystemId
    GetFileSystemRequest:
      type: object
      properties:
        fileSystemId:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.
      required:
      - fileSystemId
    GetFileSystemResponse:
      type: object
      properties:
        creationTime:
          type: string
          description: The time when the file system was created.
        fileSystemArn:
          type: string
          description: The Amazon Resource Name (ARN) of the file system.
        fileSystemId:
          type: string
          description: The ID of the file system.
        bucket:
          type: string
          description: The Amazon Resource Name (ARN) of the S3 bucket.
        prefix:
          type: string
          description: The prefix in the S3 bucket that the file system provides access to.
        clientToken:
          type: string
          description: The client token used for idempotency when the file system was created.
        kmsKeyId:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: The current status of the file system.
        statusMessage:
          type: string
          description: Additional information about the file system status.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role used for S3 access.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the file system owner.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/S3FilesTag'
          description: The tags associated with the file system.
        name:
          type: string
          description: The name of the file system.
    ListFileSystemsDescription:
      type: object
      properties:
        creationTime:
          type: string
          description: The time when the file system was created.
        fileSystemArn:
          type: string
          description: The Amazon Resource Name (ARN) of the file system.
        fileSystemId:
          type: string
          description: The ID of the file system.
        name:
          type: string
          description: The name of the file system.
        bucket:
          type: string
          description: The Amazon Resource Name (ARN) of the S3 bucket.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: The current status of the file system.
        statusMessage:
          type: string
          description: Additional information about the file system status.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role used for S3 access.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the file system owner.
      required:
      - creationTime
      - fileSystemArn
      - fileSystemId
      - bucket
      - status
      - roleArn
      - ownerId
    ListFileSystemsRequest:
      type: object
      properties:
        bucket:
          type: string
          description: Optional filter to list only file systems associated with the specified S3 bucket Amazon Resource Name
            (ARN). If provided, only file systems that provide access to this bucket will be returned in the response.
        maxResults:
          type: integer
          description: The maximum number of file systems to return in a single response. If not specified, up to 100 file
            systems are returned.
        nextToken:
          type: string
          description: A pagination token returned from a previous call to continue listing file systems.
    ListFileSystemsResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: A pagination token to use in a subsequent request if more results are available.
        fileSystems:
          type: array
          items:
            $ref: '#/components/schemas/ListFileSystemsDescription'
          description: An array of file system descriptions.
      required:
      - fileSystems
    ResourceNotFoundException:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code associated with the exception.
        message:
          type: string
      required:
      - errorCode
    S3FilesConflictException:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code associated with the exception.
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that caused the conflict.
        resourceType:
          type: string
          description: The type of the resource that caused the conflict.
      required:
      - errorCode
    S3FilesInternalServerException:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code associated with the exception.
        message:
          type: string
      required:
      - errorCode
    S3FilesServiceQuotaExceededException:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code associated with the exception.
        message:
          type: string
      required:
      - errorCode
    S3FilesTag:
      type: object
      properties:
        key:
          type: string
          description: The tag key. The key can't start with aws:.
        value:
          type: string
          description: The tag value.
      required:
      - key
      - value
    S3FilesValidationException:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code associated with the exception.
        message:
          type: string
      required:
      - errorCode
    ThrottlingException:
      type: object
      properties:
        errorCode:
          type: string
          description: The error code associated with the exception.
        message:
          type: string
      required:
      - errorCode
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/s3files/service/2025-05-05/s3files-2025-05-05.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)