Skip to content
AWS for Query.Farm

aws.iotthingsgraph.get_entities

Example SQL Queries

SELECT * FROM
aws.iotthingsgraph.get_entities
WHERE
"ids" = 'VALUE';

Description

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

  • Properties

  • States

  • Events

  • Actions

  • Capabilities

  • Mappings

  • Devices

  • Device Models

  • Services

This action doesn't return definitions for systems, flows, and deployments.

Table Definition

Column NameColumn Data Type
ids Required Input Column

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME 

VARCHAR[]
Show child fields
ids[]
namespace_version Input Column

The version of the user's namespace. Defaults to the latest version of the user's namespace.

BIGINT
_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
descriptions

An array of descriptions for the specified entities.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "type" VARCHAR,
    "created_at" TIMESTAMP_S,
    "definition" STRUCT(
        "language" VARCHAR,
        "text" VARCHAR
    )
)[]
Show child fields
descriptions[]
Show child fields
descriptions[].arn

The entity ARN.

descriptions[].created_at

The time at which the entity was created.

descriptions[].definition

The definition document of the entity.

Show child fields
descriptions[].definition.language

The language used to define the entity. GRAPHQL is the only valid value.

descriptions[].definition.text

The GraphQL text that defines the entity.

descriptions[].id

The entity ID.

descriptions[].type

The entity type.