Skip to content

delete_db_cluster_endpoint async

delete_db_cluster_endpoint(
    *,
    config_overrides: Optional[AsyncNeptuneClientConfig] = None,
    db_cluster_endpoint_identifier: Optional[String] = None,
) -> DeleteDBClusterEndpointOutput

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

Parameters:

  • db_cluster_endpoint_identifier (Optional[String], default: None ) –

    The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

Raises:

Source code in docs_src/capo_neptune/_services/async_neptune.py
async def delete_db_cluster_endpoint(
    self,
    *,
    config_overrides: Optional[AsyncNeptuneClientConfig] = None,
    db_cluster_endpoint_identifier: Optional[
        "capo_neptune.types.string.String"
    ] = None,
) -> "capo_neptune.types.delete_db_cluster_endpoint_output.DeleteDBClusterEndpointOutput":
    """<p>Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.</p>

    Args:
        db_cluster_endpoint_identifier: <p>The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.</p>

    Raises:
        capo_neptune.errors.db_cluster_endpoint_not_found_fault.DBClusterEndpointNotFoundFault: <p>The specified custom endpoint doesn't exist.</p>
        capo_neptune.errors.invalid_db_cluster_endpoint_state_fault.InvalidDBClusterEndpointStateFault: <p>The requested operation cannot be performed on the endpoint while the endpoint is in this state.</p>
        capo_neptune.errors.invalid_db_cluster_state_fault.InvalidDBClusterStateFault: <p>The DB cluster is not in a valid state.</p>
        capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_neptune.types.delete_db_cluster_endpoint_message.DeleteDBClusterEndpointMessage]",
    ) -> AsyncOperationResponse[
        "capo_neptune.types.delete_db_cluster_endpoint_output.DeleteDBClusterEndpointOutput"
    ]:
        import capo_neptune._operations.amazon_rd_sv19.delete_db_cluster_endpoint

        (
            output,
            http_response,
        ) = await capo_neptune._operations.amazon_rd_sv19.delete_db_cluster_endpoint.async_delete_db_cluster_endpoint(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDBClusterEndpoint")
    )
    input_: capo_neptune.types.delete_db_cluster_endpoint_message.DeleteDBClusterEndpointMessage = {}
    if db_cluster_endpoint_identifier is not None:
        input_["db_cluster_endpoint_identifier"] = db_cluster_endpoint_identifier

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output