Amazon MQ
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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

GET

Operation ID: DescribeBroker

Returns information about the specified broker.

Path Parameters

Name Type Required Description
broker-id String True

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 white spaces, brackets, wildcard characters, or special characters.

Responses

Status Code Response Model Description
200 DescribeBrokerOutput

HTTP Status Code 200: OK.

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.

PUT

Operation ID: UpdateBroker

Adds a pending configuration change to a broker.

Path Parameters

Name Type Required Description
broker-id String True

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 white spaces, brackets, wildcard characters, or special characters.

Responses

Status Code Response Model Description
200 UpdateBrokerOutput

HTTP Status Code 200: OK.

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.

409 Error

HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.

500 Error

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

DELETE

Operation ID: DeleteBroker

Deletes a broker. Note: This API is asynchronous.

Path Parameters

Name Type Required Description
broker-id String True

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 white spaces, brackets, wildcard characters, or special characters.

Responses

Status Code Response Model Description
200 DeleteBrokerOutput

HTTP Status Code 200: OK.

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 Bodies

Example PUT

{ "engineVersion": "string", "configuration": { "id": "string", "revision": integer }, "securityGroups": [ "string" ], "logs": { "general": boolean, "audit": boolean }, "hostInstanceType": "string", "autoMinorVersionUpgrade": boolean }

Response Bodies

Example DescribeBrokerOutput

{ "pendingHostInstanceType": "string", "engineVersion": "string", "brokerArn": "string", "pendingEngineVersion": "string", "brokerId": "string", "deploymentMode": enum, "maintenanceWindowStartTime": { "dayOfWeek": enum, "timeZone": "string", "timeOfDay": "string" }, "pendingSecurityGroups": [ "string" ], "created": "string", "configurations": { "current": { "id": "string", "revision": integer }, "pending": { "id": "string", "revision": integer }, "history": [ { "id": "string", "revision": integer } ] }, "brokerState": enum, "engineType": enum, "brokerInstances": [ { "endpoints": [ "string" ], "consoleURL": "string", "ipAddress": "string" } ], "hostInstanceType": "string", "users": [ { "pendingChange": enum, "username": "string" } ], "tags": { }, "encryptionOptions": { "useAwsOwnedKey": boolean, "kmsKeyId": "string" }, "publiclyAccessible": boolean, "securityGroups": [ "string" ], "brokerName": "string", "logs": { "generalLogGroup": "string", "general": boolean, "audit": boolean, "pending": { "general": boolean, "audit": boolean }, "auditLogGroup": "string" }, "autoMinorVersionUpgrade": boolean, "subnetIds": [ "string" ] }

Example UpdateBrokerOutput

{ "engineVersion": "string", "brokerId": "string", "configuration": { "id": "string", "revision": integer }, "securityGroups": [ "string" ], "logs": { "general": boolean, "audit": boolean }, "hostInstanceType": "string", "autoMinorVersionUpgrade": boolean }

Example DeleteBrokerOutput

{ "brokerId": "string" }

Example Error

{ "errorAttribute": "string", "message": "string" }

Properties

BrokerInstance

Returns information about all brokers.

Property Type Required Description
endpoints

Array of type string

False

The broker's wire-level protocol endpoints.

consoleURL

string

False

The URL of the broker's ActiveMQ Web Console.

ipAddress

string

False

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

BrokerState

The status of the broker.

  • CREATION_IN_PROGRESS

  • CREATION_FAILED

  • DELETION_IN_PROGRESS

  • RUNNING

  • REBOOT_IN_PROGRESS

ChangeType

The type of change pending for the ActiveMQ user.

  • CREATE

  • UPDATE

  • DELETE

ConfigurationId

A list of information about the configuration.

Property Type Required Description
id

string

False

Required. The unique ID that Amazon MQ generates for the configuration.

revision

integer

False

The revision number of the configuration.

Configurations

Broker configuration information

Property Type Required Description
current

ConfigurationId

False

The current configuration of the broker.

pending

