MQ / Client / list_brokers

list_brokers

MQ.Client.list_brokers(**kwargs)

Returns a list of all brokers.

See also: AWS API Documentation

Request Syntax

response = client.list_brokers(
    MaxResults=123,
    NextToken='string'
)

Parameters:

• MaxResults (integer) – 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.

• NextToken (string) – The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

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'
        },
    ],
    '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 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.

  • NextToken (string) –

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

Exceptions

• MQ.Client.exceptions.BadRequestException

• MQ.Client.exceptions.InternalServerErrorException

• MQ.Client.exceptions.ForbiddenException