Menu
AWS IoT
API Reference

DescribeIndex

Describes a search index.

Request Syntax

GET /indices/indexName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

indexName

The index name.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "indexName": "string", "indexStatus": "string", "schema": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

indexName

The index name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

indexStatus

The index status.

Type: String

Valid Values: ACTIVE | BUILDING | REBUILDING

schema

Contains a value that specifies the type of indexing performed. Valid values are:

  1. REGISTRY – Your thing index will contain only registry data.

  2. REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

Type: String

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: