Amazon EFS Efs Access Points API

openapi: 3.1.0
info:
  title: Amazon Elastic File System Access Points 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/access-points:
    post:
      operationId: CreateAccessPoint
      summary: Create Access Point
      description: Creates an EFS access point. An access point is an application-specific view into an EFS file system that
        applies an operating system user and group, and a file system path, to any file system request made through the access
        point. The operating system user and group override any identity information provided by the NFS client. The file
        system path is exposed as the access point's root directory. Applications using the access point can only access data
        in the application's own directory and any subdirectories. A file system can have a maximum of 10,000 access points
        unless you request an increase. To learn more, see Mounting a file system using EFS access points. If multiple requests
        to create access points on the same file system are sent in quick succession, and the file system is near the limit
        of access points, you may experience a throttling response for these requests. This is to ensure that the file system
        does not exceed the stated access point limit. This operation requires permissions for the elasticfilesystem:CreateAccessPoint
        action. Access points can be tagged on creation. If tags are specified in the creation action, IAM performs additional
        authorization on the elasti
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPointDescription'
        '409':
          description: AccessPointAlreadyExists; IncorrectFileSystemLifeCycleState
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPointAlreadyExists'
        '403':
          description: AccessPointLimitExceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPointLimitExceeded'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: FileSystemNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemNotFound'
        '500':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccessPointRequest'
      tags:
      - Access Points
    get:
      operationId: DescribeAccessPoints
      summary: Describe Access Points
      description: Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you
        provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either
        an AccessPointId or a FileSystemId in the request, but not both. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAccessPointsResponse'
        '404':
          description: AccessPointNotFound; FileSystemNotFound
          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/DescribeAccessPointsRequest'
      tags:
      - Access Points
  /2015-02-01/access-points/{AccessPointId}:
    delete:
      operationId: DeleteAccessPoint
      summary: Delete Access Point
      description: Deletes the specified access point. After deletion is complete, new clients can no longer connect to the
        access points. Clients connected to the access point at the time of deletion will continue to function until they
        terminate their connection. This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '404':
          description: AccessPointNotFound
          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/DeleteAccessPointRequest'
      tags:
      - Access Points
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:
    AccessPointAlreadyExists:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
        AccessPointId:
          type: string
      required:
      - ErrorCode
      - AccessPointId
    AccessPointDescription:
      type: object
      properties:
        ClientToken:
          type: string
          description: The opaque string specified in the request to ensure idempotent creation.
        Name:
          type: string
          description: The name of the access point. This is the value of the Name tag.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the access point, presented as an array of Tag objects.
        AccessPointId:
          type: string
          description: The ID of the access point, assigned by Amazon EFS.
        AccessPointArn:
          type: string
          description: The unique Amazon Resource Name (ARN) associated with the access point.
        FileSystemId:
          type: string
          description: The ID of the EFS file system that the access point applies to.
        PosixUser:
          $ref: '#/components/schemas/PosixUser'
        RootDirectory:
          $ref: '#/components/schemas/RootDirectory'
        OwnerId:
          type: string
          description: Identifies the Amazon Web Services account that owns the access point resource.
        LifeCycleState:
          type: string
          enum:
          - creating
          - available
          - updating
          - deleting
          - deleted
          - error
          description: Identifies the lifecycle phase of the access point.
    AccessPointLimitExceeded:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    AccessPointNotFound:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    BadRequest:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    CreateAccessPointRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique.
            For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
        FileSystemId:
          type: string
          description: The ID of the EFS file system that the access point provides access to.
        PosixUser:
          $ref: '#/components/schemas/PosixUser'
        RootDirectory:
          $ref: '#/components/schemas/RootDirectory'
      required:
      - ClientToken
      - FileSystemId
    CreationInfo:
      type: object
      properties:
        OwnerUid:
          type: integer
          description: Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
        OwnerGid:
          type: integer
          description: Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
        Permissions:
          type: string
          description: Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing
            the file's mode bits.
      required:
      - OwnerUid
      - OwnerGid
      - Permissions
    DeleteAccessPointRequest:
      type: object
      properties:
        AccessPointId:
          type: string
          description: The ID of the access point that you want to delete.
      required:
      - AccessPointId
    DescribeAccessPointsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: (Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems
            parameter to limit the number of objects returned in a response. The default value is 100.
        NextToken:
          type: string
          description: NextToken is present if the response is paginated. You can use NextMarker in the subsequent request
            to fetch the next page of access point descriptions.
        AccessPointId:
          type: string
          description: (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.
        FileSystemId:
          type: string
          description: (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually
            exclusive with AccessPointId.
    DescribeAccessPointsResponse:
      type: object
      properties:
        AccessPoints:
          type: array
          items:
            $ref: '#/components/schemas/AccessPointDescription'
          description: An array of access point descriptions.
        NextToken:
          type: string
          description: Present if there are more access points than returned in the response. You can use the NextMarker in
            the subsequent request to fetch the additional descriptions.
    FileSystemNotFound:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    InternalServerError:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    PosixUser:
      type: object
      properties:
        Uid:
          type: integer
          description: The POSIX user ID used for all file system operations using this access point.
        Gid:
          type: integer
          description: The POSIX group ID used for all file system operations using this access point.
        SecondaryGids:
          type: array
          items:
            type: integer
          description: Secondary POSIX group IDs used for all file system operations using this access point.
      required:
      - Uid
      - Gid
    RootDirectory:
      type: object
      properties:
        Path:
          type: string
          description: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the
            access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does
            not exist, you are required to provide the CreationInfo.
        CreationInfo:
          $ref: '#/components/schemas/CreationInfo'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key (String). The key can't start with aws:.
        Value:
          type: string
          description: The value of the tag key.
      required:
      - Key
      - Value
    ThrottlingException:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
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)