data_source_introspections

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

Overview

Name	data_source_introspections
Type	Resource
Id	aws.appsync.data_source_introspections

Fields

The following fields are returned by SELECT queries:

get_data_source_introspection

Name	Datatype	Description
introspection_id	string	The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
introspection_result	object	The DataSourceIntrospectionResult object data.
introspection_status	string	The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail. (PROCESSING, FAILED, SUCCESS)
introspection_status_detail	string	The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_source_introspection	select	introspection_id, region	includeModelsSDL, nextToken, maxResults	Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

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
introspection_id	string	The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
region	string	AWS region (default: us-east-1)
includeModelsSDL	boolean	A boolean flag that determines whether SDL should be generated for introspected types. If set to true, each model will contain an sdl property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.
maxResults	integer	The maximum number of introspected types that will be returned in a single response.
nextToken	string	Determines the number of types to be returned in a single response before paginating. This value is typically taken from nextToken value from the previous response.

SELECT examples

get_data_source_introspection

Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

SELECT
introspection_id,
introspection_result,
introspection_status,
introspection_status_detail
FROM aws.appsync.data_source_introspections
WHERE introspection_id = '{{ introspection_id }}' -- required
AND region = '{{ region }}' -- required
AND includeModelsSDL = '{{ includeModelsSDL }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;