AWS AppSync
API Reference (API Version 2017-07-25)

GetIntrospectionSchema

Retrieves the introspection schema for a GraphQL API.

Request Syntax

GET /apis/apiId/schema?format=format HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

apiId

The API ID.

format

The schema format: SDL or JSON.

Valid Values: SDL | JSON

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 schema

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

schema

The schema, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

Errors

For information about the errors that are common to all actions, see Common Errors.

GraphQLSchemaException

The GraphQL schema is not valid.

HTTP Status Code: 400

InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500

NotFoundException

The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: