MQ / Paginator / ListBrokers

ListBrokers#

class MQ.Paginator.ListBrokers#

paginator = client.get_paginator('list_brokers')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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:

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',
            'Created': datetime(2015, 1, 1),
            'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ'|'CLUSTER_MULTI_AZ',
            '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 AWS 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.