Amazon S3 S3 Mount Targets API

The S3 Mount Targets API from Amazon S3 — 2 operation(s) for s3 mount targets.

GitHub OpenAPI

Operations 5

PUT /mount-targets Create Mount Target #
GET /mount-targets List Mount Targets #
DELETE /mount-targets/{mountTargetId} Delete Mount Target #
GET /mount-targets/{mountTargetId} Get Mount Target #
PUT /mount-targets/{mountTargetId} Update Mount Target #

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-mount-targets-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-mount-targets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Simple Storage Service Mount Targets API
  version: '2006-03-01'
  description: Generated from AWS's published Smithy model for Amazon Simple Storage Service. 5 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:
  /mount-targets:
    put:
      operationId: CreateMountTarget
      summary: Create Mount Target
      description: Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in
        a specific Availability Zone and VPC. Mount targets provide network access to the file system.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMountTargetResponse'
        '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/CreateMountTargetRequest'
      tags:
      - Mount Targets
    get:
      operationId: ListMountTargets
      summary: List Mount Targets
      description: Returns resource information for all mount targets with optional filtering by file system, access point,
        and VPC.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMountTargetsResponse'
        '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/ListMountTargetsRequest'
      tags:
      - Mount Targets
  /mount-targets/{mountTargetId}:
    delete:
      operationId: DeleteMountTarget
      summary: Delete Mount Target
      description: Deletes the specified mount target. This operation is irreversible.
      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/DeleteMountTargetRequest'
      tags:
      - Mount Targets
    get:
      operationId: GetMountTarget
      summary: Get Mount Target
      description: Returns detailed resource information for the specified mount target including network configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMountTargetResponse'
        '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/GetMountTargetRequest'
      tags:
      - Mount Targets
    put:
      operationId: UpdateMountTarget
      summary: Update Mount Target
      description: Updates the mount target resource, specifically security group configurations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMountTargetResponse'
        '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/UpdateMountTargetRequest'
      tags:
      - Mount Targets
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:
    CreateMountTargetRequest:
      type: object
      properties:
        fileSystemId:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for.
        subnetId:
          type: string
          description: The ID of the subnet where the mount target will be created. The subnet must be in the same Amazon
            Web Services Region as the file system. For file systems with regional availability, you can create mount targets
            in any subnet within the Region. The subnet determines the Availability Zone where the mount target will be located.
        ipv4Address:
          type: string
          description: A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports
            IPv4, an address is automatically assigned from the subnet's available IPv4 address range. The address must be
            within the subnet's CIDR block and not already in use.
        ipv6Address:
          type: string
          description: A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports
            IPv6, an address is automatically assigned from the subnet's available IPv6 address range. The address must be
            within the subnet's IPv6 CIDR block and not already in use.
        ipAddressType:
          type: string
          enum:
          - IPV4_ONLY
          - IPV6_ONLY
          - DUAL_STACK
          description: The IP address type for the mount target. If not specified, IPV4_ONLY is used. The IP address type
            must match the IP configuration of the specified subnet.
        securityGroups:
          type: array
          items:
            type: string
          description: An array of VPC security group IDs to associate with the mount target's network interface. These security
            groups control network access to the mount target. If not specified, the default security group for the subnet's
            VPC is used. All security groups must belong to the same VPC as the subnet.
      required:
      - fileSystemId
      - subnetId
    CreateMountTargetResponse:
      type: object
      properties:
        availabilityZoneId:
          type: string
          description: The unique and consistent identifier of the Availability Zone where the mount target is located. For
            example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same
            location in every Amazon Web Services account.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the mount target owner.
        mountTargetId:
          type: string
          description: The ID of the mount target, assigned by S3 Files. This ID is used to reference the mount target in
            subsequent API calls.
        fileSystemId:
          type: string
          description: The ID of the S3 File System associated with the mount target.
        subnetId:
          type: string
          description: The ID of the subnet where the mount target is located.
        ipv4Address:
          type: string
          description: The IPv4 address assigned to the mount target.
        ipv6Address:
          type: string
          description: The IPv6 address assigned to the mount target.
        networkInterfaceId:
          type: string
          description: The ID of the network interface that S3 Files created when it created the mount target. This network
            interface is managed by the service.
        vpcId:
          type: string
          description: The ID of the VPC where the mount target is located.
        securityGroups:
          type: array
          items:
            type: string
          description: The security groups associated with the mount target's network interface.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: 'The lifecycle state of the mount target. Valid values are: AVAILABLE (the mount target is available
            for use), CREATING (the mount target is being created), DELETING (the mount target is being deleted), DELETED
            (the mount target has been deleted), or ERROR (the mount target is in an error state), or UPDATING (the mount
            target is being updated).'
        statusMessage:
          type: string
          description: Additional information about the mount target status. This field provides more details when the status
            is ERROR, or during state transitions.
      required:
      - ownerId
      - mountTargetId
      - subnetId
    DeleteMountTargetRequest:
      type: object
      properties:
        mountTargetId:
          type: string
          description: The ID of the mount target to delete.
      required:
      - mountTargetId
    GetMountTargetRequest:
      type: object
      properties:
        mountTargetId:
          type: string
          description: The ID of the mount target to retrieve information for.
      required:
      - mountTargetId
    GetMountTargetResponse:
      type: object
      properties:
        availabilityZoneId:
          type: string
          description: The Availability Zone ID where the mount target is located.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the mount target owner.
        mountTargetId:
          type: string
          description: The ID of the mount target.
        fileSystemId:
          type: string
          description: The ID of the file system.
        subnetId:
          type: string
          description: The ID of the subnet where the mount target is located.
        ipv4Address:
          type: string
          description: The IPv4 address of the mount target.
        ipv6Address:
          type: string
          description: The IPv6 address of the mount target.
        networkInterfaceId:
          type: string
          description: The ID of the network interface associated with the mount target.
        vpcId:
          type: string
          description: The ID of the VPC where the mount target is located.
        securityGroups:
          type: array
          items:
            type: string
          description: The security groups associated with the mount target.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: The current status of the mount target.
        statusMessage:
          type: string
          description: Additional information about the mount target status.
      required:
      - ownerId
      - mountTargetId
      - subnetId
    ListMountTargetsDescription:
      type: object
      properties:
        availabilityZoneId:
          type: string
          description: The Availability Zone ID where the mount target is located.
        fileSystemId:
          type: string
          description: The ID of the S3 File System.
        ipv4Address:
          type: string
          description: The IPv4 address of the mount target.
        ipv6Address:
          type: string
          description: The IPv6 address of the mount target.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: The current status of the mount target.
        statusMessage:
          type: string
          description: Additional information about the mount target status.
        mountTargetId:
          type: string
          description: The ID of the mount target.
        networkInterfaceId:
          type: string
          description: The ID of the network interface associated with the mount target.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the mount target owner.
        subnetId:
          type: string
          description: The ID of the subnet where the mount target is located.
        vpcId:
          type: string
          description: The ID of the VPC where the mount target is located.
      required:
      - mountTargetId
      - ownerId
      - subnetId
    ListMountTargetsRequest:
      type: object
      properties:
        fileSystemId:
          type: string
          description: Optional filter to list only mount targets associated with the specified S3 File System ID or Amazon
            Resource Name (ARN). If provided, only mount targets for this file system will be returned in the response.
        accessPointId:
          type: string
          description: Optional filter to list only mount targets associated with the specified access point ID or Amazon
            Resource Name (ARN).
        maxResults:
          type: integer
          description: The maximum number of mount targets to return in a single response.
        nextToken:
          type: string
          description: A pagination token returned from a previous call to continue listing mount targets.
    ListMountTargetsResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: A pagination token to use in a subsequent request if more results are available.
        mountTargets:
          type: array
          items:
            $ref: '#/components/schemas/ListMountTargetsDescription'
          description: An array of mount target descriptions.
      required:
      - mountTargets
    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
    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
    UpdateMountTargetRequest:
      type: object
      properties:
        mountTargetId:
          type: string
          description: The ID of the mount target to update.
        securityGroups:
          type: array
          items:
            type: string
          description: An array of VPC security group IDs to associate with the mount target's network interface. This replaces
            the existing security groups. All security groups must belong to the same VPC as the mount target's subnet.
      required:
      - mountTargetId
      - securityGroups
    UpdateMountTargetResponse:
      type: object
      properties:
        availabilityZoneId:
          type: string
          description: The Availability Zone ID where the mount target is located.
        ownerId:
          type: string
          description: The Amazon Web Services account ID of the mount target owner.
        mountTargetId:
          type: string
          description: The ID of the mount target.
        fileSystemId:
          type: string
          description: The ID of the S3 File System.
        subnetId:
          type: string
          description: The ID of the subnet where the mount target is located.
        ipv4Address:
          type: string
          description: The IPv4 address of the mount target.
        ipv6Address:
          type: string
          description: The IPv6 address of the mount target.
        networkInterfaceId:
          type: string
          description: The ID of the network interface associated with the mount target.
        vpcId:
          type: string
          description: The ID of the VPC where the mount target is located.
        securityGroups:
          type: array
          items:
            type: string
          description: The security groups associated with the mount target.
        status:
          type: string
          enum:
          - available
          - creating
          - deleting
          - deleted
          - error
          - updating
          - misconfigured
          description: The current status of the mount target.
        statusMessage:
          type: string
          description: Additional information about the mount target status.
      required:
      - ownerId
      - mountTargetId
      - subnetId
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)