Amazon MQ

(1)

Amazon MQ

REST API Reference

(2)

Amazon MQ: REST API Reference

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

(3)

Welcome

Welcome to the Amazon MQ REST API reference. In this guide, you can ﬁnd descriptions of REST resources, example requests, HTTP methods, schemas, parameters, and the errors that the service returns.

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols. Amazon MQ works with your existing applications and services without the need to manage, operate, or maintain your own messaging system.

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

This document was last published on July 7, 2021

Example REST Request

The following is an example of an Amazon MQ REST request (and its headers) which creates a new Amazon MQ for ActiveMQ broker:

POST /v1/brokers HTTP/1.1 Content-Type: application/json X-Amz-Date: 20171123T214525Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20171128/us- east-2/mq/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=a12bc34567defg89h0ij1234kl56m789no01p2q345r6s789tu01v2w3x4567890 Host: mq.us-east-2.amazonaws.com

Cache-Control: no-cache {

"brokerName": "MyActiveMQBroker", "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",

(6)

"subnet-67d8e90f"

],

"securityGroups": [ "sg-a1b234cd", "sg-e5f678gh"

],

"autoMinorVersionUpgrade": true, "users": [{

"password": "MyPassword456", "groups": [

"admins"

],

"consoleAccess": true, "username": "jane.doe"

}]

}

The following is an example of an Amazon MQ REST request (and its headers) which creates a new Amazon MQ for RabbitMQ broker:

POST /v1/brokers HTTP/1.1 Content-Type: application/json X-Amz-Date: 20171123T214525Z

Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20171128/us- east-2/mq/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=a12bc34567defg89h0ij1234kl56m789no01p2q345r6s789tu01v2w3x4567890 Host: mq.us-east-2.amazonaws.com

Cache-Control: no-cache

{ "brokerName": "MyRabbitMQBroker", "hostInstanceType": "mq.m5.large", "engineType": "RabbitMQ",

"engineVersion": "3.8.6", "logs": {

"general": true },

"deploymentMode": "CLUSTER_MULTI_AZ", "publiclyAccessible": true, "subnetIds": [

"subnet-15a3b47c", "subnet-69d8n90j"

],

"autoMinorVersionUpgrade": true, "users": [{

"password": "MyPassword456", "groups": [

"admins"

],

"consoleAccess": true, "username": "jane.doe"

}]

}

Example REST Response

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

HTTP/1.1 200 OK

(7)

Example REST Response

Content-Type: application/json Content-Length: 250

Connection: keep-alive

Date: Wed, 28 Nov 2017 12:00:00 GMT

X-Amzn-RequestId: a12bc345-67de-89f0-g12h-345ij6k7l89m

X-Amzn-Trace-Id: sampled=1;root=1-2345a67b-c8defg901hijk2lf3m4nopqr X-Cache: Miss from cloudfront

Via: 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"

}

(8)

Resources

The Amazon MQ REST API includes the following resources.

Topics

• Broker (p. 4)

• Broker Engine Types (p. 26)

• Broker Instance Options (p. 30)

• Broker Reboot (p. 34)

• Brokers (p. 36)

• Conﬁguration (p. 51)

• Conﬁguration Revision (p. 59)

• Conﬁguration Revisions (p. 62)

• Conﬁgurations (p. 66)

• Tag (p. 74)

• User (p. 78)

• Users (p. 88)

Broker

A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. For more information about the diﬀerent components of an Amazon MQ broker, see How Amazon MQ works in the Amazon MQ Developer Guide.

URI

/v1/brokers/broker-id

HTTP methods

GET

Operation ID: DescribeBroker

Returns information about the speciﬁed broker.

Path parameters

Name Type Required Description

broker-id String True The unique ID that

Amazon MQ generates for the broker.

Responses

Status code Response model Description

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

(9)

HTTP methods

400 Error (p. 10) HTTP Status Code 400: Bad

