:doc:`OpenSearchService <../../opensearch>` / Client / get_index

*********
get_index
*********



.. py:method:: OpenSearchService.Client.get_index(**kwargs)

  

  Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetIndex>`_  


  **Request Syntax**
  ::

    response = client.get_index(
        DomainName='string',
        IndexName='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

    

  
  :type IndexName: string
  :param IndexName: **[REQUIRED]** 

    The name of the index to retrieve information about.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'IndexSchema': {...}|[...]|123|123.4|'string'|True|None
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **IndexSchema** (:ref:`document<document>`) -- 

        The JSON schema of the index including mappings, settings, and semantic enrichment configuration.

        
  
  **Exceptions**
  
  *   :py:class:`OpenSearchService.Client.exceptions.ValidationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.AccessDeniedException`

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

  
  *   :py:class:`OpenSearchService.Client.exceptions.InternalException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.DisabledOperationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.DependencyFailureException`

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

  