Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1422100118.2 KB

Returns information about the specified broker.

get/v1/brokers/{broker-id}

Path parameters

broker-idstring required

The unique ID that Amazon MQ generates for the broker.

Response

Success

AuthenticationStrategy'SIMPLE' | 'LDAP'

The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgradeboolean

Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

BrokerArnstring

The broker's Amazon Resource Name (ARN).

BrokerIdstring

The unique ID that Amazon MQ generates for the broker.

BrokerNamestring

The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.

BrokerState'CREATION_IN_PROGRESS' | 'CREATION_FAILED' | 'DELETION_IN_PROGRESS' | 'RUNNING' | 'REBOOT_IN_PROGRESS' | 'CRITICAL_ACTION_REQUIRED'

The broker's status.

Createdstring date-time

The time when the broker was created.

DeploymentMode'SINGLE_INSTANCE' | 'ACTIVE_STANDBY_MULTI_AZ' | 'CLUSTER_MULTI_AZ'

The broker's deployment mode.

EngineType'ACTIVEMQ' | 'RABBITMQ'

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

EngineVersionstring

The broker engine's version. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.

HostInstanceTypestring

The broker's instance type.

PendingAuthenticationStrategy'SIMPLE' | 'LDAP'

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

PendingEngineVersionstring

The broker engine version to upgrade to. For a list of supported engine versions, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html">Supported engines</a>.

PendingHostInstanceTypestring

The broker's host instance type to upgrade to. For a list of supported instance types, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types">Broker instance types</a>.

PendingSecurityGroupsString[]

The list of pending security groups to authorize connections to brokers.

PubliclyAccessibleboolean

Enables connections from applications outside of the VPC that hosts the broker's subnets.

SecurityGroupsString[]

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

StorageType'EBS' | 'EFS'

The broker's storage type.

SubnetIdsString[]

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Tagsobject

The list of all tags associated with this broker.