URI HTTP methods Schemas Properties See also

Broker Instance Options

You can retrieve information about broker instances. For more information about the different 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
Name	Type	Required	Description
`hostInstanceType`	String	False	Filter response by host instance 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.
`storageType`	String	False	Filter response by storage type.
`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.
`engineType`	String	False	Filter response by engine type.

Responses
Status code	Response model	Description
`200`	`BrokerInstanceOptionsOutput`	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.

OPTIONS

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

Schemas

Response bodies


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


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

Properties

AvailabilityZone

Name of the availability zone.

Property	Type	Required	Description
`name`	string	False	Id for the availability zone.

BrokerInstanceOption

Option for host instance type.

Property	Type	Required	Description
`availabilityZones`	Array of type AvailabilityZone	False	The list of available az.
`engineType`	EngineType	False	The broker's engine type.
`hostInstanceType`	string	False	The broker's instance type.
`storageType`	BrokerStorageType	False	The broker's storage type.
`supportedDeploymentModes`	Array of type DeploymentMode	False	The list of supported deployment modes.
`supportedEngineVersions`	Array of type string	False	The list of supported engine versions.

BrokerInstanceOptionsOutput

Returns a list of broker instance options.

Property Type Required Description

Property	Type	Required	Description
`brokerInstanceOptions`	Array of type BrokerInstanceOption	False	List of available broker instance options.
`maxResults`	integer Minimum: 5 Maximum: 100	True	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.
`nextToken`	string	False	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

brokerInstanceOptions

Array of type BrokerInstanceOption

False

List of available broker instance options.

maxResults

integer

Minimum: 5

Maximum: 100

True

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.

nextToken

string

False

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

BrokerStorageType

The broker's storage type.

Important

EFS is not supported for RabbitMQ engine type.

EBS
EFS

DeploymentMode

The broker's deployment mode.

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

EngineType

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

ACTIVEMQ
RABBITMQ

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.