aws.iottwinmaker.get_entity

Example SQL Queries

SELECT * FROM
aws.iottwinmaker.get_entity
WHERE
"workspace_id" = 'VALUE'
AND "entity_id" = 'VALUE';

Description

Retrieves information about an entity.

• View All IoTTwinMaker Tables
• Boto3 Reference

Table Definition

Column Name	Column Data Type
entity_id Required Input Column The ID of the entity.	VARCHAR
workspace_id Required Input Column The ID of the workspace.	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
are_all_components_returned This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.	BOOLEAN
arn The ARN of the entity.	VARCHAR
components An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.	MAP(VARCHAR, STRUCT( "component_name" VARCHAR, "description" VARCHAR, "component_type_id" VARCHAR, "status" STRUCT( "state" VARCHAR, "error" STRUCT( "code" VARCHAR, "message" VARCHAR ) ), "defined_in" VARCHAR, "properties" MAP(VARCHAR, STRUCT( "definition" 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 ), "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 ), "are_all_property_values_returned" BOOLEAN )), "property_groups" MAP(VARCHAR, STRUCT( "group_type" VARCHAR, "property_names" VARCHAR[], "is_inherited" BOOLEAN )), "sync_source" VARCHAR, "are_all_properties_returned" BOOLEAN, "composite_components" MAP(VARCHAR, STRUCT( "component_name" VARCHAR, "component_type_id" VARCHAR, "defined_in" VARCHAR, "description" VARCHAR, "property_groups" MAP(VARCHAR, STRUCT( "group_type" VARCHAR, "property_names" VARCHAR[], "is_inherited" BOOLEAN )), "status" STRUCT( "state" VARCHAR, "error" STRUCT( "code" VARCHAR, "message" VARCHAR ) ), "sync_source" VARCHAR, "component_path" VARCHAR )), "are_all_composite_components_returned" BOOLEAN ))
creation_date_time The date and time when the entity was created.	TIMESTAMP_S
description The description of the entity.	VARCHAR
entity_name The name of the entity.	VARCHAR
has_child_entities A Boolean value that specifies whether the entity has associated child entities.	BOOLEAN
parent_entity_id The ID of the parent entity for this entity.	VARCHAR
status The current status of the entity.	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 sync job, if this entity was created by a sync job.	VARCHAR
update_date_time The date and time when the entity was last updated.	TIMESTAMP_S

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.