Skip to content
AWS for Query.Farm

aws.iotsitewise.execute_query

Example SQL Queries

SELECT * FROM
aws.iotsitewise.execute_query
WHERE
"query_statement" = 'VALUE';

Description

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Table Definition

Column NameColumn Data Type
query_statement Required Input Column

The IoT SiteWise query statement.

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
columns

Represents a single column in the query results.

STRUCT(
    "name" VARCHAR,
    "type" STRUCT(
        "scalar_type" VARCHAR
    )
)[]
Show child fields
columns[]
Show child fields
columns[].name

The name of the column description.

columns[].type

The type of the column description.

Show child fields
columns[].type.scalar_type

The allowed data types that the column has as it's value.

rows

Represents a single row in the query results.

STRUCT(
    "data" STRUCT(
        "scalar_value" VARCHAR,
        "null_value" BOOLEAN
    )[]
)[]
Show child fields
rows[]
Show child fields
rows[].data[]
Show child fields
rows[].data[].null_value

Indicates if the data point is null.

rows[].data[].scalar_value

Indicates if the data point is a scalar value such as integer, string, double, or Boolean.