Skip to content

aws.appsync.get_data_source_introspection

Example SQL Queries

SELECT * FROM
aws.appsync.get_data_source_introspection
WHERE
"introspection_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
introspection_id Required Input Column

The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

VARCHAR
include_models_sdl Input Column

A boolean flag that determines whether SDL should be generated for introspected types or not. 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.

BOOLEAN
max_results Input Column

The maximum number of introspected types that will be returned in a single response.

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
introspection_result

The DataSourceIntrospectionResult object data.

STRUCT(
"models" STRUCT(
"name" VARCHAR,
"fields" STRUCT(
"name" VARCHAR,
"type" STRUCT(
"kind" VARCHAR,
"name" VARCHAR,
"values" VARCHAR[]
),
"length" BIGINT
)[],
"primary_key" STRUCT(
"name" VARCHAR,
"fields" VARCHAR[]
),
"indexes" STRUCT(
"name" VARCHAR,
"fields" VARCHAR[]
)[],
"sdl" VARCHAR
)[],
"next_token" VARCHAR
)
Show child fields
introspection_result.models[]
Show child fields
introspection_result.models[].fields[]
Show child fields
introspection_result.models[].fields[].length

The length value of the introspected field.

introspection_result.models[].fields[].name

The name of the field that was retrieved from the introspected data.

introspection_result.models[].fields[].type

The DataSourceIntrospectionModelFieldType object data.

Show child fields
introspection_result.models[].fields[].type.kind

Specifies the classification of data. For example, this could be set to values like Scalar or NonNull to indicate a fundamental property of the field.

Valid values include:

  • Scalar: Indicates the value is a primitive type (scalar).

  • NonNull: Indicates the field cannot be null.

  • List: Indicates the field contains a list.

introspection_result.models[].fields[].type.name

The name of the data type that represents the field. For example, String is a valid name value.

introspection_result.models[].fields[].type.values[]
introspection_result.models[].indexes[]
Show child fields
introspection_result.models[].indexes[].fields[]
introspection_result.models[].indexes[].name

The name of the index.

introspection_result.models[].name

The name of the model. For example, this could be the name of a single table in a database.

introspection_result.models[].primary_key

The primary key stored as a DataSourceIntrospectionModelIndex object.

Show child fields
introspection_result.models[].primary_key.fields[]
introspection_result.models[].primary_key.name

The name of the index.

introspection_result.models[].sdl

Contains the output of the SDL that was generated from the introspected types. This is controlled by the includeModelsSDL parameter of the GetDataSourceIntrospection operation.

introspection_result.next_token

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.

introspection_status

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.

VARCHAR
introspection_status_detail

The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

VARCHAR