Amazon AppSync Schema API

Manage GraphQL schema documents

GitHub OpenAPI

Operations 3

GET /v1/apis/{apiId}/schema Get Introspection Schema #
GET /v1/apis/{apiId}/schemacreation Get Schema Creation Status #
POST /v1/apis/{apiId}/schemacreation Start Schema Creation #

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-appsync:amazon-appsync-schema-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-appsync-schema-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS AppSync Schema API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS AppSync. 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://appsync.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/apis/{apiId}/schema:
    get:
      operationId: GetIntrospectionSchema
      summary: Get Introspection Schema
      description: Retrieves the introspection schema for a GraphQL API.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntrospectionSchemaResponse'
        '400':
          description: GraphQLSchemaException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphQLSchemaException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIntrospectionSchemaRequest'
      tags:
      - Schema
  /v1/apis/{apiId}/schemacreation:
    get:
      operationId: GetSchemaCreationStatus
      summary: Get Schema Creation Status
      description: Retrieves the current status of a schema creation operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSchemaCreationStatusResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSchemaCreationStatusRequest'
      tags:
      - Schema
    post:
      operationId: StartSchemaCreation
      summary: Start Schema Creation
      description: Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartSchemaCreationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConcurrentModificationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSchemaCreationRequest'
      tags:
      - Schema
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: appsync
  schemas:
    BadRequestDetail:
      type: object
      properties:
        codeErrors:
          type: array
          items:
            $ref: '#/components/schemas/CodeError'
          description: Contains the list of errors in the request.
    BadRequestException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CODE_ERROR
        detail:
          $ref: '#/components/schemas/BadRequestDetail'
    CodeError:
      type: object
      properties:
        errorType:
          type: string
          description: 'The type of code error. Examples include, but aren''t limited to: LINT_ERROR, PARSER_ERROR.'
        value:
          type: string
          description: 'A user presentable error. Examples include, but aren''t limited to: Parsing error: Unterminated string
            literal.'
        location:
          $ref: '#/components/schemas/CodeErrorLocation'
    CodeErrorLocation:
      type: object
      properties:
        line:
          type: integer
          description: The line number in the code. Defaults to 0 if unknown.
        column:
          type: integer
          description: The column number in the code. Defaults to 0 if unknown.
        span:
          type: integer
          description: The span/length of the error. Defaults to -1 if unknown.
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    GetIntrospectionSchemaRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The API ID.
        format:
          type: string
          enum:
          - SDL
          - JSON
          description: 'The schema format: SDL or JSON.'
        includeDirectives:
          type: boolean
          description: A flag that specifies whether the schema introspection should contain directives.
      required:
      - apiId
      - format
    GetIntrospectionSchemaResponse:
      type: object
      properties:
        schema:
          type: string
          format: byte
          description: The schema, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL
            SDL documentation.
    GetSchemaCreationStatusRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The API ID.
      required:
      - apiId
    GetSchemaCreationStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - PROCESSING
          - ACTIVE
          - DELETING
          - FAILED
          - SUCCESS
          - NOT_APPLICABLE
          description: The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is
            in the ACTIVE state, you can add data.
        details:
          type: string
          description: Detailed information about the status of the schema creation operation.
    GraphQLSchemaException:
      type: object
      properties:
        message:
          type: string
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    StartSchemaCreationRequest:
      type: object
      properties:
        apiId:
          type: string
          description: The API ID.
        definition:
          type: string
          format: byte
          description: The schema definition, in GraphQL schema language format.
      required:
      - apiId
      - definition
    StartSchemaCreationResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - PROCESSING
          - ACTIVE
          - DELETING
          - FAILED
          - SUCCESS
          - NOT_APPLICABLE
          description: The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is
            in the ACTIVE state, you can add data.
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/appsync/service/2017-07-25/appsync-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)