amazon mq - rest api reference...amazon mq is a managed message broker service for apache activemq...

Amazon MQREST API Reference

Amazon MQ REST API Reference

Amazon MQ: REST API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Example REST Request ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Example REST Response .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Resources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Broker Engine Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Broker Instance Options .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Brokers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Broker .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Broker Reboot .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Users ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

User .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Configurations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Configuration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

iii


HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Configuration Revisions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Configuration Revision .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86URI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86HTTP Methods .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Schemas .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Properties ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Operations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

iv

Amazon MQ REST API ReferenceExample REST Request

WelcomeWelcome to the Amazon MQ REST API reference. In this guide, you can find descriptions of RESTresources, example requests, HTTP methods, schemas, parameters, and the errors that the servicereturns.

Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up andoperate message brokers in the cloud. Amazon MQ works with your existing applications and serviceswithout the need to manage, operate, or maintain your own messaging system.

You can access your brokers by using any programming language that ActiveMQ supports and byenabling TLS explicitly for the following protocols:

• AMQP• MQTT• MQTT over WebSocket• OpenWire• STOMP• STOMP over WebSocket

Topics• Example REST Request (p. 1)• Example REST Response (p. 1)

Additional Information

• Amazon MQ Product Page• Amazon MQ Developer Guide• Amazon MQ in the AWS CLI Command Reference• Regions and Endpoints

Last documentation update: December 11, 2018

Example REST RequestThe following is an example of an Amazon MQ REST request (and its headers) which creates a newbroker:

POST /v1/brokers HTTP/1.1Content-Type: application/jsonX-Amz-Date: 20171123T214525ZAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20171128/us-east-2/mq/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=a12bc34567defg89h0ij1234kl56m789no01p2q345r6s789tu01v2w3x4567890Host: mq.us-east-2.amazonaws.comCache-Control: no-cache

{ "brokerName": "MyBroker",

1

http://activemq.apache.org/

http://activemq.apache.org/cross-language-clients.html

http://activemq.apache.org/amqp.html

http://activemq.apache.org/mqtt.html

http://activemq.apache.org/websockets.html

http://activemq.apache.org/openwire.html

http://activemq.apache.org/stomp.html

http://aws.amazon.com/amazon-mq/

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/

https://docs.aws.amazon.com/cli/latest/reference/mq/index.html

https://docs.aws.amazon.com/general/latest/gr/rande.html#amazon-mq_region

Amazon MQ REST API ReferenceExample REST Response

"hostInstanceType": "mq.m5.large", "engineType": "ActiveMQ", "engineVersion": "5.15.8", "logs": { "general": true, "audit": false }, "deploymentMode": "ACTIVE_STANDBY_MULTI_AZ", "publiclyAccessible": true, "subnetIds": [ "subnet-12a3b45c", "subnet-67d8e90f" ], "securityGroups": [ "sg-a1b234cd", "sg-e5f678gh" ], "autoMinorVersionUpgrade": true, "users": [{ "password": "MyPassword456", "groups": [ "admins" ], "consoleAccess": true, "username": "jane.doe" }]}

Example REST ResponseThe following is an example of an Amazon MQ REST response (and its headers) which acknowledges thecreation of the new broker:

HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 250Connection: keep-aliveDate: Wed, 28 Nov 2017 12:00:00 GMTX-Amzn-RequestId: a12bc345-67de-89f0-g12h-345ij6k7l89mX-Amzn-Trace-Id: sampled=1;root=1-2345a67b-c8defg901hijk2lf3m4nopqrX-Cache: Miss from cloudfrontVia: 1.1 ab123456cd789ef012g34567890h1i23.cloudfront.net (CloudFront)X-Amz-Cf-Id: ABCa1D6b2-EcF3dG7e456_fGIgh7JKLMijNO_PQ8RSTUVWX-Y9k0ZA==

