introspection_schemas

Creates, updates, deletes, gets or lists an introspection_schemas resource.

Overview

Name	introspection_schemas
Type	Resource
Id	aws.appsync.introspection_schemas

Fields

The following fields are returned by SELECT queries:

get_introspection_schema

Name	Datatype	Description
schema	string (byte)	The schema, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_introspection_schema	select	api_id, format, region	includeDirectives	Retrieves the introspection schema for a GraphQL API.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_id	string	The API ID.
format	string	The schema format: SDL or JSON.
region	string	AWS region (default: us-east-1)
includeDirectives	boolean	A flag that specifies whether the schema introspection should contain directives.

SELECT examples

get_introspection_schema

Retrieves the introspection schema for a GraphQL API.

SELECT
schema
FROM aws.appsync.introspection_schemas
WHERE api_id = '{{ api_id }}' -- required
AND format = '{{ format }}' -- required
AND region = '{{ region }}' -- required
AND includeDirectives = '{{ includeDirectives }}'
;