Skip to content

delete_global_cluster

delete_global_cluster(
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    global_cluster_identifier: Optional[GlobalClusterIdentifier] = None,
) -> DeleteGlobalClusterResult

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

This action only applies to Amazon DocumentDB clusters.

Parameters:

Raises:

Source code in docs_src/capo_docdb/_services/doc_db.py
def delete_global_cluster(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    global_cluster_identifier: Optional[
        "capo_docdb.types.global_cluster_identifier.GlobalClusterIdentifier"
    ] = None,
) -> "capo_docdb.types.delete_global_cluster_result.DeleteGlobalClusterResult":
    """<p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p> <note> <p>This action only applies to Amazon DocumentDB clusters.</p> </note>

    Args:
        global_cluster_identifier: <p>The cluster identifier of the global cluster being deleted.</p>

    Raises:
        capo_docdb.errors.global_cluster_not_found_fault.GlobalClusterNotFoundFault: <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global cluster.</p>
        capo_docdb.errors.invalid_global_cluster_state_fault.InvalidGlobalClusterStateFault: <p>The requested operation can't be performed while the cluster is in this state.</p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.delete_global_cluster_message.DeleteGlobalClusterMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.delete_global_cluster_result.DeleteGlobalClusterResult"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.delete_global_cluster

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.delete_global_cluster.delete_global_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGlobalCluster")
    )
    input_: capo_docdb.types.delete_global_cluster_message.DeleteGlobalClusterMessage = {}
    if global_cluster_identifier is not None:
        input_["global_cluster_identifier"] = global_cluster_identifier

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