delete_index ¶

delete_index(
    domain_name: DomainName,
    index_name: IndexName,
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
) -> DeleteIndexResponse

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

Parameters:

index_name (IndexName) –

The name of the index to delete.

Raises:

AccessDeniedException –

An error occurred because you don't have permissions to access the resource.
DependencyFailureException –

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
DisabledOperationException –

An error occured because the client wanted to access an unsupported operation.
InternalException –

Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException –

An exception for accessing or deleting a resource that doesn't exist.
ThrottlingException –

The request was denied due to request throttling. Reduce the frequency of your requests and try again.
ValidationException –

An exception for accessing or deleting a resource that doesn't exist.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_opensearch/_services/open_search.py

def delete_index(
    self,
    domain_name: "capo_opensearch.types.domain_name.DomainName",
    index_name: "capo_opensearch.types.index_name.IndexName",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
) -> "capo_opensearch.types.delete_index_response.DeleteIndexResponse":
    """<p>Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.</p>

    Args:
        index_name: <p>The name of the index to delete.</p>

    Raises:
        capo_opensearch.errors.access_denied_exception.AccessDeniedException: <p>An error occurred because you don't have permissions to access the resource.</p>
        capo_opensearch.errors.dependency_failure_exception.DependencyFailureException: <p>An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Reduce the frequency of your requests and try again.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_opensearch.types.delete_index_request.DeleteIndexRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.delete_index_response.DeleteIndexResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.delete_index

        output, http_response = (
            capo_opensearch._operations.amazon_open_search_service.delete_index.delete_index(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIndex")
    )
    input_: capo_opensearch.types.delete_index_request.DeleteIndexRequest = {
        "domain_name": domain_name,
        "index_name": index_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output