awswrangler.opensearch.delete_index

awswrangler.opensearch.delete_index(client: opensearchpy.OpenSearch, index: str) → dict[str, Any]

Delete an index.

Parameters:

• client (OpenSearch) – instance of opensearchpy.OpenSearch to use.

• index (str) – Name of the index.

Return type:

dict[str, Any]

Returns:

OpenSearch rest api response

Examples

Deleting an index.

>>> import awswrangler as wr
>>> client = wr.opensearch.connect(host='DOMAIN-ENDPOINT')
>>> response = wr.opensearch.delete_index(
...     client=client,
...     index="sample-index1"
... )