schema_creation_status

Creates, updates, deletes, gets or lists a schema_creation_status resource.

Overview

Name	schema_creation_status
Type	Resource
Id	aws.appsync.schema_creation_status

Fields

The following fields are returned by SELECT queries:

get_schema_creation_status

Name	Datatype	Description
details	string	Detailed information about the status of the schema creation operation.
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. (PROCESSING, ACTIVE, DELETING, FAILED, SUCCESS, NOT_APPLICABLE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schema_creation_status	select	api_id, region		Retrieves the current status of a schema creation operation.

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.
region	string	AWS region (default: us-east-1)

SELECT examples

get_schema_creation_status

Retrieves the current status of a schema creation operation.

SELECT
details,
status
FROM aws.appsync.schema_creation_status
WHERE api_id = '{{ api_id }}' -- required
AND region = '{{ region }}' -- required
;