URI
/v1/brokers/broker-id/promote
HTTP methods
POST
Operation ID: Promote
Promotes a data replication replica broker to a primary.
| Name | Type | Required | Description |
|---|---|---|---|
broker-id | String | True | The unique ID that Amazon MQ generates for the broker. |
| Status code | Response model | Description |
|---|---|---|
200 |
PromoteOutput | 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
Request bodies
{
"mode": enum
}Response bodies
{
"brokerId": "string"
}{
"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. |
PromoteInput
Creates a Promote request with the properties specified.
| Property | Type | Required | Description |
|---|---|---|---|
mode | True | The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER. |
PromoteMode
The Promote mode requested.
SWITCHOVERFAILOVER
PromoteOutput
Returns information about the updated broker.
| Property | Type | Required | Description |
|---|---|---|---|
brokerId | string | False | The unique ID that Amazon MQ generates for the broker. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
Promote
