Amazon EFS Mount Targets API

openapi: 3.1.0
info:
  title: Amazon Elastic File System Mount Targets API
  version: '2015-02-01'
  description: Generated from AWS's published Smithy model for Amazon Elastic File System. 3 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://elasticfilesystem.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2015-02-01/mount-targets:
    post:
      operationId: CreateMountTarget
      summary: Create Mount Target
      description: 'Creates a mount target for a file system. You can then mount the file system on EC2 instances by using
        the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC
        within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets
        in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same
        subnet as the mount target in order to access their file system. You can create only one mount target for a One Zone
        file system. You must create that mount target in the same Availability Zone in which the file system is located.
        Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this
        information. Use the subnetId associated with the file system''s Availability Zone when creating the mount target.
        For more information, see Amazon EFS: How it Works. To create a mount target for a file system, the file system''s
        lifecycle state must be available. For more information, see DescribeFileSystems. In the request, provide the following:
        The file system ID for which you are creating the m'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MountTargetDescription'
              example:
                OwnerId: 012345678912
                MountTargetId: fsmt-12340abc
                FileSystemId: fs-01234567
                SubnetId: subnet-1234abcd
                LifeCycleState: creating
                IpAddress: 192.0.0.2
                NetworkInterfaceId: eni-cedf6789
        '400':
          description: AvailabilityZonesMismatch; BadRequest; SecurityGroupLimitExceeded; SecurityGroupNotFound; SubnetNotFound;
            UnsupportedAvailabilityZone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityZonesMismatch'
        '404':
          description: FileSystemNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemNotFound'
        '409':
          description: IncorrectFileSystemLifeCycleState; IpAddressInUse; MountTargetConflict; NetworkInterfaceLimitExceeded;
            NoFreeAddressesInSubnet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncorrectFileSystemLifeCycleState'
        '500':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMountTargetRequest'
            example:
              FileSystemId: fs-01234567
              SubnetId: subnet-1234abcd
      tags:
      - Mount Targets
    get:
      operationId: DescribeMountTargets
      summary: Describe Mount Targets
      description: Returns the descriptions of all the current mount targets, or a specific mount target, for a file system.
        When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.
        This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system
        ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeMountTargetsResponse'
              example:
                MountTargets:
                - MountTargetId: fsmt-12340abc
                  NetworkInterfaceId: eni-cedf6789
                  FileSystemId: fs-01234567
                  LifeCycleState: available
                  SubnetId: subnet-1234abcd
                  OwnerId: 012345678912
                  IpAddress: 192.0.0.2
        '404':
          description: AccessPointNotFound; FileSystemNotFound; MountTargetNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPointNotFound'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeMountTargetsRequest'
            example:
              FileSystemId: fs-01234567
      tags:
      - Mount Targets
  /2015-02-01/mount-targets/{MountTargetId}:
    delete:
      operationId: DeleteMountTarget
      summary: Delete Mount Target
      description: 'Deletes the specified mount target. This operation forcibly breaks any mounts of the file system by using
        the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid
        applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible.
        The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount
        target using this operation does not corrupt the file system itself. The file system you created remains. You can
        mount an EC2 instance in your VPC by using another mount target. This operation requires permissions for the following
        action on the file system: elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount
        target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation,
        which returns a list of mount target descriptions for the given file system. The operation also requires permissions
        for the following Amazon EC2 action on the mount target''s network interface: ec2:DeleteNetworkInterface'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '504':
          description: DependencyTimeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyTimeout'
        '500':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '404':
          description: MountTargetNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MountTargetNotFound'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteMountTargetRequest'
            example:
              MountTargetId: fsmt-12340abc
      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: elasticfilesystem
  schemas:
    AccessPointNotFound:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    AvailabilityZonesMismatch:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
    BadRequest:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    CreateMountTargetRequest:
      type: object
      properties:
        FileSystemId:
          type: string
          description: The ID of the file system for which to create the mount target.
        SubnetId:
          type: string
          description: The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is
            associated with the file system's Availability Zone.
        IpAddress:
          type: string
          description: If the IP address type for the mount target is IPv4, then specify the IPv4 address within the address
            range of the specified subnet.
        Ipv6Address:
          type: string
          description: If the IP address type for the mount target is IPv6, then specify the IPv6 address within the address
            range of the specified subnet.
        IpAddressType:
          type: string
          enum:
          - IPV4_ONLY
          - IPV6_ONLY
          - DUAL_STACK
          description: Specify the type of IP address of the mount target you are creating. Options are IPv4, dual stack,
            or IPv6. If you don’t specify an IpAddressType, then IPv4 is used. IPV4_ONLY – Create mount target with IPv4 only
            subnet or dual-stack subnet. DUAL_STACK – Create mount target with dual-stack subnet. IPV6_ONLY – Create mount
            target with IPv6 only subnet. Creating IPv6 mount target only ENI in dual-stack subnet is not supported.
        SecurityGroups:
          type: array
          items:
            type: string
          description: VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as the subnet specified.
            The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in
            the Amazon VPC User Guide (see the Security Groups table).
      required:
      - FileSystemId
      - SubnetId
    DeleteMountTargetRequest:
      type: object
      properties:
        MountTargetId:
          type: string
          description: The ID of the mount target to delete (String).
      required:
      - MountTargetId
    DependencyTimeout:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    DescribeMountTargetsRequest:
      type: object
      properties:
        MaxItems:
          type: integer
          description: (Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically
            set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount
            targets.
        Marker:
          type: string
          description: (Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String).
            If present, it specifies to continue the list from where the previous returning call left off.
        FileSystemId:
          type: string
          description: (Optional) ID of the file system whose mount targets you want to list (String). It must be included
            in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as
            input.
        MountTargetId:
          type: string
          description: (Optional) ID of the mount target that you want to have described (String). It must be included in
            your request if FileSystemId is not included. Accepts either a mount target ID or ARN as input.
        AccessPointId:
          type: string
          description: (Optional) The ID of the access point whose mount targets that you want to list. It must be included
            in your request if a FileSystemId or MountTargetId is not included in your request. Accepts either an access point
            ID or ARN as input.
    DescribeMountTargetsResponse:
      type: object
      properties:
        Marker:
          type: string
          description: If the request included the Marker, the response returns that value in this field.
        MountTargets:
          type: array
          items:
            $ref: '#/components/schemas/MountTargetDescription'
          description: Returns the file system's mount targets as an array of MountTargetDescription objects.
        NextMarker:
          type: string
          description: If a value is present, there are more mount targets to return. In a subsequent request, you can provide
            Marker in your request with this value to retrieve the next set of mount targets.
    FileSystemNotFound:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    IncorrectFileSystemLifeCycleState:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    InternalServerError:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    MountTargetDescription:
      type: object
      properties:
        OwnerId:
          type: string
          description: Amazon Web Services account ID that owns the resource.
        MountTargetId:
          type: string
          description: System-assigned mount target ID.
        FileSystemId:
          type: string
          description: The ID of the file system for which the mount target is intended.
        SubnetId:
          type: string
          description: The ID of the mount target's subnet.
        LifeCycleState:
          type: string
          enum:
          - creating
          - available
          - updating
          - deleting
          - deleted
          - error
          description: Lifecycle state of the mount target.
        IpAddress:
          type: string
          description: Address at which the file system can be mounted by using the mount target.
        Ipv6Address:
          type: string
          description: The IPv6 address for the mount target.
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface that Amazon EFS created when it created the mount target.
        AvailabilityZoneId:
          type: string
          description: The unique and consistent identifier of the Availability Zone that the mount target resides in. For
            example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every Amazon Web Services
            account.
        AvailabilityZoneName:
          type: string
          description: The name of the Availability Zone in which the mount target is located. Availability Zones are independently
            mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon
            Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.
        VpcId:
          type: string
          description: The virtual private cloud (VPC) ID that the mount target is configured in.
      required:
      - MountTargetId
      - FileSystemId
      - SubnetId
      - LifeCycleState
    MountTargetNotFound:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/efs/service/2015-02-01/efs-2015-02-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)