request due to incorrect input.

Correct your request and then retry it.

403 Error (p. 10) HTTP Status Code 403: Access

forbidden. Correct your credentials and then retry your request.

404 Error (p. 10) HTTP Status Code 404: Resource

not found due to incorrect input.

500 Error (p. 10) HTTP Status Code 500:

Unexpected internal server error.

Retrying your request might resolve the issue.

PUT

Operation ID: UpdateBroker

Adds a pending conﬁguration change to a broker.

Path parameters

Responses

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

(10)

409 Error (p. 10) HTTP Status Code 409: Conﬂict.

This broker name already exists.

Retry your request with another name.

DELETE

Operation ID: DeleteBroker

Deletes a broker. Note: This API is asynchronous.

Path parameters

Responses

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

Schemas

Request bodies

(11)

Schemas

PUT schema

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

"timeZone": "string", "timeOfDay": "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, "serviceAccountUsername": "string", "userRoleName": "string",

"userSearchMatching": "string", "userSearchSubtree": boolean }, "logs": {

"general": boolean, "audit": boolean },

"hostInstanceType": "string", "autoMinorVersionUpgrade": boolean }

Response bodies

DescribeBrokerOutput schema

{ "pendingEngineVersion": "string", "pendingAuthenticationStrategy": enum, "pendingSecurityGroups": [

"string"

], "configurations": { "current": { "id": "string", "revision": integer },

"pending": { "id": "string", "revision": integer },

"history": [ {

"id": "string", "revision": integer

(12)

} ]

}, "brokerState": enum, "engineType": enum, "brokerInstances": [ {

"endpoints": [ "string"

],

"consoleURL": "string", "ipAddress": "string"

} ],

"hostInstanceType": "string", "publiclyAccessible": boolean, "logs": {

"generalLogGroup": "string", "general": boolean,

"audit": boolean, "pending": {

"auditLogGroup": "string"

},

"ldapServerMetadata": {

"roleSearchMatching": "string", "roleBase": "string",

"hosts": [ "string"

],

"userSearchMatching": "string", "userSearchSubtree": boolean }, "subnetIds": [

"string"

], "engineVersion": "string",

"pendingHostInstanceType": "string", "brokerArn": "string",

"brokerId": "string", "deploymentMode": enum,

"maintenanceWindowStartTime": { "dayOfWeek": enum,

}, "created": "string",

"authenticationStrategy": enum, "users": [

{

"pendingChange": enum, "username": "string"

} ], "tags": {

}, "pendingLdapServerMetadata": { "roleSearchMatching": "string", "roleBase": "string",

(13)

Schemas

"hosts": [ "string"

],

"userSearchMatching": "string", "userSearchSubtree": boolean },

"encryptionOptions": { "useAwsOwnedKey": boolean, "kmsKeyId": "string"

}, "storageType": enum, "securityGroups": [ "string"

],

"brokerName": "string",

"autoMinorVersionUpgrade": boolean }

UpdateBrokerOutput schema

{

"engineVersion": "string", "brokerId": "string",

}, "configuration": { "id": "string", "revision": integer

}, "authenticationStrategy": enum, "securityGroups": [

"string"

],

"ldapServerMetadata": {

"roleSearchMatching": "string", "roleBase": "string",

"hosts": [ "string"

],

"userSearchMatching": "string", "userSearchSubtree": boolean }, "logs": {

"hostInstanceType": "string", "autoMinorVersionUpgrade": boolean }

(14)

DeleteBrokerOutput schema

{ "brokerId": "string"

}

Error schema

{

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

}

Properties

AuthenticationStrategy

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

SIMPLE LDAP

BrokerInstance

Returns information about all brokers.

endpoints

The broker's wire-level protocol endpoints.

Type: Array of type string Required: False

consoleURL

The brokers web console URL.

Type: string Required: False

ipAddress

The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.

BrokerState

The broker's status.

(15)

Properties

CREATION_IN_PROGRESS CREATION_FAILED DELETION_IN_PROGRESS RUNNING

REBOOT_IN_PROGRESS

BrokerStorageType

The broker's storage type.

Important

EFS is not supported for RabbitMQ engine type.

EBS EFS

ChangeType

The type of change pending for the ActiveMQ user.

CREATE UPDATE DELETE

ConﬁgurationId

A list of information about the conﬁguration.

Important

Does not apply to RabbitMQ brokers.

id

Required. The unique ID that Amazon MQ generates for the conﬁguration.

Type: string Required: True

revision

The revision number of the conﬁguration.

Type: integer Required: False

Conﬁgurations

Broker conﬁguration information

current

The broker's current conﬁguration.

(16)

Type: ConﬁgurationId (p. 11) Required: False

pending

The broker's pending conﬁguration.

history

The history of conﬁgurations applied to the broker.

Type: Array of type ConﬁgurationId (p. 11) Required: False

DeleteBrokerOutput

Returns information about the deleted broker.

brokerId

The unique ID that Amazon MQ generates for the broker.

DeploymentMode

The broker's deployment mode.

SINGLE_INSTANCE

ACTIVE_STANDBY_MULTI_AZ CLUSTER_MULTI_AZ

DescribeBrokerOutput

Returns information about the speciﬁed broker.

pendingEngineVersion

The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

pendingAuthenticationStrategy

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

Type: AuthenticationStrategy (p. 10)

(17)

Properties

Required: False

pendingSecurityGroups

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

conﬁgurations

The list of all revisions for the speciﬁed conﬁguration.

Type: Conﬁgurations (p. 11) Required: False

brokerState

Type: BrokerState (p. 10) Required: False

engineType

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

Type: EngineType (p. 16) Required: True

brokerInstances

A list of information about allocated brokers.

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

hostInstanceType

The broker's instance type.

publiclyAccessible

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

Type: boolean Required: True

logs

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

(18)

Type: LogsSummary (p. 21) Required: False

ldapServerMetadata

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

Type: LdapServerMetadataOutput (p. 19) Required: False

subnetIds

The list of groups that deﬁne which subnets and IP ranges the broker can use from diﬀerent Availability Zones.

engineVersion

The broker engine's version. For a list of supported engine versions, see Supported engines.

pendingHostInstanceType

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

brokerArn

The broker's Amazon Resource Name (ARN).

brokerId

deploymentMode

Type: DeploymentMode (p. 12) Required: True

(19)

Properties

maintenanceWindowStartTime

The parameters that determine the WeeklyStartTime.

Type: WeeklyStartTime (p. 25) Required: False

created

The time when the broker was created.

Type: string Required: False Format: date-time

authenticationStrategy

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

Type: AuthenticationStrategy (p. 10) Required: False

users

The list of all broker usernames for the speciﬁed broker.

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

pendingLdapServerMetadata

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

encryptionOptions

Encryption options for the broker. Does not apply to RabbitMQ brokers.

Type: EncryptionOptions (p. 16) Required: False

storageType

(20)

Type: BrokerStorageType (p. 11) Required: False

securityGroups

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 account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

autoMinorVersionUpgrade

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

EncryptionOptions

Important

Encryption options for the broker.

useAwsOwnedKey

Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

kmsKeyId

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

EngineType

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

(21)

Properties

ACTIVEMQ RABBITMQ

Error

Returns information about an error.

errorAttribute

The attribute which caused the error.

message

The explanation of the error.

LdapServerMetadataInput

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

Important

roleSearchMatching

The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched 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 ﬁlter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

serviceAccountPassword

Service account password. A service account is an account in your LDAP server that has access to initiate a 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.

(22)

hosts

Speciﬁes the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory.

Optional failover server.

Type: Array of type string Required: True

roleName

Speciﬁes the LDAP attribute that identiﬁes the group name attribute in the object returned from the group membership query.

userBase

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is speciﬁed by a DN, which speciﬁes the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the 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: boolean Required: False

serviceAccountUsername

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

userRoleName

Speciﬁes 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 into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

(23)

Properties

userSearchSubtree

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

LdapServerMetadataOutput

roleSearchMatching

roleBase

hosts

roleName

userBase

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is speciﬁed by a DN, which speciﬁes the base node of the subtree. For example, by setting this option to

(24)

ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the 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.

serviceAccountUsername

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

userRoleName

Speciﬁes 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 into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in 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.

Logs

The list of information about logs to be enabled for the speciﬁed broker.

general

Enables general logging.

(25)

Properties

audit

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

LogsSummary

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

generalLogGroup

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

general

audit

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

pending

The list of information about logs pending to be deployed for the speciﬁed broker.

Type: PendingLogs (p. 21) Required: False

auditLogGroup

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

PendingLogs

general

(26)

audit

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

UpdateBrokerInput

Updates the broker using the speciﬁed properties.

engineVersion

The broker engine version. For a list of supported engine versions, see Supported engines.

maintenanceWindowStartTime

conﬁguration

authenticationStrategy

securityGroups

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

ldapServerMetadata

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

(27)

Properties

Type: LdapServerMetadataInput (p. 17) Required: False

logs

Enables Amazon CloudWatch logging for brokers.

Type: Logs (p. 20) Required: False

hostInstanceType

autoMinorVersionUpgrade

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

UpdateBrokerOutput

Returns information about the updated broker.

engineVersion

The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

brokerId

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

maintenanceWindowStartTime

conﬁguration

The ID of the updated conﬁguration.

(28)

authenticationStrategy

securityGroups

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

ldapServerMetadata

logs

hostInstanceType

autoMinorVersionUpgrade

The new boolean value that speciﬁes whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.

UserSummary

Returns a list of all broker users. Does not apply to RabbitMQ brokers.

pendingChange

The type of change pending for the broker user.

(29)

username

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

WeeklyStartTime

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

dayOfWeek

Required. The day of the week.

timeZone

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

timeOfDay

Required. The time, in 24-hour format.

DescribeBroker

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

(30)

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

UpdateBroker

• AWS SDK for C++

• AWS SDK for Go

DeleteBroker

• AWS SDK for C++

• AWS SDK for Go

Broker Engine Types

Retrieve information about available broker engines. AWS does not support all instance types in all availability zones and regions. For more information, see Supported engines in the Amazon MQ Developer Guide.

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

URI

/v1/broker-engine-types

HTTP methods

GET

Operation ID: DescribeBrokerEngineTypes

(31)

Schemas

Describe available engine types and versions.

Query parameters

engineType String False Filter response by

engine type.

nextToken String False The token that speciﬁes

the next page of results Amazon MQ should return. To request the ﬁrst page, leave nextToken empty.

maxResults String False The maximum number

of brokers that Amazon MQ can return per page (20 by default).

This value must be an integer from 5 to 100.

Responses

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

Schemas

Response bodies

BrokerEngineTypeOutput schema

{

"nextToken": "string", "maxResults": integer, "brokerEngineTypes": [ {

"engineVersions": [

(32)

{

"name": "string"

} ],

"engineType": enum }

]}

Error schema

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

}

