AppSync / Client / get_introspection_schema

get_introspection_schema

AppSync.Client.get_introspection_schema(**kwargs)

Retrieves the introspection schema for a GraphQL API.

See also: AWS API Documentation

Request Syntax

response = client.get_introspection_schema(
    apiId='string',
    format='SDL'|'JSON',
    includeDirectives=True|False
)

Parameters:

• apiId (string) –

  [REQUIRED]

  The API ID.

• format (string) –

  [REQUIRED]

  The schema format: SDL or JSON.

• includeDirectives (boolean) – A flag that specifies whether the schema introspection should contain directives.

Return type:

dict

Returns:

Response Syntax

{
    'schema': StreamingBody()
}

Response Structure

• (dict) –

  • schema (StreamingBody) –

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

    For more information, see the GraphQL SDL documentation.

Exceptions

• AppSync.Client.exceptions.GraphQLSchemaException

• AppSync.Client.exceptions.NotFoundException

• AppSync.Client.exceptions.UnauthorizedException

• AppSync.Client.exceptions.InternalFailureException