Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . mq ]

list-brokers

Description

Returns a list of all brokers.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-brokers
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--max-results (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.

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

BrokerSummaries -> (list)

A list of information about all brokers.

(structure)

The Amazon Resource Name (ARN) of the broker.

BrokerArn -> (string)

The Amazon Resource Name (ARN) of the broker.

BrokerId -> (string)

The unique ID that Amazon MQ generates for the broker.

BrokerName -> (string)

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

BrokerState -> (string)

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

DeploymentMode -> (string)

Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

HostInstanceType -> (string)

The broker's instance type. Possible values: mq.t2.micro, mq.m4.large

NextToken -> (string)

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