How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon MQ Brokers API

The Brokers API from Amazon MQ — 5 operation(s) for brokers.

Amazon MQ Brokers API is one of 5 APIs that Amazon MQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Brokers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 11 operations across 5 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 2017-11-27.

Requests are made against 4 base URLs: http://mq.{region}.amazonaws.com, https://mq.{region}.amazonaws.com, http://mq.{region}.amazonaws.com.cn, https://mq.{region}.amazonaws.com.cn.

11 operations 5 paths 50 schemas 2 DELETE4 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2017-11-27
Base URL
http://mq.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon MQ Brokers API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Brokers 11
POST
/v1/brokers
Amazon MQ Create Broker
CreateBroker 7 params body → 200480481482483484
GET
/v1/brokers
Amazon MQ List Brokers
ListBrokers 11 params → 200480481482
POST
/v1/brokers/{broker-id}/users/{username}
Amazon MQ Create User
CreateUser 9 params body → 200480481482483484
DELETE
/v1/brokers/{broker-id}/users/{username}
Amazon MQ Delete User
DeleteUser 9 params → 200480481482483
GET
/v1/brokers/{broker-id}/users/{username}
Amazon MQ Describe User
DescribeUser 9 params → 200480481482483
PUT
/v1/brokers/{broker-id}/users/{username}
Amazon MQ Update User
UpdateUser 9 params body → 200480481482483484
DELETE
/v1/brokers/{broker-id}
Amazon MQ Delete Broker
DeleteBroker 8 params → 200480481482483
GET
/v1/brokers/{broker-id}
Amazon MQ Describe Broker
DescribeBroker 8 params → 200480481482483
PUT
/v1/brokers/{broker-id}
Amazon MQ Update Broker
UpdateBroker 8 params body → 200480481482483484
GET
/v1/brokers/{broker-id}/users
Amazon MQ List Users
ListUsers 10 params → 200480481482483
POST
/v1/brokers/{broker-id}/reboot
Amazon MQ Reboot Broker
RebootBroker 8 params → 200480481482483

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are DescribeBrokerResponse (29 properties), UpdateBrokerResponse (10 properties), LdapServerMetadataOutput (10 properties), BrokerSummary (8 properties). Each schema is shown below with its type and property counts.

ConflictException
__mapOf__string
object
__integer
integer
ListUsersResponse
object
4 properties
EngineType
string
The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
UserPendingChanges
object
Returns information about the status of the changes pending for the ActiveMQ user.
3 properties 1 required
__timestampIso8601
string
__boolean
boolean
ChangeType
string
The type of change pending for the ActiveMQ user.
PendingLogs
object
The list of information about logs to be enabled for the specified broker.
2 properties
InternalServerErrorException
__listOfUserSummary
array
WeeklyStartTime
object
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
3 properties 2 required
DescribeBrokerResponse
object
29 properties
DeleteUserResponse
object
DeleteBrokerResponse
object
1 property
UpdateUserResponse
object
LdapServerMetadataOutput
object
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
10 properties 6 required
Logs
object
The list of information about logs to be enabled for the specified broker.
2 properties
__listOfBrokerSummary
array
DescribeUserResponse
object
5 properties
RebootBrokerResponse
object
LogsSummary
object
The list of information about logs currently enabled and pending to be deployed for the specified broker.
5 properties 2 required
EncryptionOptions
object
Does not apply to RabbitMQ brokers. Encryption options for the broker.
2 properties 1 required
Configurations
object
Broker configuration information
3 properties
DeploymentMode
string
The broker's deployment mode.
__listOfConfigurationId
array
UnauthorizedException
DayOfWeek
string
ForbiddenException
NotFoundException
BrokerState
string
The broker's status.
AuthenticationStrategy
string
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
BadRequestException
UserSummary
object
Returns a list of all broker users. Does not apply to RabbitMQ brokers.
2 properties 1 required
CreateBrokerResponse
object
2 properties
__integerMin5Max100
integer
User
object
A user associated with the broker. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All s…
4 properties 2 required
ListBrokersResponse
object
2 properties
__listOf__string
array
ConfigurationId
object
A list of information about the configuration. Does not apply to RabbitMQ brokers.
2 properties 1 required
__listOfBrokerInstance
array
__listOfActionRequired
array
BrokerStorageType
string
The broker's storage type. EFS is not supported for RabbitMQ engine type.
CreateUserResponse
object
BrokerSummary
object
Returns information about all brokers.
8 properties 2 required
ActionRequired
object
The action required to resolve a broker issue when the broker is in a CRITICALACTIONREQUIRED state.
2 properties
UpdateBrokerResponse
object
10 properties
BrokerInstance
object
Returns information about all brokers.
3 properties
__string
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-mq-brokers-api-openapi.yml Raw ↑

Other APIs Amazon MQ publishes across the network.

Amazon MQ Broker Engine Types API
Amazon MQ Broker Instance Options API
Amazon MQ Configurations API
Amazon MQ Tags API
Where this information came from

This is an independent, third-party profile of Amazon MQ Brokers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.