OpenSearchService / Client / delete_index

delete_index

OpenSearchService.Client.delete_index(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_index(
    DomainName='string',
    IndexName='string'
)
Parameters:

  • DomainName (string) –

    [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.

  • IndexName (string) –

    [REQUIRED]

    The name of the index to delete.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'CREATED'|'UPDATED'|'DELETED'
}

Response Structure

  • (dict) –

    • Status (string) –

      The status of the index deletion operation.

Exceptions