:doc:`IoT <../../iot>` / Client / describe_index

**************
describe_index
**************



.. py:method:: IoT.Client.describe_index(**kwargs)

  

  Describes a search index.

   

  Requires permission to access the `DescribeIndex <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/DescribeIndex>`_  


  **Request Syntax**
  ::

    response = client.describe_index(
        indexName='string'
    )
    
  :type indexName: string
  :param indexName: **[REQUIRED]** 

    The index name.

    

  
  
  :rtype: 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 <https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html>`__.
        

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`IoT.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  