Skip to content

aws.iottwinmaker.get_property_value

Example SQL Queries

SELECT * FROM
aws.iottwinmaker.get_property_value
WHERE
"selected_properties" = 'VALUE'
AND "workspace_id" = 'VALUE';

Description

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

Table Definition

Column NameColumn Data Type
selected_properties Required Input Column

The properties whose values the operation returns.

VARCHAR[]
Show child fields
selected_properties[]
workspace_id Required Input Column

The ID of the workspace whose values the operation returns.

VARCHAR
component_name Input Column

The name of the component whose property values the operation returns.

VARCHAR
component_path Input Column

This string specifies the path to the composite component, starting from the top-level component.

VARCHAR
component_type_id Input Column

The ID of the component type whose property values the operation returns.

VARCHAR
entity_id Input Column

The ID of the entity whose property values the operation returns.

VARCHAR
max_results Input Column

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

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

BIGINT
next_token Input Column

The string that specifies the next page of results.

VARCHAR
property_group_name Input Column

The property group name.

VARCHAR
tabular_conditions Input Column

The tabular conditions.

STRUCT(
"order_by" STRUCT(
"order" VARCHAR,
"property_name" VARCHAR
)[],
"property_filters" STRUCT(
"property_name" VARCHAR,
"operator" 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
)
)[]
)
Show child fields
tabular_conditions.order_by[]
Show child fields
tabular_conditions.order_by[].order

The set order that filters results.

tabular_conditions.order_by[].property_name

The property name.

tabular_conditions.property_filters[]
Show child fields
tabular_conditions.property_filters[].operator

The operator associated with this property filter.

tabular_conditions.property_filters[].property_name

The property name associated with this property filter.

tabular_conditions.property_filters[].value

The value associated with this property filter.

Show child fields
tabular_conditions.property_filters[].value.boolean_value

A Boolean value.

tabular_conditions.property_filters[].value.double_value

A double value.

tabular_conditions.property_filters[].value.expression

An expression that produces the value.

tabular_conditions.property_filters[].value.integer_value

An integer value.

tabular_conditions.property_filters[].value.long_value

A long value.

tabular_conditions.property_filters[].value.relationship_value

A value that relates a component to another component.

Show child fields
tabular_conditions.property_filters[].value.relationship_value.target_component_name

The name of the target component associated with the relationship value.

tabular_conditions.property_filters[].value.relationship_value.target_entity_id

The ID of the target entity associated with this relationship value.

tabular_conditions.property_filters[].value.string_value

A string value.

_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
property_values

An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

MAP(VARCHAR, STRUCT(
"property_reference" STRUCT(
"component_name" VARCHAR,
"component_path" VARCHAR,
"external_id_property" MAP(VARCHAR, VARCHAR),
"entity_id" VARCHAR,
"property_name" VARCHAR
),
"property_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
)
))
tabular_property_values

A table of property values.

MAP(VARCHAR, 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
))[][]
Show child fields
tabular_property_values[][]