Properties

BrokerEngineType

Types of broker engines.

engineVersions

The list of engine versions.

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

engineType

The broker's engine type.

Type: EngineType (p. 29) Required: False

BrokerEngineTypeOutput

Returns a list of broker engine type.

nextToken

The token that speciﬁes the next page of results Amazon MQ should return. To request the ﬁrst page, leave nextToken empty.

maxResults

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

Type: integer

(33)

brokerEngineTypes

List of available engine types and versions.

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

EngineType

ACTIVEMQ RABBITMQ

EngineVersion

Id of the engine version.

name

Id for the version.

Error

errorAttribute

message

DescribeBrokerEngineTypes

• AWS SDK for C++

• AWS SDK for Go

Broker Instance Options

You can retrieve information about broker instances. For more information about the diﬀerent

components of an Amazon MQ broker, see How Amazon MQ works in the Amazon MQ Developer Guide.

URI

/v1/broker-instance-options

HTTP methods

GET

Operation ID: DescribeBrokerInstanceOptions Describe available broker instance options.

Query parameters

hostInstanceType String False Filter response by host

instance type.

storageType String False Filter response by

storage type.

(35)

Schemas

engineType String False Filter response by

engine type.

Responses

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

Schemas

Response bodies

BrokerInstanceOptionsOutput schema

