Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

describe-index

Description

Describes a search index.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--index-name (string)

The index name.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve the current status of the thing index

The following describe-index example retrieves the current status of the thing index.

aws iot describe-index \
    --index-name "AWS_Things"

Output:

{
    "indexName": "AWS_Things",
    "indexStatus": "ACTIVE",
    "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS"
}

For more information, see Managing Thing Indexing in the AWS IoT Developer Guide.

Output

indexName -> (string)

The index name.

indexStatus -> (string)

The index status.

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.