MQ / Paginator / ListBrokers


class MQ.Paginator.ListBrokers#
paginator = client.get_paginator('list_brokers')

Creates an iterator that will paginate through responses from MQ.Client.list_brokers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'BrokerSummaries': [
            'BrokerArn': 'string',
            'BrokerId': 'string',
            'BrokerName': 'string',
            'Created': datetime(2015, 1, 1),
            'EngineType': 'ACTIVEMQ'|'RABBITMQ',
            'HostInstanceType': '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.