MQ / Client / promote

promote#

MQ.Client.promote(**kwargs)#

Promotes a data replication replica broker to the primary broker role.

See also: AWS API Documentation

Request Syntax

response = client.promote(
    BrokerId='string',
    Mode='SWITCHOVER'|'FAILOVER'
)
Parameters:

  • BrokerId (string) –

    [REQUIRED]

    The unique ID that Amazon MQ generates for the broker.

  • Mode (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'BrokerId': 'string'
}

Response Structure

  • (dict) –

    HTTP Status Code 200: OK.

    • BrokerId (string) –

      The unique ID that Amazon MQ generates for the broker.

Exceptions

  • MQ.Client.exceptions.NotFoundException

  • MQ.Client.exceptions.BadRequestException

  • MQ.Client.exceptions.InternalServerErrorException

  • MQ.Client.exceptions.ForbiddenException