Skip to content
AWS for Query.Farm

aws.iot.describe_thing_group

Example SQL Queries

SELECT * FROM
aws.iot.describe_thing_group
WHERE
"thing_group_name" = 'VALUE';

Description

Describe a thing group.

Requires permission to access the DescribeThingGroup action.

Table Definition

Column NameColumn Data Type
thing_group_name Required Input Column

The name of the thing group.

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
index_name

The dynamic thing group index name.

VARCHAR
query_string

The dynamic thing group search query string.

VARCHAR
query_version

The dynamic thing group query version.

VARCHAR
status

The dynamic thing group status.

VARCHAR
thing_group_arn

The thing group ARN.

VARCHAR
thing_group_id

The thing group ID.

VARCHAR
thing_group_metadata

Thing group metadata.

STRUCT(
    "parent_group_name" VARCHAR,
    "root_to_parent_thing_groups" STRUCT(
        "group_name" VARCHAR,
        "group_arn" VARCHAR
    )[],
    "creation_date" TIMESTAMP_S
)
Show child fields
thing_group_metadata.creation_date

The UNIX timestamp of when the thing group was created.

thing_group_metadata.parent_group_name

The parent thing group name.

thing_group_metadata.root_to_parent_thing_groups[]
Show child fields
thing_group_metadata.root_to_parent_thing_groups[].group_arn

The group ARN.

thing_group_metadata.root_to_parent_thing_groups[].group_name

The group name.

thing_group_properties

The thing group properties.

STRUCT(
    "thing_group_description" VARCHAR,
    "attribute_payload" STRUCT(
        "attributes" MAP(VARCHAR, VARCHAR),
        "merge" BOOLEAN
    )
)
Show child fields
thing_group_properties.attribute_payload

The thing group attributes in JSON format.

Show child fields
thing_group_properties.attribute_payload.attributes

A JSON string containing up to three key-value pair in JSON format. For example:

{\"attributes\":{\"string1\":\"string2\"}}

thing_group_properties.attribute_payload.merge

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

thing_group_properties.thing_group_description

The thing group description.

version

The version of the thing group.

BIGINT