ConfigurationId

False

The pending configuration of the broker.

history

Array of type ConfigurationId

False

The history of configurations applied to the broker.

DeleteBrokerOutput

Returns information about the deleted broker.

Property Type Required Description
brokerId

string

False

The unique ID that Amazon MQ generates for the broker.

DeploymentMode

The deployment mode of the broker.

  • SINGLE_INSTANCE

  • ACTIVE_STANDBY_MULTI_AZ

DescribeBrokerOutput

Returns information about the specified broker.

Property Type Required Description
pendingHostInstanceType

string

False

The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types

engineVersion

string

False

The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

brokerArn

string

False

The Amazon Resource Name (ARN) of the broker.

pendingEngineVersion

string

False

The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

brokerId

string

False

The unique ID that Amazon MQ generates for the broker.

deploymentMode

DeploymentMode

False

Required. The deployment mode of the broker.

maintenanceWindowStartTime

WeeklyStartTime

False

The parameters that determine the WeeklyStartTime.

pendingSecurityGroups

Array of type string

False

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

created

string

Format: date-time

False

The time when the broker was created.

configurations

Configurations

False

The list of all revisions for the specified configuration.

brokerState

BrokerState

False

The status of the broker.

engineType

EngineType

False

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

brokerInstances

Array of type BrokerInstance

False

A list of information about allocated brokers.

hostInstanceType

string

False

The broker's instance type.

users

Array of type UserSummary

False

The list of all ActiveMQ usernames for the specified broker.

tags

object

False

The list of all tags associated with this broker.

encryptionOptions

EncryptionOptions

False

Encryption options for the broker.

publiclyAccessible

boolean

False

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

securityGroups

Array of type string

False

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

brokerName

string

False

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 white spaces, brackets, wildcard characters, or special characters.

logs

LogsSummary

False

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

autoMinorVersionUpgrade

boolean

False

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.

subnetIds

Array of type string

False

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.

EncryptionOptions

Encryption options for the broker.

Property Type Required Description
useAwsOwnedKey

boolean

True

Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).

kmsKeyId

string

False

The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

EngineType

The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.

  • ACTIVEMQ

Error

Returns information about an error.

Property Type Required Description
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

Logs

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

Property Type Required Description
general

boolean

False

Enables general logging.

audit

boolean

False

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

LogsSummary

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

Property Type Required Description
generalLogGroup

string

False

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

general

boolean

False

Enables general logging.

audit

boolean

False

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

pending

PendingLogs

False

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

auditLogGroup

string

False

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

PendingLogs

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

Property Type Required Description
general

boolean

False

Enables general logging.

audit

boolean

False

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

UpdateBrokerInput

Updates the broker using the specified properties.

Property Type Required Description
engineVersion

string

False

The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

configuration

ConfigurationId

False

A list of information about the configuration.

securityGroups

Array of type string

False

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

logs

Logs

False

Enables Amazon CloudWatch logging for brokers.

hostInstanceType

string

False

The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker.html#broker-instance-types.

autoMinorVersionUpgrade

boolean

False

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.

UpdateBrokerOutput

Returns information about the updated broker.

Property Type Required Description
engineVersion

string

False

The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

brokerId

string

False

Required. The unique ID that Amazon MQ generates for the broker.

configuration

ConfigurationId

False

The ID of the updated configuration.

securityGroups

Array of type string

False

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

logs

Logs

False

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

hostInstanceType

string

False

The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types.

autoMinorVersionUpgrade

boolean

False

The new value of automatic upgrades to new minor version for brokers.

UserSummary

Returns a list of all ActiveMQ users.

Property Type Required Description
pendingChange

ChangeType

False

The type of change pending for the ActiveMQ user.

username

string

False

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.

WeeklyStartTime

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Property Type Required Description
dayOfWeek

string

Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY

False

Required. The day of the week.

timeZone

string

False

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

timeOfDay

string

False

Required. The time, in 24-hour format.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeBroker

UpdateBroker

DeleteBroker