AppSync / Client / get_schema_creation_status

get_schema_creation_status

AppSync.Client.get_schema_creation_status(**kwargs)

Retrieves the current status of a schema creation operation.

See also: AWS API Documentation

Request Syntax

response = client.get_schema_creation_status(
    apiId='string'
)

Parameters:

apiId (string) –

[REQUIRED]

The API ID.

Return type:

dict

Returns:

Response Syntax

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

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.

  • details (string) –

    Detailed information about the status of the schema creation operation.

Exceptions

• AppSync.Client.exceptions.BadRequestException

• AppSync.Client.exceptions.NotFoundException

• AppSync.Client.exceptions.UnauthorizedException

• AppSync.Client.exceptions.InternalFailureException