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

************
list_brokers
************



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

  

  Returns a list of all brokers.

  

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


  **Request Syntax**
  ::

    response = client.list_brokers(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

    

  
  :type NextToken: string
  :param NextToken: 

    The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'BrokerSummaries': [
              {
                  'BrokerArn': 'string',
                  'BrokerId': 'string',
                  'BrokerName': 'string',
                  'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS'|'CRITICAL_ACTION_REQUIRED'|'REPLICA',
                  'Created': datetime(2015, 1, 1),
                  'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ'|'CLUSTER_MULTI_AZ',
                  'EngineType': 'ACTIVEMQ'|'RABBITMQ',
                  'HostInstanceType': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      HTTP Status Code 200: OK.

      
      

      - **BrokerSummaries** *(list) --* 

        A list of information about all brokers.

        
        

        - *(dict) --* 

          Returns information about all brokers.

          
          

          - **BrokerArn** *(string) --* 

            The broker's Amazon Resource Name (ARN).

            
          

          - **BrokerId** *(string) --* 

            The unique ID that Amazon MQ generates for the broker.

            
          

          - **BrokerName** *(string) --* 

            The broker's name. This value is unique in your Amazon Web Services account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

            
          

          - **BrokerState** *(string) --* 

            The broker's status.

            
          

          - **Created** *(datetime) --* 

            The time when the broker was created.

            
          

          - **DeploymentMode** *(string) --* 

            The broker's deployment mode.

            
          

          - **EngineType** *(string) --* 

            The type of broker engine.

            
          

          - **HostInstanceType** *(string) --* 

            The broker's instance type.

            
      
    
      

      - **NextToken** *(string) --* 

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

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

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

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

  