Skip to content

delete_broker

delete_broker(
    broker_id: __string, *, config_overrides: Optional[mqClientConfig] = None
) -> DeleteBrokerResponse

Deletes a broker. Note: This API is asynchronous.

Parameters:

  • broker_id (__string) –

    The unique ID that Amazon MQ generates for the broker.

Raises:

Source code in docs_src/capo_mq/_services/mq.py
def delete_broker(
    self,
    broker_id: "capo_mq.types.__string.__string",
    *,
    config_overrides: Optional[mqClientConfig] = None,
) -> "capo_mq.types.delete_broker_response.DeleteBrokerResponse":
    """<p>Deletes a broker. Note: This API is asynchronous.</p>

    Args:
        broker_id: <p>The unique ID that Amazon MQ generates for the broker.</p>

    Raises:
        capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_mq.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_mq.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_mq.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_mq.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mq.types.delete_broker_request.DeleteBrokerRequest]",
    ) -> OperationResponse[
        "capo_mq.types.delete_broker_response.DeleteBrokerResponse"
    ]:
        import capo_mq._operations.mq.delete_broker

        output, http_response = capo_mq._operations.mq.delete_broker.delete_broker(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBroker")
    )
    input_: capo_mq.types.delete_broker_request.DeleteBrokerRequest = {
        "broker_id": broker_id
    }

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