Skip to content
AWS for Query.Farm

aws.iottwinmaker.list_entities

Example SQL Queries

SELECT * FROM
aws.iottwinmaker.list_entities
WHERE
"workspace_id" = 'VALUE';

Description

Lists all entities in a workspace.

Table Definition

Column NameColumn Data Type
workspace_id Required Input Column

The ID of the workspace.

VARCHAR
filters Input Column

A list of objects that filter the request.

Only one object is accepted as a valid input.

STRUCT(
    "parent_entity_id" VARCHAR,
    "component_type_id" VARCHAR,
    "external_id" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].component_type_id

The ID of the component type in the entities in the list.

filters[].external_id

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

filters[].parent_entity_id

The parent of the entities in the list.

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

A list of objects that contain information about the entities.

STRUCT(
    "entity_id" VARCHAR,
    "entity_name" VARCHAR,
    "arn" VARCHAR,
    "parent_entity_id" VARCHAR,
    "status" STRUCT(
        "state" VARCHAR,
        "error" STRUCT(
            "code" VARCHAR,
            "message" VARCHAR
        )
    ),
    "description" VARCHAR,
    "has_child_entities" BOOLEAN,
    "creation_date_time" TIMESTAMP_S,
    "update_date_time" TIMESTAMP_S
)[]
Show child fields
entity_summaries[]
Show child fields
entity_summaries[].arn

The ARN of the entity.

entity_summaries[].creation_date_time

The date and time when the entity was created.

entity_summaries[].description

The description of the entity.

entity_summaries[].entity_id

The ID of the entity.

entity_summaries[].entity_name

The name of the entity.

entity_summaries[].has_child_entities

An eventual Boolean value that specifies whether the entity has child entities or not.

entity_summaries[].parent_entity_id

The ID of the parent entity.

entity_summaries[].status

The current status of the entity.

Show child fields
entity_summaries[].status.error

The error message.

Show child fields
entity_summaries[].status.error.code

The error code.

entity_summaries[].status.error.message

The error message.

entity_summaries[].status.state

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

entity_summaries[].update_date_time

The last date and time when the entity was updated.