Skip to content
AWS for Query.Farm

aws.iot.search_index

Example SQL Queries

SELECT * FROM
aws.iot.search_index
WHERE
"query_string" = 'VALUE';

Description

The query search index.

Requires permission to access the SearchIndex action.

Table Definition

Column NameColumn Data Type
query_string Required Input Column

The search query string. For more information about the search query syntax, see Query syntax.

VARCHAR
index_name Input Column

The search index name.

VARCHAR
max_results Input Column

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

BIGINT
next_token Input Column

The token used to get the next set of results, or null if there are no additional results.

VARCHAR
query_version Input Column

The query version.

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
thing_groups

The thing groups that match the search query.

STRUCT(
    "thing_group_name" VARCHAR,
    "thing_group_id" VARCHAR,
    "thing_group_description" VARCHAR,
    "attributes" MAP(VARCHAR, VARCHAR),
    "parent_group_names" VARCHAR[]
)[]
Show child fields
thing_groups[]
Show child fields
thing_groups[].attributes

The thing group attributes.

thing_groups[].parent_group_names[]
thing_groups[].thing_group_description

The thing group description.

thing_groups[].thing_group_id

The thing group ID.

thing_groups[].thing_group_name

The thing group name.

things

The things that match the search query.

STRUCT(
    "thing_name" VARCHAR,
    "thing_id" VARCHAR,
    "thing_type_name" VARCHAR,
    "thing_group_names" VARCHAR[],
    "attributes" MAP(VARCHAR, VARCHAR),
    "shadow" VARCHAR,
    "device_defender" VARCHAR,
    "connectivity" STRUCT(
        "connected" BOOLEAN,
        "timestamp" BIGINT,
        "disconnect_reason" VARCHAR
    )
)[]
Show child fields
things[]
Show child fields
things[].attributes

The attributes.

things[].connectivity

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

Show child fields
things[].connectivity.connected

True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.

things[].connectivity.disconnect_reason

The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the disconnectReason value might be missing.

things[].connectivity.timestamp

The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing.

things[].device_defender

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

things[].shadow

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

things[].thing_group_names[]
things[].thing_id

The thing ID.

things[].thing_name

The thing name.

things[].thing_type_name

The thing type name.