AppSync / Client / start_schema_creation

start_schema_creation#

AppSync.Client.start_schema_creation(**kwargs)#

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

See also: AWS API Documentation

Request Syntax

response = client.start_schema_creation(
    apiId='string',
    definition=b'bytes'
)
Parameters:

  • apiId (string) –

    [REQUIRED]

    The API ID.

  • definition (bytes) –

    [REQUIRED]

    The schema definition, in GraphQL schema language format.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'PROCESSING'|'ACTIVE'|'DELETING'|'FAILED'|'SUCCESS'|'NOT_APPLICABLE'
}

Response Structure

  • (dict) –

    • status (string) –

      The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

Exceptions