pydo.databases.delete_opensearch_index()
Generated on 25 November 2024
from pydo version v0.6.0
Description
To delete a single index within OpenSearch cluster, send a DELETE request
to /v2/databases/$DATABASE_ID/indexes/$INDEX_NAME.
A status of 204 will be given. This indicates that the request was
processed successfully, but that no response body is needed.
Parameters
| Name |
Type |
Required |
Description |
Default Value |
database_cluster_uuid |
string |
True |
A unique identifier for a database cluster. |
|
index_name |
string |
True |
The name of the OpenSearch index. |
|
Responses
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.
The action was successful and the response body is empty.
Unauthorized
Click to expand an example response.
{
"id": "unauthorized",
"message": "Unable to authenticate you."
}
The resource was not found.
Click to expand an example response.
{
"id": "not_found",
"message": "The resource you requested could not be found."
}
API Rate limit exceeded
Click to expand an example response.
{
"id": "too_many_requests",
"message": "API Rate limit exceeded."
}
Server error.
Click to expand an example response.
{
"id": "server_error",
"message": "Unexpected server-side error"
}
Unexpected error
Click to expand an example response.
{
"id": "example_error",
"message": "some error message"
}