{ "nextToken": "string", "maxResults": integer, "brokerInstanceOptions": [ {

"supportedDeploymentModes": [ enum

],

"supportedEngineVersions": [ "string"

],

"storageType": enum, "engineType": enum, "availabilityZones": [ {

"name": "string"

} ],

"hostInstanceType": "string"

} ]}

(36)

Error schema

{

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

}

Properties

AvailabilityZone

Name of the availability zone.

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. 33) Required: False

supportedEngineVersions

The list of supported engine versions.

storageType

engineType

The broker's engine type.

Type: EngineType (p. 34) Required: False

availabilityZones

The list of available az.

(37)

Properties

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

hostInstanceType

BrokerInstanceOptionsOutput

Returns a list of broker instance options.

nextToken

The token that speciﬁes the next page of results Amazon MQ should return. To request the ﬁrst page, leave nextToken empty.

maxResults

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

Type: integer Required: True Minimum: 5 Maximum: 100

brokerInstanceOptions

List of available broker instance options.

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

BrokerStorageType

Important

EBSEFS

DeploymentMode

SINGLE_INSTANCE

ACTIVE_STANDBY_MULTI_AZ

(38)

CLUSTER_MULTI_AZ

EngineType

ACTIVEMQ RABBITMQ

Error

errorAttribute

