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.
| Name | Type | Required | Description |
|---|---|---|---|
broker-id | String | True | The unique ID that Amazon MQ generates for the broker. |
| 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. |
OPTIONS
| Name | Type | Required | Description |
|---|---|---|---|
broker-id | String | True | The unique ID that Amazon MQ generates for the broker. |
| Status code | Response model | Description |
|---|---|---|
200 | None | Default response for CORS method |
Schemas
Response bodies
{ "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
