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

************
delete_index
************



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

  

  Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.

  

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


  **Request Syntax**
  ::

    response = client.delete_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 delete.

    

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

    
    ::

      {
          'Status': 'CREATED'|'UPDATED'|'DELETED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Status** *(string) --* 

        The status of the index deletion operation.

        
  
  **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`

  