Skip to content

aws.iot.get_indexing_configuration

Example SQL Queries

SELECT * FROM
aws.iot.get_indexing_configuration;

Description

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

Table Definition

Column NameColumn Data Type
_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_group_indexing_configuration

The index configuration.

STRUCT(
"thing_group_indexing_mode" VARCHAR,
"managed_fields" STRUCT(
"name" VARCHAR,
"type" VARCHAR
)[],
"custom_fields" STRUCT(
"name" VARCHAR,
"type" VARCHAR
)[]
)
Show child fields
thing_group_indexing_configuration.custom_fields[]
Show child fields
thing_group_indexing_configuration.custom_fields[].name

The name of the field.

thing_group_indexing_configuration.custom_fields[].type

The data type of the field.

thing_group_indexing_configuration.managed_fields[]
Show child fields
thing_group_indexing_configuration.managed_fields[].name

The name of the field.

thing_group_indexing_configuration.managed_fields[].type

The data type of the field.

thing_group_indexing_configuration.thing_group_indexing_mode

Thing group indexing mode.

thing_indexing_configuration

Thing indexing configuration.

STRUCT(
"thing_indexing_mode" VARCHAR,
"thing_connectivity_indexing_mode" VARCHAR,
"device_defender_indexing_mode" VARCHAR,
"named_shadow_indexing_mode" VARCHAR,
"managed_fields" STRUCT(
"name" VARCHAR,
"type" VARCHAR
)[],
"custom_fields" STRUCT(
"name" VARCHAR,
"type" VARCHAR
)[],
"filter" STRUCT(
"named_shadow_names" VARCHAR[],
"geo_locations" STRUCT(
"name" VARCHAR,
"order" VARCHAR
)[]
)
)
Show child fields
thing_indexing_configuration.custom_fields[]
Show child fields
thing_indexing_configuration.custom_fields[].name

The name of the field.

thing_indexing_configuration.custom_fields[].type

The data type of the field.

thing_indexing_configuration.device_defender_indexing_mode

Device Defender indexing mode. Valid values are:

  • VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

  • OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

thing_indexing_configuration.filter

Provides additional selections for named shadows and geolocation data.

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in namedShadowNames filter.

To add geolocation data to your fleet indexing configuration:

  • If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter.

  • If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON, add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing.

Show child fields
thing_indexing_configuration.filter.geo_locations[]
Show child fields
thing_indexing_configuration.filter.geo_locations[].name

The name of the geolocation target field. If the target field is part of a named shadow, you must select the named shadow using the namedShadow filter.

thing_indexing_configuration.filter.geo_locations[].order

The order of the geolocation target field. This field is optional. The default value is LatLon.

thing_indexing_configuration.filter.named_shadow_names[]
thing_indexing_configuration.managed_fields[]
Show child fields
thing_indexing_configuration.managed_fields[].name

The name of the field.

thing_indexing_configuration.managed_fields[].type

The data type of the field.

thing_indexing_configuration.named_shadow_indexing_mode

Named shadow indexing mode. Valid values are:

  • ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

  • OFF - Named shadow indexing is disabled.

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

thing_indexing_configuration.thing_connectivity_indexing_mode

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

thing_indexing_configuration.thing_indexing_mode

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.