Menu
AWS IoT
Developer Guide

DescribeIndex

Describes a search index.

Request syntax:

GET /indices/indexName

URI Request Parameters:

Name

Type

Req?

Description

indexName

IndexName

yes

The index name.

Response syntax:

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

Response Body Parameters:

Name

Type

Req?

Description

indexName

IndexName

no

The index name.

indexStatus

IndexStatus

no

The index status.

schema

IndexSchema

no

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.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

CLI

Synopsis:

aws iot describe-index \ --index-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "indexName": "string" }

cli-input-json fields:

Name

Type

Description

indexName

string

length max:128 min:1

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

The index name.

Output:

{ "indexName": "string", "indexStatus": "string", "schema": "string" }

cli output fields:

Name

Type

Description

indexName

string

length max:128 min:1

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

The index name.

indexStatus

string

enum: ACTIVE | BUILDING | REBUILDING

java class: com.amazonaws.iot.indexing.IndexStatus

The index status.

schema

string

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.

On this page: