delete_cluster ¶

delete_cluster(
    cluster_arn: str, *, config_overrides: Optional[DocDBElasticClientConfig] = None
) -> DeleteClusterOutput

Delete an elastic cluster.

Parameters:

cluster_arn (str) –

The ARN identifier of the elastic cluster that is to be deleted.

Raises:

AccessDeniedException –

An exception that occurs when there are not sufficient permissions to perform an action.
ConflictException –

There was an access conflict.
InternalServerException –

There was an internal server error.
ResourceNotFoundException –

The specified resource could not be located.
ThrottlingException –

ThrottlingException will be thrown when request was denied due to request throttling.
ValidationException –

A structure defining a validation exception.
UnknownServiceError –

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

Source code in docs_src/capo_docdb_elastic/_services/doc_db_elastic.py

def delete_cluster(
    self,
    cluster_arn: str,
    *,
    config_overrides: Optional[DocDBElasticClientConfig] = None,
) -> "capo_docdb_elastic.types.delete_cluster_output.DeleteClusterOutput":
    """<p>Delete an elastic cluster.</p>

    Args:
        cluster_arn: <p>The ARN identifier of the elastic cluster that is to be deleted.</p>

    Raises:
        capo_docdb_elastic.errors.access_denied_exception.AccessDeniedException: <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
        capo_docdb_elastic.errors.conflict_exception.ConflictException: <p>There was an access conflict.</p>
        capo_docdb_elastic.errors.internal_server_exception.InternalServerException: <p>There was an internal server error.</p>
        capo_docdb_elastic.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be located.</p>
        capo_docdb_elastic.errors.throttling_exception.ThrottlingException: <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
        capo_docdb_elastic.errors.validation_exception.ValidationException: <p>A structure defining a validation exception.</p>
        capo_docdb_elastic.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb_elastic.types.delete_cluster_input.DeleteClusterInput]",
    ) -> OperationResponse[
        "capo_docdb_elastic.types.delete_cluster_output.DeleteClusterOutput"
    ]:
        import capo_docdb_elastic._operations.chimera_db_lionfish_service_lambda.delete_cluster

        output, http_response = (
            capo_docdb_elastic._operations.chimera_db_lionfish_service_lambda.delete_cluster.delete_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCluster")
    )
    input_: capo_docdb_elastic.types.delete_cluster_input.DeleteClusterInput = {
        "cluster_arn": cluster_arn
    }

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