indexes

Creates, updates, deletes, gets or lists an indexes resource.

Overview

Name	indexes
Type	Resource
Id	aws.iot.indexes

Fields

The following fields are returned by SELECT queries:

describe_index

Name	Datatype	Description
index_name	string	The index name. (pattern: <code>[a-zA-Z0-9:_-]+</code>)
index_status	string	The index status. (ACTIVE, BUILDING, REBUILDING)
schema	string	Contains a value that specifies the type of indexing performed. Valid values are: REGISTRY – Your thing index contains only registry data. REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data. REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data. REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data. MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

search_index

Name	Datatype	Description
next_token	string	The token used to get the next set of results, or null if there are no additional results.
thing_groups	array	The thing groups that match the search query.
things	array	The things that match the search query.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_index	select	index_name, region		Describes a search index. Requires permission to access the DescribeIndex action.
search_index	select	region		Searches the specified index. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet indexing's thingConnectivityIndexingMode was enabled, the connectivity object for this device in the response will have the connected field set to false with no additional session details. Requires permission to access the SearchIndex action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
index_name	string	The index name.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_index

Describes a search index. Requires permission to access the DescribeIndex action.

SELECT
index_name,
index_status,
schema
FROM aws.iot.indexes
WHERE index_name = '{{ index_name }}' -- required
AND region = '{{ region }}' -- required
;

search_index

Searches the specified index. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet indexing's thingConnectivityIndexingMode was enabled, the connectivity object for this device in the response will have the connected field set to false with no additional session details. Requires permission to access the SearchIndex action.

SELECT
next_token,
thing_groups,
things
FROM aws.iot.indexes
WHERE region = '{{ region }}' -- required
;