[ aws . appsync ]

get-introspection-schema

Description

Retrieves the introspection schema for a GraphQL API.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-introspection-schema
--api-id <value>
--format <value>
[--include-directives | --no-include-directives]
<outfile>

Options

--api-id (string)

The API ID.

--format (string)

The schema format: SDL or JSON.

Possible values:

  • SDL

  • JSON

--include-directives | --no-include-directives (boolean)

A flag that specifies whether the schema introspection should contain directives.

outfile (string) Filename where the content will be saved

See ‘aws help’ for descriptions of global parameters.

Output

schema -> (blob)

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

For more information, see the GraphQL SDL documentation .