Amazon MQ
REST API Reference

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

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

Broker 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 Engine 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

Describe available engine types and versions.

Query Parameters

Name Type Required Description
engineType String False

Filter response by engine type.

nextToken String False

The token that specifies the next page of results Amazon MQ should return. To request the first 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

Status Code Response Model Description
200 BrokerEngineTypeOutput

HTTP Status Code 200: OK.

400 Error

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

403 Error

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

500 Error

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

Schemas

Response Bodies

Example BrokerEngineTypeOutput

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

Example Error

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

Properties

BrokerEngineType

Types of broker engines.

Property Type Required Description
engineVersions

Array of type EngineVersion

False

The list of engine versions.

engineType

EngineType

False

The type of broker engine.

BrokerEngineTypeOutput

Returns a list of broker engine type.

Property Type Required Description
nextToken

string

False

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

maxResults

integer

Minimum: 5

Maximum: 100

False

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.

brokerEngineTypes

Array of type BrokerEngineType

False

List of available engine types and versions.

EngineType

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

  • ACTIVEMQ

EngineVersion

Id of the engine version.

Property Type Required Description
name

string

False

Id for the version.

Error

Returns information about an error.

Property Type Required Description
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

See Also

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

DescribeBrokerEngineTypes