message

DescribeBrokerInstanceOptions

• AWS SDK for C++

• AWS SDK for Go

Broker Reboot

To apply a new conﬁguration to a broker, you can reboot the broker. In addition, if your broker becomes unresponsive, you can reboot it to recover from a faulty state.

Note

You can reboot only a broker with the RUNNING status.

(39)

URI

/v1/brokers/broker-id/reboot

HTTP methods

POST

Operation ID: RebootBroker

Reboots a broker. Note: This API is asynchronous.

Path parameters

Responses

200 None HTTP Status Code 200: OK.

Schemas

Response bodies

Error schema

{ "errorAttribute": "string",

(40)

"message": "string"

}

Properties

Error

errorAttribute

message

RebootBroker

• AWS SDK for C++

• AWS SDK for Go

Brokers

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

URI

/v1/brokers

(41)

HTTP methods

GET

Operation ID: ListBrokers Returns a list of all brokers.

Query parameters

Responses

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

POST

Operation 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 following EC2 permissions in your IAM policy.

• ec2:CreateNetworkInterface

(42)

This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf 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 or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

Responses

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

Unauthorized request. The provided credentials couldn't be validated.

409 Error (p. 40) HTTP Status Code 409: Conﬂict.

This broker name already exists.

Retry your request with another name.

Schemas

Request bodies

(43)

Schemas

POST schema

{

"engineVersion": "string", "deploymentMode": enum,

},

"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"

],

"userSearchMatching": "string", "userSearchSubtree": boolean }, "autoMinorVersionUpgrade": boolean, "subnetIds": [

"string"

] }

(44)

Response bodies

ListBrokersOutput schema

{

"brokerSummaries": [ {

"brokerArn": "string", "brokerId": "string", "deploymentMode": enum, "created": "string", "brokerState": enum, "engineType": enum, "brokerName": "string", "hostInstanceType": "string"

} ],

"nextToken": "string"

}

