Skip to content

delete_endpoint

delete_endpoint(
    name: EndpointName, *, config_overrides: Optional[EventBridgeClientConfig] = None
) -> DeleteEndpointResponse

Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

Parameters:

  • name (EndpointName) –

    The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..

Raises:

Source code in docs_src/capo_eventbridge/_services/event_bridge.py
def delete_endpoint(
    self,
    name: "capo_eventbridge.types.endpoint_name.EndpointName",
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
) -> "capo_eventbridge.types.delete_endpoint_response.DeleteEndpointResponse":
    """<p>Delete an existing global endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>

    Args:
        name: <p>The name of the endpoint you want to delete. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>..</p>

    Raises:
        capo_eventbridge.errors.concurrent_modification_exception.ConcurrentModificationException: <p>There is concurrent modification on a rule, target, archive, or replay.</p>
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eventbridge.types.delete_endpoint_request.DeleteEndpointRequest]",
    ) -> OperationResponse[
        "capo_eventbridge.types.delete_endpoint_response.DeleteEndpointResponse"
    ]:
        import capo_eventbridge._operations.aws_events.delete_endpoint

        output, http_response = (
            capo_eventbridge._operations.aws_events.delete_endpoint.delete_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteEndpoint")
    )
    input_: capo_eventbridge.types.delete_endpoint_request.DeleteEndpointRequest = {
        "name": name
    }

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