:doc:`MQ <../../mq>` / Client / promote

*******
promote
*******



.. py:method:: MQ.Client.promote(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Promote>`_  


  **Request Syntax**
  ::

    response = client.promote(
        BrokerId='string',
        Mode='SWITCHOVER'|'FAILOVER'
    )
    
  :type BrokerId: string
  :param BrokerId: **[REQUIRED]** 

    The unique ID that Amazon MQ generates for the broker.

    

  
  :type Mode: string
  :param Mode: **[REQUIRED]** 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`MQ.Client.exceptions.NotFoundException`

  
  *   :py:class:`MQ.Client.exceptions.BadRequestException`

  
  *   :py:class:`MQ.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`MQ.Client.exceptions.ForbiddenException`

  