Brokers broker-id Promote - Amazon MQ

Brokers broker-id Promote

URI

/v1/brokers/broker-id/promote

HTTP methods

POST

Operation ID: Promote

Promotes a data replication replica broker to a primary.

Path parameters
NameTypeRequiredDescription
broker-idStringTrue

The unique ID that Amazon MQ generates for the broker.

Responses
Status codeResponse modelDescription
200 PromoteOutput

HTTP Status Code 200: OK.

400Error

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

403Error

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

404Error

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

500Error

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

OPTIONS

Path parameters
NameTypeRequiredDescription
broker-idStringTrue

The unique ID that Amazon MQ generates for the broker.

Responses
Status codeResponse modelDescription
200None

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.

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

PropertyTypeRequiredDescription
mode

PromoteMode

True

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

PromoteMode

The Promote mode requested.

  • SWITCHOVER

  • FAILOVER

PromoteOutput

Returns information about the updated broker.

PropertyTypeRequiredDescription
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