Skip to content

aws.iottwinmaker.get_component_type

Example SQL Queries

SELECT * FROM
aws.iottwinmaker.get_component_type
WHERE
"workspace_id" = 'VALUE'
AND "component_type_id" = 'VALUE';

Description

Retrieves information about a component type.

Table Definition

Column NameColumn Data Type
component_type_id Required Input Column

The ID of the component type.

VARCHAR
workspace_id Required Input Column

The ID of the workspace that contains the component type.

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
arn

The ARN of the component type.

VARCHAR
component_type_name

The component type name.

VARCHAR
composite_component_types

This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

MAP(VARCHAR, STRUCT(
"component_type_id" VARCHAR,
"is_inherited" BOOLEAN
))
creation_date_time

The date and time when the component type was created.

TIMESTAMP_S
description

The description of the component type.

VARCHAR
extends_from

The name of the parent component type that this component type extends.

VARCHAR[]
Show child fields
extends_from[]
functions

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

MAP(VARCHAR, STRUCT(
"required_properties" VARCHAR[],
"scope" VARCHAR,
"implemented_by" STRUCT(
"lambda" STRUCT(
"arn" VARCHAR
),
"is_native" BOOLEAN
),
"is_inherited" BOOLEAN
))
is_abstract

A Boolean value that specifies whether the component type is abstract.

BOOLEAN
is_schema_initialized

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

BOOLEAN
is_singleton

A Boolean value that specifies whether an entity can have more than one component of this type.

BOOLEAN
property_definitions

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

MAP(VARCHAR, STRUCT(
"data_type" STRUCT(
"type" VARCHAR,
"allowed_values" STRUCT(
"boolean_value" BOOLEAN,
"double_value" DOUBLE,
"integer_value" BIGINT,
"long_value" BIGINT,
"string_value" VARCHAR,
"relationship_value" STRUCT(
"target_entity_id" VARCHAR,
"target_component_name" VARCHAR
),
"expression" VARCHAR
)[],
"unit_of_measure" VARCHAR,
"relationship" STRUCT(
"target_component_type_id" VARCHAR,
"relationship_type" VARCHAR
)
),
"is_time_series" BOOLEAN,
"is_required_in_entity" BOOLEAN,
"is_external_id" BOOLEAN,
"is_stored_externally" BOOLEAN,
"is_imported" BOOLEAN,
"is_final" BOOLEAN,
"is_inherited" BOOLEAN,
"default_value" STRUCT(
"boolean_value" BOOLEAN,
"double_value" DOUBLE,
"integer_value" BIGINT,
"long_value" BIGINT,
"string_value" VARCHAR,
"relationship_value" STRUCT(
"target_entity_id" VARCHAR,
"target_component_name" VARCHAR
),
"expression" VARCHAR
),
"configuration" MAP(VARCHAR, VARCHAR),
"display_name" VARCHAR
))
property_groups

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

MAP(VARCHAR, STRUCT(
"group_type" VARCHAR,
"property_names" VARCHAR[],
"is_inherited" BOOLEAN
))
status

The current status of the component type.

STRUCT(
"state" VARCHAR,
"error" STRUCT(
"code" VARCHAR,
"message" VARCHAR
)
)
Show child fields
status.error

The error message.

Show child fields
status.error.code

The error code.

status.error.message

The error message.

status.state

The current state of the entity, component, component type, or workspace.

sync_source

The syncSource of the SyncJob, if this entity was created by a SyncJob.

VARCHAR
update_date_time

The date and time when the component was last updated.

TIMESTAMP_S