CreateBrokerOutput schema

{

"brokerArn": "string", "brokerId": "string"

}

Error schema

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

}

Properties

AuthenticationStrategy

SIMPLE LDAP

BrokerState

CREATION_IN_PROGRESS CREATION_FAILED DELETION_IN_PROGRESS RUNNING

REBOOT_IN_PROGRESS

(45)

Properties

BrokerStorageType

Important

EBS EFS

BrokerSummary

Returns information about all brokers.

brokerArn

brokerId

deploymentMode

created

The time when the broker was created.

Type: string Required: False Format: date-time

brokerState

Type: BrokerState (p. 40) Required: False

engineType

The type of broker engine.

(46)

brokerName

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

hostInstanceType

ConﬁgurationId

Important

id

Required. The unique ID that Amazon MQ generates for the conﬁguration.

revision

The revision number of the conﬁguration.

Type: integer Required: False

CreateBrokerInput

Creates a broker.

engineVersion

Required. The broker engine's version. For a list of supported engine versions, see Supported engines.

deploymentMode

Required. The broker's deployment mode.

(47)

Properties

maintenanceWindowStartTime

conﬁguration

authenticationStrategy

engineType

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

hostInstanceType

Required. The broker's instance type.

users

The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is ﬁrst provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

Type: Array of type User (p. 49) Required: True

creatorRequestId

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.

Note

We recommend using a Universally Unique Identiﬁer (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.

publiclyAccessible

Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

encryptionOptions

Encryption options for the broker. Does not apply to RabbitMQ brokers.

Type: EncryptionOptions (p. 46) 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, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Important

Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in broker names. Broker names are accessible to other AWS services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.

(49)

Properties

logs

Enables Amazon CloudWatch logging for brokers.

ldapServerMetadata

Type: LdapServerMetadataInput (p. 47) Required: False

autoMinorVersionUpgrade

Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is speciﬁed.

subnetIds

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones.

Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.

Important

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the speciﬁed subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.

CreateBrokerOutput

Returns information about the created broker.

brokerArn

brokerId

(50)

DeploymentMode

SINGLE_INSTANCE

ACTIVE_STANDBY_MULTI_AZ CLUSTER_MULTI_AZ

EncryptionOptions

Important

Encryption options for the broker.

useAwsOwnedKey

Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

kmsKeyId

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

EngineType

ACTIVEMQ RABBITMQ

Error

errorAttribute

message

(51)

Properties

LdapServerMetadataInput

Important

roleSearchMatching

serviceAccountPassword

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

Amazon MQ

Amazon MQ

REST API Reference

Amazon MQ: REST API Reference

Table of Contents

Welcome

Example REST Request

Example REST Response

Resources

Broker

URI

HTTP methods

GET

Path parameters

Responses

PUT

Path parameters

Responses

DELETE

Path parameters

Responses

Schemas

Request bodies

Response bodies

Properties

AuthenticationStrategy

BrokerInstance

endpoints

consoleURL

ipAddress

BrokerState

BrokerStorageType

Important

ChangeType

ConﬁgurationId

Important

id

revision

Conﬁgurations

current

pending

history

DeleteBrokerOutput

brokerId

DeploymentMode

DescribeBrokerOutput

pendingEngineVersion

pendingAuthenticationStrategy

pendingSecurityGroups

conﬁgurations

brokerState

engineType

brokerInstances

hostInstanceType

publiclyAccessible

logs

ldapServerMetadata

subnetIds

engineVersion

pendingHostInstanceType

brokerArn

brokerId

deploymentMode

maintenanceWindowStartTime

created

authenticationStrategy

users

tags

pendingLdapServerMetadata

encryptionOptions

storageType

securityGroups

brokerName

autoMinorVersionUpgrade

EncryptionOptions

Important

useAwsOwnedKey

kmsKeyId

EngineType

Error