Amazon MQ
REST API Reference

Broker

A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. For more information, see Broker in the Amazon MQ Developer Guide.

URI

/v1/brokers/broker-id

HTTP Methods

DELETE

Deletes a broker.

Note

This API is asynchronous.

Path

Name Type Description

broker-id

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.

Response

Status Code Schema Description

200

DeleteBrokerOutput

HTTP Status Code 200: OK.

GET

Returns information about the specified broker.

Path

Name Type Description

broker-id

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.

Response

Status Code Schema Description

200

DescribeBrokerOutput

HTTP Status Code 200: OK.

PUT

Adds a pending configuration change to a broker.

Body

Name Type Description

UpdateBrokerInput

UpdateBrokerInput

Updates the broker using the specified properties.

Path

Name Type Description

broker-id

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.

Response

Status Code Schema Description

200

UpdateBrokerOutput

HTTP Status Code 200: OK.

Errors

Errors

Status Code Schema Description

400

Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403

Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404

Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500

Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Request Schemas

Example UpdateBrokerInput

{ "logs": { "general": true, "audit": false }, "configuration": { "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "revision": 3 } }

Response Schemas

Example DescribeBrokerOutput

{ "brokerArn": "arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "brokerId" : "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "brokerName": "MyBroker", "brokerState": "CREATION_IN_PROGRESS", "engineType": "ActiveMQ", "engineVersion": "5.15.0", "hostInstanceType": "mq.m5.large", "publiclyAccessible": true, "autoMinorVersionUpgrade": false, "deploymentMode": "ACTIVE_STANDBY_MULTI_AZ", "subnetIds": [ "subnet-12a3b45c", "subnet-67d8e90f" ], "securityGroups": [ "sg-a1b234cd", "sg-e5f678gh" ], "brokerInstances": [{ "consoleURL": "https://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:8162", "endpoints": [ "ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61617", "amqp+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:5671", "stomp+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61614", "mqtt+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:8883", "wss://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-1.mq.us-east-2.amazonaws.com:61619" ] }, { "consoleURL": "https://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.mq.us-east-2.amazonaws.com:8162", "endpoints": [ "ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.mq.us-east-2.amazonaws.com:61617", "amqp+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.mq.us-east-2.amazonaws.com:5671", "stomp+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.mq.us-east-2.amazonaws.com:61614", "mqtt+ssl://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.mq.us-east-2.amazonaws.com:8883", "wss://b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2.mq.us-east-2.amazonaws.com:61619" ] }], "maintenanceWindowStartTime": { "timeOfDay": "13:00", "dayOfWeek": "SUNDAY", "timeZone": "UTC" }, "logs": { "general": true, "generalLogGroup": "/aws/amazonmq/broker/b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2/general", "audit": true, "auditLogGroup": "/aws/amazonmq/broker/b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9-2/audit", "pending": { "general": true, "audit": false } }, "configurations": { "pending": { "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "revision": 3 }, "history": [{ "id": "c-l987k6j5-48ih-321g-0fed-9c87b6a545l2", "revision": 2 }, { "id": "c-9876a5b4-32cd-101e-2fgh-3i45j6k178l9", "revision": 1 }] }, "users": [{ "username": "jane.doe" }, { "username": "paolo.santos" }], "created": "2017-11-28T01:23:45.678Z" }

Example UpdateBrokerOutput

{ "brokerId" : "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "logs": { "general": true, "audit": false }, "configuration": { "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "revision": 3 } }

Example DeleteBrokerOutput

{ "brokerId" : "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9" }

Example Error

{ "errorAttribute": "TheAttributeWhichCausedTheError", "message": "This is the description of the error and the steps to resolve the issue." }

Attributes

UpdateBrokerInput

Attribute Type Description

configuration

ConfigurationId

A list of information about the configuration.

logs

Logs

Enables Amazon CloudWatch logging for brokers.

ConfigurationId

Attribute Type Description

id

string

Required

The unique ID that Amazon MQ generates for the configuration.

revision

integer

The revision number of the configuration.

Logs

Attribute Type Description

audit

Boolean

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

general

Boolean

Enables general logging.

DescribeBrokerOutput

Attribute Type Description

autoMinorVersionUpgrade

Boolean

Required

Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

brokerArn

string

The Amazon Resource Name (ARN) of the broker.

brokerId

string

The unique ID that Amazon MQ generates for the broker.

brokerInstances

array

A list of information about allocated brokers.

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

enum

The status of the broker.

Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGESS, RUNNING, REBOOT_IN_PROGRESS

configurations

Configurations

The list of all revisions for the specified configuration.

created

string (date-time)

The time when the broker was created.

deploymentMode

enum

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.

engineType

enum

Required

The type of broker engine.

Note

Currently, Amazon MQ supports only ACTIVEMQ.

engineVersion

enum

The version of the broker engine.

Note

Currently, Amazon MQ supports only 5.15.0.

hostInstanceType

enum

The broker's instance type.

Possible values: mq.t2.micro, mq.m5.large, mq.m5.xlarge, mq.m5.2xlarge, mq.m5.4xlarge, mq.m4.large

logs

LogsSummary

The list of information about logs currently enabled and pending to be deployed for the specified broker.

maintenanceWindowStartTime

WeeklyStartTime

The parameters that determine the WeeklyStartTime.

publiclyAccessible

Boolean

Required

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

securityGroups

array

Required

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

subnetIds

array

The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

users

array

The list of all ActiveMQ usernames for the specified broker.

BrokerInstance

Attribute Type Description

consoleURL

string

The URL of the broker's ActiveMQ Web Console.

endpoints

array

The broker's wire-level protocol endpoints.

ipAddress

string

The IP address of the Elastic Network Interface (ENI) attached to the broker.

Configurations

Attribute Type Description

current

ConfigurationId

The current configuration of the broker.

history

array

The history of configurations applied to the broker.

pending

ConfigurationId

The pending configuration of the broker.

LogsSummary

Attribute Type Description

audit

Boolean

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

auditLogGroup

string

The location of the CloudWatch Logs log group where audit logs are sent.

general

Boolean

Enables general logging.

generalLogGroup

string

The location of the CloudWatch Logs log group where general logs are sent.

pending

PendingLogs

The list of information about logs pending to be deployed for the specified broker.

PendingLogs

Attribute Type Description

audit

Boolean

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

general

Boolean

Enables general logging.

WeeklyStartTime

Attribute Type Description

dayOfWeek

string

Required

The day of the week.

timeOfDay

string

Required

The time, in 24-hour format.

timeZone

string

The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

UserSummary

Attribute Type Description

pendingChange

enum

The type of change pending for the ActiveMQ user.

Possible values: CREATE, UPDATE, DELETE

username

string

Required

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

UpdateBrokerOutput

Attribute Type Description

brokerId

string

Required

The unique ID that Amazon MQ generates for the broker.

configuration

ConfigurationId

The ID of the updated configuration.

logs

Logs

The list of information about logs to be enabled for the specified broker.

DeleteBrokerOutput

Attribute Type Description

brokerId

string

The unique ID that Amazon MQ generates for the broker.

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.