Brokers broker-id Promote

URI

/v1/brokers/broker-id/promote

Operation ID: Promote

Path parameters
Name	Type	Required	Description
`broker-id`	String	True	The unique ID that Amazon MQ generates for the broker.

Responses
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.

Path parameters
Name	Type	Required	Description
`broker-id`	String	True	The unique ID that Amazon MQ generates for the broker.

Responses
Status code	Response model	Description
`200`	None	200 response


{
  "mode": enum
}


{
  "brokerId": "string"
}


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

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.

Creates a Promote request with the properties specified.

Property	Type	Required	Description
`mode`	PromoteMode	True	The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

The Promote mode requested.

Returns information about the updated broker.

Property	Type	Required	Description
`brokerId`	string	False	The unique ID that Amazon MQ generates for the broker.