{ "brokerId" : "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "brokerArn": "arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9"}

2

Amazon MQ REST API ReferenceBroker Engine Types

ResourcesThe Amazon MQ REST API includes the following resources.

Topics

• Broker Engine Types (p. 3)

• Broker Instance Options (p. 7)

• Brokers (p. 11)

• Broker (p. 25)

• Broker Reboot (p. 47)

• Users (p. 50)

• User (p. 53)

• Configurations (p. 63)

• Configuration (p. 71)

• Configuration Revisions (p. 79)

• Configuration Revision (p. 83)

• Tag (p. 86)

Broker Engine TypesRetrieve information about available broker engines. AWS does not support all instance types in allavailability zones and regions. For more information, see Engine in the Amazon MQ Developer Guide.

This API will tell you, for a given region and availability zone, which broker engine types and engineversions you can create.

URI/v1/broker-engine-types

HTTP Methods

GETOperation ID: DescribeBrokerEngineTypes

Describe available engine types and versions.

Query Parameters

Name Type Required Description

engineType String False Filter response byengine type.

3

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

Amazon MQ REST API ReferenceSchemas


nextToken String False The token that specifiesthe next page of resultsAmazon MQ shouldreturn. To requestthe first page, leavenextToken empty.

maxResults String False The maximum numberof brokers that AmazonMQ can return perpage (20 by default).This value must be aninteger from 5 to 100.

Responses

Status Code Response Model Description

200 BrokerEngineTypeOutput (p. 4)HTTP Status Code 200: OK.

400 Error (p. 5) HTTP Status Code 400: Badrequest due to incorrect input.Correct your request and thenretry it.

403 Error (p. 5) HTTP Status Code 403: Accessforbidden. Correct yourcredentials and then retry yourrequest.

500 Error (p. 5) HTTP Status Code 500:Unexpected internal server error.Retrying your request mightresolve the issue.

Schemas

Response Bodies

Example BrokerEngineTypeOutput

{ "nextToken": "string", "maxResults": integer, "brokerEngineTypes": [ { "engineVersions": [ { "name": "string" } ], "engineType": enum } ]

4

Amazon MQ REST API ReferenceProperties

}

Example Error

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

PropertiesBrokerEngineTypeTypes of broker engines.

engineVersions

The list of engine versions.

Type: Array of type EngineVersion (p. 6)Required: False

engineType

The broker's engine type.

Type: EngineType (p. 6)Required: False

BrokerEngineTypeOutputReturns a list of broker engine type.

nextToken

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

Type: stringRequired: False

maxResults

Required. The maximum number of engine types that can be returned per page (20 by default). Thisvalue must be an integer from 5 to 100.

Type: integerRequired: FalseMinimum: 5Maximum: 100

brokerEngineTypes

List of available engine types and versions.

5

Amazon MQ REST API ReferenceSee Also

Type: Array of type BrokerEngineType (p. 5)Required: False

EngineTypeThe broker's engine type. Note: Currently, Amazon MQ supports only ActiveMQ.

ACTIVEMQ

EngineVersionId of the engine version.

name

Id for the version.


ErrorReturns information about an error.

errorAttribute

The attribute which caused the error.


message

The explanation of the error.


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

DescribeBrokerEngineTypes• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3

6

/goto/aws-cli/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/DotNetSDKV3/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/SdkForCpp/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/SdkForGoV1/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/SdkForJava/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/AWSJavaScriptSDK/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/SdkForPHPV3/mq-2017-11-27/DescribeBrokerEngineTypes

Amazon MQ REST API ReferenceBroker Instance Options

• AWS SDK for Python• AWS SDK for Ruby V3

Broker Instance OptionsYou can retrieve information about broker instances. For more information, see Broker in the AmazonMQ Developer Guide.

URI/v1/broker-instance-options

HTTP MethodsGETOperation ID: DescribeBrokerInstanceOptions

Describe available broker instance options.

Query Parameters


hostInstanceType String False Filter response by hostinstance type.


storageType String False Filter response bystorage type.


engineType String False Filter response byengine type.

Responses


200 BrokerInstanceOptionsOutput (p. 8)HTTP Status Code 200: OK.

400 Error (p. 8) HTTP Status Code 400: Badrequest due to incorrect input.

7

/goto/boto3/mq-2017-11-27/DescribeBrokerEngineTypes

/goto/SdkForRubyV3/mq-2017-11-27/DescribeBrokerEngineTypes

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker.html



Correct your request and thenretry it.



SchemasResponse Bodies

Example BrokerInstanceOptionsOutput

{ "nextToken": "string", "maxResults": integer, "brokerInstanceOptions": [ { "supportedDeploymentModes": [ enum ], "supportedEngineVersions": [ "string" ], "storageType": enum, "engineType": enum, "availabilityZones": [ { "name": "string" } ], "hostInstanceType": "string" } ]}

Example Error


PropertiesAvailabilityZoneName of the availability zone.

8


name

Id for the availability zone.


BrokerInstanceOption

Option for host instance type.

supportedDeploymentModes

The list of supported deployment modes.

Type: Array of type DeploymentMode (p. 10)Required: False

supportedEngineVersions

The list of supported engine versions.

Type: Array of type stringRequired: False

storageType

The broker's storage type.

Type: BrokerStorageType (p. 10)Required: False

engineType

The broker's engine type.


availabilityZones

The list of available az.

Type: Array of type AvailabilityZone (p. 8)Required: False

hostInstanceType

The broker's instance type.


9


BrokerInstanceOptionsOutputReturns a list of broker instance options.

nextToken



maxResults

Required. The maximum number of instance options that can be returned per page (20 by default). Thisvalue must be an integer from 5 to 100.

Type: integerRequired: FalseMinimum: 5Maximum: 100

brokerInstanceOptions

List of available broker instance options.

Type: Array of type BrokerInstanceOption (p. 9)Required: False

BrokerStorageTypeThe broker's storage type.

EBSEFS

DeploymentModeThe broker's deployment mode.

SINGLE_INSTANCEACTIVE_STANDBY_MULTI_AZ


ACTIVEMQ


10


errorAttribute



message




DescribeBrokerInstanceOptions• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

BrokersThis is a collection of brokers. A broker is a message broker environment running on Amazon MQ. It is thebasic building block of Amazon MQ. For more information, see Broker Instance Types in the Amazon MQDeveloper Guide.

URI/v1/brokers

HTTP Methods

GETOperation ID: ListBrokers

Returns a list of all brokers.

11

/goto/aws-cli/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/DotNetSDKV3/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/SdkForCpp/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/SdkForGoV1/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/SdkForJava/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/AWSJavaScriptSDK/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/SdkForPHPV3/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/boto3/mq-2017-11-27/DescribeBrokerInstanceOptions

/goto/SdkForRubyV3/mq-2017-11-27/DescribeBrokerInstanceOptions

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker.html#broker-instance-types

Amazon MQ REST API ReferenceHTTP Methods

Query Parameters




Responses


200 ListBrokersOutput (p. 14) HTTP Status Code 200: OK.




POSTOperation ID: CreateBroker

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the followingEC2 permissions in your IAM policy.

• ec2:CreateNetworkInterface

This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalfof your account.

• ec2:CreateNetworkInterfacePermission

This permission is required to attach the ENI to the broker instance.

• ec2:DeleteNetworkInterface

12


• ec2:DeleteNetworkInterfacePermission

• ec2:DetachNetworkInterface

• ec2:DescribeInternetGateways

• ec2:DescribeNetworkInterfaces

• ec2:DescribeNetworkInterfacePermissions

• ec2:DescribeRouteTables

• ec2:DescribeSecurityGroups

• ec2:DescribeSubnets

• ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Deletethe Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

Responses


200 CreateBrokerOutput (p. 15) HTTP Status Code 200: OK.


401 Error (p. 15) HTTP Status Code 401:Unauthorized request. Theprovided credentials couldn't bevalidated.


409 Error (p. 15) HTTP Status Code 409: Conflict.This broker name already exists.Retry your request with anothername.


Schemas

Request Bodies

Example POST

{ "engineVersion": "string", "deploymentMode": enum, "maintenanceWindowStartTime": {

13

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface



"dayOfWeek": enum, "timeZone": "string", "timeOfDay": "string" }, "configuration": { "id": "string", "revision": integer }, "authenticationStrategy": enum, "engineType": enum, "hostInstanceType": "string", "users": [ { "password": "string", "groups": [ "string" ], "consoleAccess": boolean, "username": "string" } ], "tags": { }, "creatorRequestId": "string", "publiclyAccessible": boolean, "encryptionOptions": { "useAwsOwnedKey": boolean, "kmsKeyId": "string" }, "storageType": enum, "securityGroups": [ "string" ], "brokerName": "string", "logs": { "general": boolean, "audit": boolean }, "ldapServerMetadata": { "roleSearchMatching": "string", "serviceAccountPassword": "string", "roleBase": "string", "hosts": [ "string" ], "roleName": "string", "userBase": "string", "roleSearchSubtree": boolean, "serviceAccountUsername": "string", "userRoleName": "string", "userSearchMatching": "string", "userSearchSubtree": boolean }, "autoMinorVersionUpgrade": boolean, "subnetIds": [ "string" ]}

Response BodiesExample ListBrokersOutput

{

14


"brokerSummaries": [ { "brokerArn": "string", "brokerId": "string", "deploymentMode": enum, "created": "string", "brokerState": enum, "brokerName": "string", "hostInstanceType": "string" } ], "nextToken": "string"}

Example CreateBrokerOutput

{ "brokerArn": "string", "brokerId": "string"}

Example Error


Properties

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

SIMPLELDAP

BrokerStateThe broker's status.

CREATION_IN_PROGRESSCREATION_FAILEDDELETION_IN_PROGRESSRUNNINGREBOOT_IN_PROGRESS


EBSEFS

15


BrokerSummary

Returns information about all brokers.

brokerArn

The broker's Amazon Resource Name (ARN).


brokerId

The unique ID that Amazon MQ generates for the broker.


deploymentMode

Required. The broker's deployment mode.

Type: DeploymentMode (p. 20)Required: False

created

The time when the broker was created.

Type: stringRequired: FalseFormat: date-time

brokerState

The broker's status.

Type: BrokerState (p. 15)Required: False

brokerName

The broker's name. This value must be unique in your AWS account, 1-50 characters long, must containonly letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcardcharacters, or special characters.


hostInstanceType


16



ConfigurationId

A list of information about the configuration.

id

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


revision

The revision number of the configuration.

Type: integerRequired: False

CreateBrokerInput

Creates a broker.

engineVersion

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


deploymentMode



maintenanceWindowStartTime

The parameters that determine the WeeklyStartTime.

Type: WeeklyStartTime (p. 24)Required: False

configuration


Type: ConfigurationId (p. 17)

17


Required: False

authenticationStrategy

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

Type: AuthenticationStrategy (p. 15)Required: False

engineType

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


hostInstanceType

Required. The broker's instance type.


users

Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. Thisvalue can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). Thisvalue must be 2-100 characters long.

Type: Array of type User (p. 23)Required: False

tags

Create tags when creating the broker.

Type: objectRequired: False

creatorRequestId

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the APIaction. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. Youmay omit the creatorRequestId if your application doesn't require idempotency.


publiclyAccessible

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

Type: boolean

18


Required: False

encryptionOptions

Encryption options for the broker.

Type: EncryptionOptions (p. 20)Required: False

storageType



securityGroups

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


brokerName

Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, mustcontain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets,wildcard characters, or special characters.


logs

Enables Amazon CloudWatch logging for brokers.

Type: Logs (p. 23)Required: False

ldapServerMetadata

Optional. The metadata of the LDAP server used to authenticate and authorize connections to thebroker.

Type: LdapServerMetadataInput (p. 21)Required: False

autoMinorVersionUpgrade

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

Type: boolean

19


Required: False

subnetIds

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


CreateBrokerOutputReturns information about the created broker.

brokerArn



brokerId



DeploymentModeThe broker's deployment mode.

SINGLE_INSTANCEACTIVE_STANDBY_MULTI_AZ

EncryptionOptionsEncryption options for the broker.

useAwsOwnedKey

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

Type: booleanRequired: True

kmsKeyId

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


20



ACTIVEMQ


errorAttribute



message



LdapServerMetadataInputOptional. The metadata of the LDAP server used to authenticate and authorize connections to thebroker.

roleSearchMatching

The LDAP search filter used to find roles within the roleBase. The distinguished name of the usermatched by userSearchMatching is substituted into the {0} placeholder in the search filter.The client's username is substituted into the {1} placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) afterstring substitution. It matches all role entries that have a member attribute equal to uid=janedoeunder the subtree selected by the roleBase.


serviceAccountPassword

Service account password. A service account is an account in your LDAP server that has access to initiatea connection. For example, cn=admin,dc=corp, dc=example, dc=com.


roleBase

The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.

Type: string

21


Required: False

hosts

Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory .Optional failover server.


roleName

Specifies the LDAP attribute that identifies the group name attribute in the object returned from thegroup membership query.


userBase

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtreeis specified by a DN, which specifies the base node of the subtree. For example, by setting this option toou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted tothe subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.


roleSearchSubtree

The directory search scope for the role. If set to true, scope is to search the entire subtree.

Type: booleanRequired: False

serviceAccountUsername

Service account username. A service account is an account in your LDAP server that has access to initiatea connection. For example, cn=admin,dc=corp, dc=example, dc=com.


userRoleName

Specifies the name of the LDAP attribute for the user group membership.


userSearchMatching

The LDAP search filter used to find users within the userBase. The client's username is substituted intothe {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received

22


username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will resultin matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.


userSearchSubtree

The directory search scope for the user. If set to true, scope is to search the entire subtree.


ListBrokersOutput

brokerSummaries

A list of information about all brokers.

Type: Array of type BrokerSummary (p. 16)Required: False

nextToken



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

general

Enables general logging.


audit

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


UserAn ActiveMQ user associated with the broker.

23


password

Required. The password of the ActiveMQ user. This value must be at least 12 characters long, mustcontain at least 4 unique characters, and must not contain commas.

Type: stringRequired: FalseFormat: password

groups

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain onlyalphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100characters long.


consoleAccess

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.


username

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.


WeeklyStartTimeThe scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates orpatches to the broker.

dayOfWeek

Required. The day of the week.

Type: stringRequired: FalseValues: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY

timeZone

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


timeOfDay

Required. The time, in 24-hour format.

24




ListBrokers• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

CreateBroker• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

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

URI/v1/brokers/broker-id

HTTP MethodsGETOperation ID: DescribeBroker

Returns information about the specified broker.

25

/goto/aws-cli/mq-2017-11-27/ListBrokers

/goto/DotNetSDKV3/mq-2017-11-27/ListBrokers

/goto/SdkForCpp/mq-2017-11-27/ListBrokers

/goto/SdkForGoV1/mq-2017-11-27/ListBrokers

/goto/SdkForJava/mq-2017-11-27/ListBrokers

/goto/AWSJavaScriptSDK/mq-2017-11-27/ListBrokers

/goto/SdkForPHPV3/mq-2017-11-27/ListBrokers

/goto/boto3/mq-2017-11-27/ListBrokers

/goto/SdkForRubyV3/mq-2017-11-27/ListBrokers

/goto/aws-cli/mq-2017-11-27/CreateBroker

/goto/DotNetSDKV3/mq-2017-11-27/CreateBroker

/goto/SdkForCpp/mq-2017-11-27/CreateBroker

/goto/SdkForGoV1/mq-2017-11-27/CreateBroker

/goto/SdkForJava/mq-2017-11-27/CreateBroker

/goto/AWSJavaScriptSDK/mq-2017-11-27/CreateBroker

/goto/SdkForPHPV3/mq-2017-11-27/CreateBroker

/goto/boto3/mq-2017-11-27/CreateBroker

/goto/SdkForRubyV3/mq-2017-11-27/CreateBroker

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker.html


Path Parameters


broker-id String True The broker's name. Thisvalue must be unique inyour AWS account, 1-50characters long, mustcontain only letters,numbers, dashes,and underscores, andmust not containwhite spaces, brackets,wildcard characters, orspecial characters.

Responses


200 DescribeBrokerOutput (p. 29)HTTP Status Code 200: OK.



404 Error (p. 31) HTTP Status Code 404: Resourcenot found due to incorrect input.Correct your request and thenretry it.


PUTOperation ID: UpdateBroker

Adds a pending configuration change to a broker.

Path Parameters


broker-id String True The broker's name. Thisvalue must be unique inyour AWS account, 1-50characters long, mustcontain only letters,

26



numbers, dashes,and underscores, andmust not containwhite spaces, brackets,wildcard characters, orspecial characters.

Responses


200 UpdateBrokerOutput (p. 30) HTTP Status Code 200: OK.






DELETEOperation ID: DeleteBroker

Deletes a broker. Note: This API is asynchronous.

Path Parameters


broker-id String True The broker's name. Thisvalue must be unique inyour AWS account, 1-50characters long, mustcontain only letters,numbers, dashes,and underscores, andmust not contain

27



white spaces, brackets,wildcard characters, orspecial characters.

Responses


200 DeleteBrokerOutput (p. 31) HTTP Status Code 200: OK.





SchemasRequest Bodies

Example PUT

{ "engineVersion": "string", "configuration": { "id": "string", "revision": integer }, "authenticationStrategy": enum, "securityGroups": [ "string" ], "ldapServerMetadata": { "roleSearchMatching": "string", "serviceAccountPassword": "string", "roleBase": "string", "hosts": [ "string" ], "roleName": "string", "userBase": "string", "roleSearchSubtree": boolean,

28


"serviceAccountUsername": "string", "userRoleName": "string", "userSearchMatching": "string", "userSearchSubtree": boolean }, "logs": { "general": boolean, "audit": boolean }, "hostInstanceType": "string", "autoMinorVersionUpgrade": boolean}

Response BodiesExample DescribeBrokerOutput

{ "pendingEngineVersion": "string", "pendingAuthenticationStrategy": enum, "pendingSecurityGroups": [ "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", "publiclyAccessible": boolean, "logs": { "generalLogGroup": "string", "general": boolean, "audit": boolean, "pending": { "general": boolean, "audit": boolean }, "auditLogGroup": "string" }, "ldapServerMetadata": { "roleSearchMatching": "string",

29


"roleBase": "string", "hosts": [ "string" ], "roleName": "string", "userBase": "string", "roleSearchSubtree": boolean, "serviceAccountUsername": "string", "userRoleName": "string", "userSearchMatching": "string", "userSearchSubtree": boolean }, "subnetIds": [ "string" ], "engineVersion": "string", "pendingHostInstanceType": "string", "brokerArn": "string", "brokerId": "string", "deploymentMode": enum, "maintenanceWindowStartTime": { "dayOfWeek": enum, "timeZone": "string", "timeOfDay": "string" }, "created": "string", "authenticationStrategy": enum, "users": [ { "pendingChange": enum, "username": "string" } ], "tags": { }, "pendingLdapServerMetadata": { "roleSearchMatching": "string", "roleBase": "string", "hosts": [ "string" ], "roleName": "string", "userBase": "string", "roleSearchSubtree": boolean, "serviceAccountUsername": "string", "userRoleName": "string", "userSearchMatching": "string", "userSearchSubtree": boolean }, "encryptionOptions": { "useAwsOwnedKey": boolean, "kmsKeyId": "string" }, "storageType": enum, "securityGroups": [ "string" ], "brokerName": "string", "autoMinorVersionUpgrade": boolean}

Example UpdateBrokerOutput

{

30


"engineVersion": "string", "brokerId": "string", "configuration": { "id": "string", "revision": integer }, "authenticationStrategy": enum, "securityGroups": [ "string" ], "ldapServerMetadata": { "roleSearchMatching": "string", "roleBase": "string", "hosts": [ "string" ], "roleName": "string", "userBase": "string", "roleSearchSubtree": boolean, "serviceAccountUsername": "string", "userRoleName": "string", "userSearchMatching": "string", "userSearchSubtree": boolean }, "logs": { "general": boolean, "audit": boolean }, "hostInstanceType": "string", "autoMinorVersionUpgrade": boolean}

Example DeleteBrokerOutput

{ "brokerId": "string"}

Example Error


Properties


SIMPLELDAP

BrokerInstanceReturns information about all brokers.

31


endpoints

The broker's wire-level protocol endpoints.


consoleURL

The URL of the broker's ActiveMQ Web Console.


ipAddress

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


BrokerStateThe broker's status.

CREATION_IN_PROGRESSCREATION_FAILEDDELETION_IN_PROGRESSRUNNINGREBOOT_IN_PROGRESS


EBSEFS

ChangeTypeThe type of change pending for the ActiveMQ user.

CREATEUPDATEDELETE

ConfigurationIdA list of information about the configuration.

id


32



revision

The revision number of the configuration.


Configurations

Broker configuration information

current

The broker's current configuration.

Type: ConfigurationId (p. 32)Required: False

pending

The broker's pending configuration.


history

The history of configurations applied to the broker.

Type: Array of type ConfigurationId (p. 32)Required: False

DeleteBrokerOutput

Returns information about the deleted broker.

brokerId



DeploymentMode

The broker's deployment mode.

SINGLE_INSTANCE

33


ACTIVE_STANDBY_MULTI_AZ

DescribeBrokerOutputReturns information about the specified broker.

pendingEngineVersion

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


pendingAuthenticationStrategy

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


pendingSecurityGroups

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


configurations

The list of all revisions for the specified configuration.

Type: Configurations (p. 33)Required: False

brokerState

The broker's status.

Type: BrokerState (p. 32)Required: False

engineType



brokerInstances

A list of information about allocated brokers.

34


Type: Array of type BrokerInstance (p. 31)Required: False

hostInstanceType



publiclyAccessible

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


logs

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

Type: LogsSummary (p. 42)Required: False

ldapServerMetadata


Type: LdapServerMetadataOutput (p. 40)Required: False

subnetIds

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


engineVersion

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


pendingHostInstanceType

The broker's host instance type 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

35



brokerArn



brokerId



deploymentMode



maintenanceWindowStartTime

The parameters that determine the WeeklyStartTime.

Type: WeeklyStartTime (p. 46)Required: False

created

The time when the broker was created.





users

The list of all ActiveMQ usernames for the specified broker.

Type: Array of type UserSummary (p. 46)Required: False

36


tags

The list of all tags associated with this broker.


pendingLdapServerMetadata

The metadata of the LDAP server that will be used to authenticate and authorize connections to thebroker after it is rebooted.


encryptionOptions

Encryption options for the broker.

Type: EncryptionOptions (p. 38)Required: False

storageType



securityGroups

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


brokerName

The broker's name. This value must be unique in your AWS account, 1-50 characters long, must containonly letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcardcharacters, or special characters.



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


37


EncryptionOptionsEncryption options for the broker.

useAwsOwnedKey

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

Type: booleanRequired: True

kmsKeyId

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



ACTIVEMQ


errorAttribute



message



LdapServerMetadataInputOptional. The metadata of the LDAP server used to authenticate and authorize connections to thebroker.

roleSearchMatching

The LDAP search filter used to find roles within the roleBase. The distinguished name of the usermatched by userSearchMatching is substituted into the {0} placeholder in the search filter.The client's username is substituted into the {1} placeholder. For example, if you set this option to

38


(member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) afterstring substitution. It matches all role entries that have a member attribute equal to uid=janedoeunder the subtree selected by the roleBase.


serviceAccountPassword

Service account password. A service account is an account in your LDAP server that has access to initiatea connection. For example, cn=admin,dc=corp, dc=example, dc=com.


roleBase



hosts



roleName



userBase



roleSearchSubtree



39





userRoleName



userSearchMatching

The LDAP search filter used to find users within the userBase. The client's username is substituted intothe {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the receivedusername is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will resultin matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.


userSearchSubtree



LdapServerMetadataOutputOptional. The metadata of the LDAP server used to authenticate and authorize connections to thebroker.

roleSearchMatching

The LDAP search filter used to find roles within the roleBase. The distinguished name of the usermatched by userSearchMatching is substituted into the {0} placeholder in the search filter.The client's username is substituted into the {1} placeholder. For example, if you set this option to(member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) afterstring substitution. It matches all role entries that have a member attribute equal to uid=janedoeunder the subtree selected by the roleBase.


roleBase


Type: string

40


Required: False

hosts



roleName



userBase



roleSearchSubtree






userRoleName



userSearchMatching

The LDAP search filter used to find users within the userBase. The client's username is substituted intothe {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received

41


username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will resultin matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.


userSearchSubtree



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

general



audit



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

generalLogGroup

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


general



audit


42



pending

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

Type: PendingLogs (p. 43)Required: False

auditLogGroup

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


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

general



audit



UpdateBrokerInputUpdates the broker using the specified properties.

engineVersion

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


configuration



43





securityGroups

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


ldapServerMetadata


Type: LdapServerMetadataInput (p. 38)Required: False

logs

Enables Amazon CloudWatch logging for brokers.


hostInstanceType

The broker's host instance type 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.



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


UpdateBrokerOutputReturns information about the updated broker.

engineVersion

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

44



brokerId

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


configuration

The ID of the updated configuration.





securityGroups

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


ldapServerMetadata



logs

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


hostInstanceType

The broker's host instance type 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.


45



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


UserSummary

Returns a list of all ActiveMQ users.

pendingChange

The type of change pending for the ActiveMQ user.

Type: ChangeType (p. 32)Required: False

username



WeeklyStartTime

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

dayOfWeek

Required. The day of the week.

Type: stringRequired: FalseValues: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY

timeZone

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


timeOfDay

Required. The time, in 24-hour format.


46



DescribeBroker• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

UpdateBroker• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

DeleteBroker• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

Broker RebootTo apply a new configuration to a broker, you can reboot the broker. In addition, if your broker becomesunresponsive, you can reboot it to recover from a faulty state.

47

/goto/aws-cli/mq-2017-11-27/DescribeBroker

/goto/DotNetSDKV3/mq-2017-11-27/DescribeBroker

/goto/SdkForCpp/mq-2017-11-27/DescribeBroker

/goto/SdkForGoV1/mq-2017-11-27/DescribeBroker

/goto/SdkForJava/mq-2017-11-27/DescribeBroker

/goto/AWSJavaScriptSDK/mq-2017-11-27/DescribeBroker

/goto/SdkForPHPV3/mq-2017-11-27/DescribeBroker

/goto/boto3/mq-2017-11-27/DescribeBroker

/goto/SdkForRubyV3/mq-2017-11-27/DescribeBroker

/goto/aws-cli/mq-2017-11-27/UpdateBroker

/goto/DotNetSDKV3/mq-2017-11-27/UpdateBroker

/goto/SdkForCpp/mq-2017-11-27/UpdateBroker

/goto/SdkForGoV1/mq-2017-11-27/UpdateBroker

/goto/SdkForJava/mq-2017-11-27/UpdateBroker

/goto/AWSJavaScriptSDK/mq-2017-11-27/UpdateBroker

/goto/SdkForPHPV3/mq-2017-11-27/UpdateBroker

/goto/boto3/mq-2017-11-27/UpdateBroker

/goto/SdkForRubyV3/mq-2017-11-27/UpdateBroker

/goto/aws-cli/mq-2017-11-27/DeleteBroker

/goto/DotNetSDKV3/mq-2017-11-27/DeleteBroker

/goto/SdkForCpp/mq-2017-11-27/DeleteBroker

/goto/SdkForGoV1/mq-2017-11-27/DeleteBroker

/goto/SdkForJava/mq-2017-11-27/DeleteBroker

/goto/AWSJavaScriptSDK/mq-2017-11-27/DeleteBroker

/goto/SdkForPHPV3/mq-2017-11-27/DeleteBroker

/goto/boto3/mq-2017-11-27/DeleteBroker

/goto/SdkForRubyV3/mq-2017-11-27/DeleteBroker

Amazon MQ REST API ReferenceURI

NoteYou can reboot only a broker with the RUNNING status.

URI/v1/brokers/broker-id/reboot

HTTP Methods

POSTOperation ID: RebootBroker

Reboots a broker. Note: This API is asynchronous.

Path Parameters



Responses


200 None HTTP Status Code 200: OK.





48


Schemas

Response Bodies

Example Error


Properties

Error

Returns information about an error.

errorAttribute



message




RebootBroker• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






49

/goto/aws-cli/mq-2017-11-27/RebootBroker

/goto/DotNetSDKV3/mq-2017-11-27/RebootBroker

/goto/SdkForCpp/mq-2017-11-27/RebootBroker

/goto/SdkForGoV1/mq-2017-11-27/RebootBroker

/goto/SdkForJava/mq-2017-11-27/RebootBroker

/goto/AWSJavaScriptSDK/mq-2017-11-27/RebootBroker

/goto/SdkForPHPV3/mq-2017-11-27/RebootBroker

/goto/boto3/mq-2017-11-27/RebootBroker

/goto/SdkForRubyV3/mq-2017-11-27/RebootBroker

Amazon MQ REST API ReferenceUsers

UsersThis is a collection of ActiveMQ users for the specified broker. An ActiveMQ user is a person or anapplication that can access the queues and topics of an ActiveMQ broker. For more information, see Userin the Amazon MQ Developer Guide.

You can configure to have specific permissions. For example, you can allow some users to access theActiveMQ Web Console.

A user can belong to a group. You can configure which users belong to which groups and which groupshave permission to send to, receive from, and administer specific queues and topics.

ImportantMaking changes to a user does not apply the changes to the user immediately. To apply yourchanges, you must wait for the next maintenance window or reboot the broker.

URI/v1/brokers/broker-id/users

HTTP MethodsGETOperation ID: ListUsers

Returns a list of all ActiveMQ users.

Path Parameters



Query Parameters



maxResults String False The maximum numberof brokers that Amazon

50

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/user.html

http://activemq.apache.org/web-console.html



MQ can return perpage (20 by default).This value must be aninteger from 5 to 100.

Responses


200 ListUsersOutput (p. 51) HTTP Status Code 200: OK.






Example ListUsersOutput

{ "brokerId": "string", "nextToken": "string", "maxResults": integer, "users": [ { "pendingChange": enum, "username": "string" } ]}

Example Error

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

51


}

PropertiesChangeTypeThe type of change pending for the ActiveMQ user.

CREATEUPDATEDELETE


errorAttribute



message



ListUsersOutputReturns a list of all ActiveMQ users.

brokerId



nextToken



maxResults

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). Thisvalue must be an integer from 5 to 100.

Type: integer

52


Required: FalseMinimum: 5Maximum: 100

users

Required. The list of all ActiveMQ usernames for the specified broker.

Type: Array of type UserSummary (p. 53)Required: False

UserSummaryReturns a list of all ActiveMQ users.

pendingChange

The type of change pending for the ActiveMQ user.


username




ListUsers• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

UserAn ActiveMQ user is a person or an application that can access the queues and topics of an ActiveMQbroker. For more information, see User in the Amazon MQ Developer Guide.

53

/goto/aws-cli/mq-2017-11-27/ListUsers

/goto/DotNetSDKV3/mq-2017-11-27/ListUsers

/goto/SdkForCpp/mq-2017-11-27/ListUsers

/goto/SdkForGoV1/mq-2017-11-27/ListUsers

/goto/SdkForJava/mq-2017-11-27/ListUsers

/goto/AWSJavaScriptSDK/mq-2017-11-27/ListUsers

/goto/SdkForPHPV3/mq-2017-11-27/ListUsers

/goto/boto3/mq-2017-11-27/ListUsers

/goto/SdkForRubyV3/mq-2017-11-27/ListUsers

https://docs-aws.amazon.com/amazon-mq/latest/developer-guide/user.html


A user can belong to a group. You can configure which users belong to which groups and which groupshave permission to send to, receive from, and administer specific queues and topics.

ImportantMaking changes to a user does not apply the changes to the user immediately. To apply yourchanges, you must wait for the next maintenance window or reboot the broker.

URI/v1/brokers/broker-id/users/username

HTTP Methods

GETOperation ID: DescribeUser

Returns information about an ActiveMQ user.

Path Parameters


username String True The username of theActiveMQ user. Thisvalue can containonly alphanumericcharacters, dashes,periods, underscores,and tildes (- . _ ~). Thisvalue must be 2-100characters long.


Responses


200 DescribeUserOutput (p. 59) HTTP Status Code 200: OK.


54






POSTOperation ID: CreateUser

Creates an ActiveMQ user.

Path Parameters




Responses



400 Error (p. 59) HTTP Status Code 400: Badrequest due to incorrect input.

55



Correct your request and thenretry it.





PUT

Operation ID: UpdateUser

Updates the information for an ActiveMQ user.

Path Parameters




56


Responses








DELETEOperation ID: DeleteUser

Deletes an ActiveMQ user.

Path Parameters



broker-id String True The broker's name. Thisvalue must be unique inyour AWS account, 1-50characters long, mustcontain only letters,numbers, dashes,and underscores, and

57



must not containwhite spaces, brackets,wildcard characters, orspecial characters.

Responses







SchemasRequest BodiesExample POST

{ "password": "string", "groups": [ "string" ], "consoleAccess": boolean}

Example PUT

{ "password": "string", "groups": [ "string" ], "consoleAccess": boolean}

58


Response Bodies

Example DescribeUserOutput

{ "brokerId": "string", "pending": { "pendingChange": enum, "groups": [ "string" ], "consoleAccess": boolean }, "groups": [ "string" ], "consoleAccess": boolean, "username": "string"}

Example Error


PropertiesChangeTypeThe type of change pending for the ActiveMQ user.

CREATEUPDATEDELETE

CreateUserInputCreates a new ActiveMQ user.

password

Required. The password of the user. This value must be at least 12 characters long, must contain at least4 unique characters, and must not contain commas.


groups


59



consoleAccess

Enables access to the ActiveMQ Web Console for the ActiveMQ user.


DescribeUserOutput

Returns information about an ActiveMQ user.

brokerId



pending

The status of the changes pending for the ActiveMQ user.

Type: UserPendingChanges (p. 61)Required: False

groups



consoleAccess



username



60



errorAttribute



message



UpdateUserInputUpdates the information for an ActiveMQ user.

password

The password of the user. This value must be at least 12 characters long, must contain at least 4 uniquecharacters, and must not contain commas.


groups



consoleAccess



UserPendingChangesReturns information about the status of the changes pending for the ActiveMQ user.

pendingChange

Required. The type of change pending for the ActiveMQ user.

61



groups



consoleAccess




DescribeUser• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






CreateUser• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






62

/goto/aws-cli/mq-2017-11-27/DescribeUser

/goto/DotNetSDKV3/mq-2017-11-27/DescribeUser

/goto/SdkForCpp/mq-2017-11-27/DescribeUser

/goto/SdkForGoV1/mq-2017-11-27/DescribeUser

/goto/SdkForJava/mq-2017-11-27/DescribeUser

/goto/AWSJavaScriptSDK/mq-2017-11-27/DescribeUser

/goto/SdkForPHPV3/mq-2017-11-27/DescribeUser

/goto/boto3/mq-2017-11-27/DescribeUser

/goto/SdkForRubyV3/mq-2017-11-27/DescribeUser

/goto/aws-cli/mq-2017-11-27/CreateUser

/goto/DotNetSDKV3/mq-2017-11-27/CreateUser

/goto/SdkForCpp/mq-2017-11-27/CreateUser

/goto/SdkForGoV1/mq-2017-11-27/CreateUser

/goto/SdkForJava/mq-2017-11-27/CreateUser

/goto/AWSJavaScriptSDK/mq-2017-11-27/CreateUser

/goto/SdkForPHPV3/mq-2017-11-27/CreateUser

/goto/boto3/mq-2017-11-27/CreateUser

/goto/SdkForRubyV3/mq-2017-11-27/CreateUser

Amazon MQ REST API ReferenceConfigurations

UpdateUser• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

DeleteUser• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

ConfigurationsThis is a collection of configurations. A configuration contains all of the settings for your ActiveMQbroker, in XML format. For more information, see Configuration and Amazon MQ Broker ConfigurationParameters in the Amazon MQ Developer Guide.

You can create a configuration before creating any brokers. You can then apply the configuration to oneor more brokers.

ImportantMaking changes to a configuration does not apply the changes to the broker immediately. Toapply your changes, you must wait for the next maintenance window or reboot the broker.

URI/v1/configurations

HTTP Methods

GETOperation ID: ListConfigurations

Returns a list of all configurations.

63

/goto/aws-cli/mq-2017-11-27/UpdateUser

/goto/DotNetSDKV3/mq-2017-11-27/UpdateUser

/goto/SdkForCpp/mq-2017-11-27/UpdateUser

/goto/SdkForGoV1/mq-2017-11-27/UpdateUser

/goto/SdkForJava/mq-2017-11-27/UpdateUser

/goto/AWSJavaScriptSDK/mq-2017-11-27/UpdateUser

/goto/SdkForPHPV3/mq-2017-11-27/UpdateUser

/goto/boto3/mq-2017-11-27/UpdateUser

/goto/SdkForRubyV3/mq-2017-11-27/UpdateUser

/goto/aws-cli/mq-2017-11-27/DeleteUser

/goto/DotNetSDKV3/mq-2017-11-27/DeleteUser

/goto/SdkForCpp/mq-2017-11-27/DeleteUser

/goto/SdkForGoV1/mq-2017-11-27/DeleteUser

/goto/SdkForJava/mq-2017-11-27/DeleteUser

/goto/AWSJavaScriptSDK/mq-2017-11-27/DeleteUser

/goto/SdkForPHPV3/mq-2017-11-27/DeleteUser

/goto/boto3/mq-2017-11-27/DeleteUser

/goto/SdkForRubyV3/mq-2017-11-27/DeleteUser

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/configuration.html

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html



Query Parameters




Responses


200 ListConfigurationsOutput (p. 65)HTTP Status Code 200: OK.




POST

Operation ID: CreateConfiguration

Creates a new configuration for the specified configuration name. Amazon MQ uses the defaultconfiguration (the engine type and version).

Responses


200 CreateConfigurationOutput (p. 66)HTTP Status Code 200: OK.


64






Schemas

Request Bodies

Example POST

{ "engineVersion": "string", "authenticationStrategy": enum, "name": "string", "engineType": enum, "tags": { }}

Response Bodies

Example ListConfigurationsOutput

{ "nextToken": "string", "maxResults": integer, "configurations": [ { "engineVersion": "string", "created": "string", "authenticationStrategy": enum, "name": "string", "description": "string", "engineType": enum, "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer }, "tags": { } }

65


]}

Example CreateConfigurationOutput

{ "created": "string", "authenticationStrategy": enum, "name": "string", "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer }}

Example Error


Properties

AuthenticationStrategy


SIMPLELDAP

Configuration

Returns information about all configurations.

engineVersion



created

Required. The date and time of the configuration revision.


66



Optional. The authentication strategy associated with the configuration. The default is SIMPLE.


name

Required. The name of the configuration. This value can contain only alphanumeric characters, dashes,periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.


description

Required. The description of the configuration.


engineType



id



arn

Required. The ARN of the configuration.


latestRevision

Required. The latest revision of the configuration.

Type: ConfigurationRevision (p. 68)Required: False

tags

The list of all tags associated with this configuration.

Type: object

67


Required: False

ConfigurationRevisionReturns information about the specified configuration revision.

created



description

The description of the configuration revision.


revision

Required. The revision number of the configuration.


CreateConfigurationInputCreates a new configuration for the specified configuration name. Amazon MQ uses the defaultconfiguration (the engine type and version).

engineVersion






name


Type: string

68


Required: False

engineType



tags

Create tags when creating the configuration.


CreateConfigurationOutputReturns information about the created configuration.

created

Required. The date and time of the configuration.





name



id



arn

Required. The Amazon Resource Name (ARN) of the configuration.

69



latestRevision

The latest revision of the configuration.



ACTIVEMQ


errorAttribute



message



ListConfigurationsOutputReturns a list of all configurations.

nextToken



maxResults

The maximum number of configurations that Amazon MQ can return per page (20 by default). This valuemust be an integer from 5 to 100.

Type: integer

70


Required: False

configurations


Type: Array of type Configuration (p. 66)Required: False


ListConfigurations• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






CreateConfiguration• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






ConfigurationA configuration contains all of the settings for your ActiveMQ broker, in XML format. For moreinformation, see Configuration and Amazon MQ Broker Configuration Parameters in the Amazon MQDeveloper Guide.

You can create a configuration before creating any brokers. You can then apply the configuration to oneor more brokers.

71

/goto/aws-cli/mq-2017-11-27/ListConfigurations

/goto/DotNetSDKV3/mq-2017-11-27/ListConfigurations

/goto/SdkForCpp/mq-2017-11-27/ListConfigurations

/goto/SdkForGoV1/mq-2017-11-27/ListConfigurations

/goto/SdkForJava/mq-2017-11-27/ListConfigurations

/goto/AWSJavaScriptSDK/mq-2017-11-27/ListConfigurations

/goto/SdkForPHPV3/mq-2017-11-27/ListConfigurations

/goto/boto3/mq-2017-11-27/ListConfigurations

/goto/SdkForRubyV3/mq-2017-11-27/ListConfigurations

/goto/aws-cli/mq-2017-11-27/CreateConfiguration

/goto/DotNetSDKV3/mq-2017-11-27/CreateConfiguration

/goto/SdkForCpp/mq-2017-11-27/CreateConfiguration

/goto/SdkForGoV1/mq-2017-11-27/CreateConfiguration

/goto/SdkForJava/mq-2017-11-27/CreateConfiguration

/goto/AWSJavaScriptSDK/mq-2017-11-27/CreateConfiguration

/goto/SdkForPHPV3/mq-2017-11-27/CreateConfiguration

/goto/boto3/mq-2017-11-27/CreateConfiguration

/goto/SdkForRubyV3/mq-2017-11-27/CreateConfiguration





URI/v1/configurations/configuration-id

HTTP Methods

GETOperation ID: DescribeConfiguration

Returns information about the specified configuration.

Path Parameters


configuration-id String True The unique ID thatAmazon MQ generatesfor the configuration.

Responses


200 Configuration (p. 73) HTTP Status Code 200: OK.





PUTOperation ID: UpdateConfiguration

Updates the specified configuration.

72


Path Parameters



Responses


200 UpdateConfigurationOutput (p. 74)HTTP Status Code 200: OK.






SchemasRequest Bodies

Example PUT

{ "data": "string", "description": "string"}

Response Bodies

Example Configuration

{

73


"engineVersion": "string", "created": "string", "authenticationStrategy": enum, "name": "string", "description": "string", "engineType": enum, "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer }, "tags": { }}

Example UpdateConfigurationOutput

{ "created": "string", "warnings": [ { "reason": enum, "attributeName": "string", "elementName": "string" } ], "name": "string", "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer }}

Example Error


Properties


SIMPLELDAP

ConfigurationReturns information about all configurations.

74


engineVersion



created






name



description

Required. The description of the configuration.


engineType



id



arn

Required. The ARN of the configuration.

75



latestRevision

Required. The latest revision of the configuration.


tags

The list of all tags associated with this configuration.


ConfigurationRevisionReturns information about the specified configuration revision.

created



description



revision




ACTIVEMQ


76


errorAttribute



message



SanitizationWarningReturns information about the XML element or attribute that was sanitized in the configuration.

reason

Required. The reason for which the XML elements or attributes were sanitized.

Type: SanitizationWarningReason (p. 77)Required: False

attributeName

The name of the XML attribute that has been sanitized.


elementName

The name of the XML element that has been sanitized.


SanitizationWarningReasonThe reason for which the XML elements or attributes were sanitized.

DISALLOWED_ELEMENT_REMOVEDDISALLOWED_ATTRIBUTE_REMOVEDINVALID_ATTRIBUTE_VALUE_REMOVED

UpdateConfigurationInputUpdates the specified configuration.

data

Required. The base64-encoded XML configuration.

77


Type: stringRequired: FalseFormat: byte

description

The description of the configuration.


UpdateConfigurationOutputReturns information about the updated configuration.

created



warnings

The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.

Type: Array of type SanitizationWarning (p. 77)Required: False

name



id



arn

Required. The Amazon Resource Name (ARN) of the configuration.


latestRevision

The latest revision of the configuration.

78




DescribeConfiguration• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






UpdateConfiguration• AWS Command Line Interface


• AWS SDK for C++

• AWS SDK for Go






Configuration RevisionsThis is a collection of configuration revisions. To keep track of the changes you make to yourconfiguration, you can create configuration revisions. For more information, see Configuration in theAmazon MQ Developer Guide.


URI/v1/configurations/configuration-id/revisions

79

/goto/aws-cli/mq-2017-11-27/DescribeConfiguration

/goto/DotNetSDKV3/mq-2017-11-27/DescribeConfiguration

/goto/SdkForCpp/mq-2017-11-27/DescribeConfiguration

/goto/SdkForGoV1/mq-2017-11-27/DescribeConfiguration

/goto/SdkForJava/mq-2017-11-27/DescribeConfiguration

/goto/AWSJavaScriptSDK/mq-2017-11-27/DescribeConfiguration

/goto/SdkForPHPV3/mq-2017-11-27/DescribeConfiguration

/goto/boto3/mq-2017-11-27/DescribeConfiguration

/goto/SdkForRubyV3/mq-2017-11-27/DescribeConfiguration

/goto/aws-cli/mq-2017-11-27/UpdateConfiguration

/goto/DotNetSDKV3/mq-2017-11-27/UpdateConfiguration

/goto/SdkForCpp/mq-2017-11-27/UpdateConfiguration

/goto/SdkForGoV1/mq-2017-11-27/UpdateConfiguration

/goto/SdkForJava/mq-2017-11-27/UpdateConfiguration

/goto/AWSJavaScriptSDK/mq-2017-11-27/UpdateConfiguration

/goto/SdkForPHPV3/mq-2017-11-27/UpdateConfiguration

/goto/boto3/mq-2017-11-27/UpdateConfiguration

/goto/SdkForRubyV3/mq-2017-11-27/UpdateConfiguration



HTTP MethodsGETOperation ID: ListConfigurationRevisions

Returns a list of all revisions for the specified configuration.

Path Parameters



Query Parameters




Responses


200 ListConfigurationRevisionsOutput (p. 81)HTTP Status Code 200: OK.




500 Error (p. 81) HTTP Status Code 500:Unexpected internal server error.

80



Retrying your request mightresolve the issue.

SchemasResponse BodiesExample ListConfigurationRevisionsOutput

{ "nextToken": "string", "maxResults": integer, "revisions": [ { "created": "string", "description": "string", "revision": integer } ], "configurationId": "string"}

Example Error


PropertiesConfigurationRevisionReturns information about the specified configuration revision.

created



description



revision


81




errorAttribute



message



ListConfigurationRevisionsOutputReturns a list of all revisions for the specified configuration.

nextToken



maxResults

The maximum number of configuration revisions that can be returned per page (20 by default). Thisvalue must be an integer from 5 to 100.


revisions


Type: Array of type ConfigurationRevision (p. 81)Required: False

configurationId

The unique ID that Amazon MQ generates for the configuration.

Type: string

82


Required: False


ListConfigurationRevisions• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

Configuration RevisionTo keep track of the changes you make to your configuration, you can create configuration revisions. Formore information, see Configuration in the Amazon MQ Developer Guide.


URI/v1/configurations/configuration-id/revisions/configuration-revision

HTTP Methods

GETOperation ID: DescribeConfigurationRevision

Returns the specified configuration revision for the specified configuration.

Path Parameters


configuration-revision

String True The revision of theconfiguration.


83

/goto/aws-cli/mq-2017-11-27/ListConfigurationRevisions

/goto/DotNetSDKV3/mq-2017-11-27/ListConfigurationRevisions

/goto/SdkForCpp/mq-2017-11-27/ListConfigurationRevisions

/goto/SdkForGoV1/mq-2017-11-27/ListConfigurationRevisions

/goto/SdkForJava/mq-2017-11-27/ListConfigurationRevisions

/goto/AWSJavaScriptSDK/mq-2017-11-27/ListConfigurationRevisions

/goto/SdkForPHPV3/mq-2017-11-27/ListConfigurationRevisions

/goto/boto3/mq-2017-11-27/ListConfigurationRevisions

/goto/SdkForRubyV3/mq-2017-11-27/ListConfigurationRevisions



Responses


200 DescribeConfigurationRevisionOutput (p. 84)HTTP Status Code 200: OK.






Example DescribeConfigurationRevisionOutput

{ "data": "string", "created": "string", "description": "string", "configurationId": "string"}

Example Error


PropertiesDescribeConfigurationRevisionOutputReturns the specified configuration revision for the specified configuration.

data

Required. The base64-encoded XML configuration.

84


Type: stringRequired: FalseFormat: byte

created



description

The description of the configuration.


configurationId




errorAttribute



message




DescribeConfigurationRevision• AWS Command Line Interface

85

/goto/aws-cli/mq-2017-11-27/DescribeConfigurationRevision

Amazon MQ REST API ReferenceTag


• AWS SDK for C++

• AWS SDK for Go






TagA tag is a key-value pair associated with a resource. You can use these metadata tags to identify thepurpose of a broker or configuration. For more information see Tagging resources in the Amazon MQDeveloper Guide.

URI/v1/tags/resource-arn

HTTP Methods

GETOperation ID: ListTags

Lists tags for a resource.

Path Parameters


resource-arn String True The Amazon ResourceName (ARN) of theresource tag.

Responses


200 Tags (p. 89) HTTP Status Code 200: OK.



86

/goto/DotNetSDKV3/mq-2017-11-27/DescribeConfigurationRevision

/goto/SdkForCpp/mq-2017-11-27/DescribeConfigurationRevision

/goto/SdkForGoV1/mq-2017-11-27/DescribeConfigurationRevision

/goto/SdkForJava/mq-2017-11-27/DescribeConfigurationRevision

/goto/AWSJavaScriptSDK/mq-2017-11-27/DescribeConfigurationRevision

/goto/SdkForPHPV3/mq-2017-11-27/DescribeConfigurationRevision

/goto/boto3/mq-2017-11-27/DescribeConfigurationRevision

/goto/SdkForRubyV3/mq-2017-11-27/DescribeConfigurationRevision

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-tagging.html





POSTOperation ID: CreateTags

Add a tag to a resource.

Path Parameters



Responses


204 None HTTP Status Code 204:Successful response.





DELETEOperation ID: DeleteTags

87


Removes a tag from a resource.

Path Parameters



Query Parameters


tagKeys String True An array of tag keys todelete

Responses


204 None HTTP Status Code 204:Successful response.





Schemas

Request Bodies

Example POST

{ "tags": { }}

88


Response Bodies

Example Tags

{ "tags": { }}

Example Error


Properties


errorAttribute



message



TagsA map of the key-value pairs for the resource tag.

tags

The key-value pair for the resource tag.



89


ListTags• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

CreateTags• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

DeleteTags• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

90

/goto/aws-cli/mq-2017-11-27/ListTags

/goto/DotNetSDKV3/mq-2017-11-27/ListTags

/goto/SdkForCpp/mq-2017-11-27/ListTags

/goto/SdkForGoV1/mq-2017-11-27/ListTags

/goto/SdkForJava/mq-2017-11-27/ListTags

/goto/AWSJavaScriptSDK/mq-2017-11-27/ListTags

/goto/SdkForPHPV3/mq-2017-11-27/ListTags

/goto/boto3/mq-2017-11-27/ListTags

/goto/SdkForRubyV3/mq-2017-11-27/ListTags

/goto/aws-cli/mq-2017-11-27/CreateTags

/goto/DotNetSDKV3/mq-2017-11-27/CreateTags

/goto/SdkForCpp/mq-2017-11-27/CreateTags

/goto/SdkForGoV1/mq-2017-11-27/CreateTags

/goto/SdkForJava/mq-2017-11-27/CreateTags

/goto/AWSJavaScriptSDK/mq-2017-11-27/CreateTags

/goto/SdkForPHPV3/mq-2017-11-27/CreateTags

/goto/boto3/mq-2017-11-27/CreateTags

/goto/SdkForRubyV3/mq-2017-11-27/CreateTags

/goto/aws-cli/mq-2017-11-27/DeleteTags

/goto/DotNetSDKV3/mq-2017-11-27/DeleteTags

/goto/SdkForCpp/mq-2017-11-27/DeleteTags

/goto/SdkForGoV1/mq-2017-11-27/DeleteTags

/goto/SdkForJava/mq-2017-11-27/DeleteTags

/goto/AWSJavaScriptSDK/mq-2017-11-27/DeleteTags

/goto/SdkForPHPV3/mq-2017-11-27/DeleteTags

/goto/boto3/mq-2017-11-27/DeleteTags

/goto/SdkForRubyV3/mq-2017-11-27/DeleteTags


OperationsThe Amazon MQ REST API includes the following operations.

• CreateBroker (p. 12)

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the followingEC2 permissions in your IAM policy.• ec2:CreateNetworkInterface

This permission is required to allow Amazon MQ to create an elastic network interface (ENI) onbehalf of your account.

• ec2:CreateNetworkInterfacePermission

This permission is required to attach the ENI to the broker instance.• ec2:DeleteNetworkInterface

• ec2:DeleteNetworkInterfacePermission

• ec2:DetachNetworkInterface

• ec2:DescribeInternetGateways

• ec2:DescribeNetworkInterfaces

• ec2:DescribeNetworkInterfacePermissions

• ec2:DescribeRouteTables

• ec2:DescribeSecurityGroups

• ec2:DescribeSubnets

• ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify orDelete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

• CreateConfiguration (p. 64)

Creates a new configuration for the specified configuration name. Amazon MQ uses the defaultconfiguration (the engine type and version).

• CreateTags (p. 87)

Add a tag to a resource.• CreateUser (p. 55)

Creates an ActiveMQ user.• DeleteBroker (p. 27)

Deletes a broker. Note: This API is asynchronous.• DeleteTags (p. 87)

Removes a tag from a resource.• DeleteUser (p. 57)

Deletes an ActiveMQ user.• DescribeBroker (p. 25)

91

https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user




Returns information about the specified broker.• DescribeBrokerEngineTypes (p. 3)

Describe available engine types and versions.• DescribeBrokerInstanceOptions (p. 7)

Describe available broker instance options.• DescribeConfiguration (p. 72)

Returns information about the specified configuration.• DescribeConfigurationRevision (p. 83)

Returns the specified configuration revision for the specified configuration.• DescribeUser (p. 54)

Returns information about an ActiveMQ user.• ListBrokers (p. 11)

Returns a list of all brokers.• ListConfigurationRevisions (p. 80)

Returns a list of all revisions for the specified configuration.• ListConfigurations (p. 63)

Returns a list of all configurations.• ListTags (p. 86)

Lists tags for a resource.• ListUsers (p. 50)

Returns a list of all ActiveMQ users.• RebootBroker (p. 48)

Reboots a broker. Note: This API is asynchronous.• UpdateBroker (p. 26)

Adds a pending configuration change to a broker.• UpdateConfiguration (p. 72)

Updates the specified configuration.• UpdateUser (p. 56)

Updates the information for an ActiveMQ user.

92

amazon mq - rest api reference...amazon mq is a managed message broker service for apache activemq...

Documents