Amazon MQ
REST API Reference

Broker Reboot

To apply a new configuration to a broker, you can reboot the broker. In addition, if your broker becomes unresponsive, you can reboot it to recover from a faulty state.

Note

You can reboot only a broker with the RUNNING status.

URI

/v1/brokers/broker-id/reboot

HTTP Methods

POST

Operation ID: RebootBroker

Reboots a broker. Note: This API is asynchronous.

Path Parameters

Name Type Required Description
broker-id String True

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Responses

Status Code Response Model Description
200 None

HTTP Status Code 200: OK.

400 Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403 Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404 Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500 Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Response Bodies

Example Error

{ "errorAttribute": "string", "message": "string" }

Properties

Error

Returns information about an error.

Property Type Required Description
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

RebootBroker