DescribeIndexCommand

Suggest an Edit

Describes a search index.

Requires permission to access the DescribeIndex  action.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTClient, DescribeIndexCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DescribeIndexCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // DescribeIndexRequest
  indexName: "STRING_VALUE", // required
};
const command = new DescribeIndexCommand(input);
const response = await client.send(command);
// { // DescribeIndexResponse
//   indexName: "STRING_VALUE",
//   indexStatus: "ACTIVE" || "BUILDING" || "REBUILDING",
//   schema: "STRING_VALUE",
// };

DescribeIndexCommand Input

See DescribeIndexCommandInput for more details

Parameter
Type
Description
indexName
Required
string | undefined

The index name.

DescribeIndexCommand Output

See DescribeIndexCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
indexName
string | undefined

The index name.

indexStatus
IndexStatus | undefined

The index status.

schema
string | undefined

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 .

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource does not exist.

ServiceUnavailableException
server

The service is temporarily unavailable.

ThrottlingException
client

The rate exceeds the limit.

UnauthorizedException
client

You are not authorized to perform this operation.

IoTServiceException
Base exception class for all service exceptions from IoT service.