Skip to content

delete_api_destination async

delete_api_destination(
    name: ApiDestinationName,
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
) -> DeleteApiDestinationResponse

Deletes the specified API destination.

Parameters:

Raises:

Source code in docs_src/capo_eventbridge/_services/async_event_bridge.py
async def delete_api_destination(
    self,
    name: "capo_eventbridge.types.api_destination_name.ApiDestinationName",
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
) -> "capo_eventbridge.types.delete_api_destination_response.DeleteApiDestinationResponse":
    """<p>Deletes the specified API destination.</p>

    Args:
        name: <p>The name of the destination to delete.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_eventbridge.types.delete_api_destination_request.DeleteApiDestinationRequest]",
    ) -> AsyncOperationResponse[
        "capo_eventbridge.types.delete_api_destination_response.DeleteApiDestinationResponse"
    ]:
        import capo_eventbridge._operations.aws_events.delete_api_destination

        (
            output,
            http_response,
        ) = await capo_eventbridge._operations.aws_events.delete_api_destination.async_delete_api_destination(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApiDestination")
    )
    input_: capo_eventbridge.types.delete_api_destination_request.DeleteApiDestinationRequest = {
        "name": name
    }

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