describe_index

describe_index(**kwargs)

Describes a search index.

Requires permission to access the DescribeIndex action.

See also: AWS API Documentation

Request Syntax

response = client.describe_index(
    indexName='string'
)

Parameters

indexName (string) --

[REQUIRED]

The index name.

Return type

dict

Returns

Response Syntax

{
    'indexName': 'string',
    'indexStatus': 'ACTIVE'|'BUILDING'|'REBUILDING',
    'schema': 'string'
}

Response Structure

• (dict) --
  • 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.
    • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Exceptions

• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException
• IoT.Client.exceptions.ServiceUnavailableException
• IoT.Client.exceptions.InternalFailureException
• IoT.Client.exceptions.ResourceNotFoundException