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-efs:amazon-efs-policy-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Elastic File System Policy 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/file-systems/{FileSystemId}/policy:
    delete:
      operationId: DeleteFileSystemPolicy
      summary: Delete File System Policy
      description: Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect
        once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based
        Policies with EFS. This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: FileSystemNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemNotFound'
        '409':
          description: IncorrectFileSystemLifeCycleState
          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/DeleteFileSystemPolicyRequest'
      tags:
      - Policy
    get:
      operationId: DescribeFileSystemPolicy
      summary: Describe File System Policy
      description: Returns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for
        the elasticfilesystem:DescribeFileSystemPolicy action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemPolicyDescription'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: FileSystemNotFound; PolicyNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemNotFound'
        '500':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFileSystemPolicyRequest'
      tags:
      - Policy
    put:
      operationId: PutFileSystemPolicy
      summary: Put File System Policy
      description: Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based
        policy and can contain multiple policy statements. A file system always has exactly one file system policy, which
        can be the default policy or an explicit policy set or updated using this API operation. EFS file system policies
        have a 20,000 character limit. When an explicit policy is set, it overrides the default policy. For more information
        about the default file system policy, see Default EFS file system policy. EFS file system policies have a 20,000 character
        limit. This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemPolicyDescription'
        '400':
          description: BadRequest; InvalidPolicyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '404':
          description: FileSystemNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemNotFound'
        '409':
          description: IncorrectFileSystemLifeCycleState
          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/PutFileSystemPolicyRequest'
      tags:
      - Policy
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:
    BadRequest:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    DeleteFileSystemPolicyRequest:
      type: object
      properties:
        FileSystemId:
          type: string
          description: Specifies the EFS file system for which to delete the FileSystemPolicy.
      required:
      - FileSystemId
    DescribeFileSystemPolicyRequest:
      type: object
      properties:
        FileSystemId:
          type: string
          description: Specifies which EFS file system to retrieve the FileSystemPolicy for.
      required:
      - FileSystemId
    FileSystemNotFound:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    FileSystemPolicyDescription:
      type: object
      properties:
        FileSystemId:
          type: string
          description: Specifies the EFS file system to which the FileSystemPolicy applies.
        Policy:
          type: string
          description: The JSON formatted FileSystemPolicy for the EFS file system.
    IncorrectFileSystemLifeCycleState:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    InternalServerError:
      type: object
      properties:
        ErrorCode:
          type: string
        Message:
          type: string
      required:
      - ErrorCode
    PutFileSystemPolicyRequest:
      type: object
      properties:
        FileSystemId:
          type: string
          description: The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
        Policy:
          type: string
          description: The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. EFS file system
            policies have a 20,000 character limit. To find out more about the elements that make up a file system policy,
            see Resource-based policies within Amazon EFS.
        BypassPolicyLockoutSafetyCheck:
          type: boolean
          description: (Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.
            The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal
            that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck
            to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy
            requests on this file system. The default value is False.
      required:
      - FileSystemId
      - Policy
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)