Skip to content
AWS for Query.Farm

aws.iotthingsgraph.get_system_template

Example SQL Queries

SELECT * FROM
aws.iotthingsgraph.get_system_template
WHERE
"id" = 'VALUE';

Description

Gets a system.

Table Definition

Column NameColumn Data Type
id Required Input Column

The ID of the system to get. This ID must be in the user's namespace.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME 

VARCHAR
revision_number Input Column

The number that specifies the revision of the system to get.

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
description

An object that contains summary data about the system.

STRUCT(
    "summary" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR,
        "revision_number" BIGINT,
        "created_at" TIMESTAMP_S
    ),
    "definition" STRUCT(
        "language" VARCHAR,
        "text" VARCHAR
    ),
    "validated_namespace_version" BIGINT
)
Show child fields
description.definition

The definition document of a system.

Show child fields
description.definition.language

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

description.definition.text

The GraphQL text that defines the entity.

description.summary

An object that contains summary information about a system.

Show child fields
description.summary.arn

The ARN of the system.

description.summary.created_at

The date when the system was created.

description.summary.id

The ID of the system.

description.summary.revision_number

The revision number of the system.

description.validated_namespace_version

The namespace version against which the system was validated. Use this value in your system instance.