Skip to content
AWS for Query.Farm

aws.iottwinmaker.list_properties

Example SQL Queries

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

Description

This API lists the properties of a component.

Table Definition

Column NameColumn Data Type
entity_id Required Input Column

The ID for the entity whose metadata (component/properties) is returned by the operation.

VARCHAR
workspace_id Required Input Column

The workspace ID.

VARCHAR
component_name Input Column

The name of the component whose properties are returned by the operation.

VARCHAR
component_path Input Column

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

VARCHAR
max_results Input Column

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

BIGINT
next_token Input Column

The string that specifies the next page of property results.

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
property_summaries

A list of objects that contain information about the properties.

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
    ),
    "property_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
)[]
Show child fields
property_summaries[]
Show child fields
property_summaries[].are_all_property_values_returned

This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

property_summaries[].definition

This is the schema for the property.

Show child fields
property_summaries[].definition.configuration

A mapping that specifies configuration information about the property.

property_summaries[].definition.data_type

An object that contains information about the data type.

Show child fields
property_summaries[].definition.data_type.allowed_values[]
Show child fields
property_summaries[].definition.data_type.allowed_values[].boolean_value

A Boolean value.

property_summaries[].definition.data_type.allowed_values[].double_value

A double value.

property_summaries[].definition.data_type.allowed_values[].expression

An expression that produces the value.

property_summaries[].definition.data_type.allowed_values[].integer_value

An integer value.

property_summaries[].definition.data_type.allowed_values[].long_value

A long value.

property_summaries[].definition.data_type.allowed_values[].relationship_value

A value that relates a component to another component.

Show child fields
property_summaries[].definition.data_type.allowed_values[].relationship_value.target_component_name

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

property_summaries[].definition.data_type.allowed_values[].relationship_value.target_entity_id

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

property_summaries[].definition.data_type.allowed_values[].string_value

A string value.

property_summaries[].definition.data_type.relationship

A relationship that associates a component with another component.

Show child fields
property_summaries[].definition.data_type.relationship.relationship_type

The type of the relationship.

property_summaries[].definition.data_type.relationship.target_component_type_id

The ID of the target component type associated with this relationship.

property_summaries[].definition.data_type.type

The underlying type of the data type.

property_summaries[].definition.data_type.unit_of_measure

The unit of measure used in this data type.

property_summaries[].definition.default_value

An object that contains the default value.

Show child fields
property_summaries[].definition.default_value.boolean_value

A Boolean value.

property_summaries[].definition.default_value.double_value

A double value.

property_summaries[].definition.default_value.expression

An expression that produces the value.

property_summaries[].definition.default_value.integer_value

An integer value.

property_summaries[].definition.default_value.long_value

A long value.

property_summaries[].definition.default_value.relationship_value

A value that relates a component to another component.

Show child fields
property_summaries[].definition.default_value.relationship_value.target_component_name

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

property_summaries[].definition.default_value.relationship_value.target_entity_id

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

property_summaries[].definition.default_value.string_value

A string value.

property_summaries[].definition.display_name

A friendly name for the property.

property_summaries[].definition.is_external_id

A Boolean value that specifies whether the property ID comes from an external data store.

property_summaries[].definition.is_final

A Boolean value that specifies whether the property definition can be updated.

property_summaries[].definition.is_imported

A Boolean value that specifies whether the property definition is imported from an external data store.

property_summaries[].definition.is_inherited

A Boolean value that specifies whether the property definition is inherited from a parent entity.

property_summaries[].definition.is_required_in_entity

A Boolean value that specifies whether the property is required in an entity.

property_summaries[].definition.is_stored_externally

A Boolean value that specifies whether the property is stored externally.

property_summaries[].definition.is_time_series

A Boolean value that specifies whether the property consists of time series data.

property_summaries[].property_name

This is the name of the property.

property_summaries[].value

This is the value for the property.

Show child fields
property_summaries[].value.boolean_value

A Boolean value.

property_summaries[].value.double_value

A double value.

property_summaries[].value.expression

An expression that produces the value.

property_summaries[].value.integer_value

An integer value.

property_summaries[].value.long_value

A long value.

property_summaries[].value.relationship_value

A value that relates a component to another component.

Show child fields
property_summaries[].value.relationship_value.target_component_name

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

property_summaries[].value.relationship_value.target_entity_id

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

property_summaries[].value.string_value

A string value.