Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Describes a search index.

Requires permission to access the DescribeIndex action.

get/indices/{indexName}

Path parameters

indexNamestring required

The index name.

Response

Success

indexNamestring

The index name.

indexStatus'ACTIVE' | 'BUILDING' | 'REBUILDING'

The index status.

schemastring
<p>Contains a value that specifies the type of indexing performed. Valid values are:</p> <ul> <li> <p>REGISTRY – Your thing index contains only registry data.</p> </li> <li> <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p> </li> <li> <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p> </li> <li> <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p> </li> <li> <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p> </li> </ul>