DescribeBrokerInstanceOptionsCommand

Suggest an Edit

Describe available broker instance options.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MqClient, DescribeBrokerInstanceOptionsCommand } from "@aws-sdk/client-mq"; // ES Modules import
// const { MqClient, DescribeBrokerInstanceOptionsCommand } = require("@aws-sdk/client-mq"); // CommonJS import
const client = new MqClient(config);
const input = { // DescribeBrokerInstanceOptionsRequest
  EngineType: "STRING_VALUE",
  HostInstanceType: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  StorageType: "STRING_VALUE",
};
const command = new DescribeBrokerInstanceOptionsCommand(input);
const response = await client.send(command);
// { // DescribeBrokerInstanceOptionsResponse
//   BrokerInstanceOptions: [ // __listOfBrokerInstanceOption
//     { // BrokerInstanceOption
//       AvailabilityZones: [ // __listOfAvailabilityZone
//         { // AvailabilityZone
//           Name: "STRING_VALUE",
//         },
//       ],
//       EngineType: "ACTIVEMQ" || "RABBITMQ",
//       HostInstanceType: "STRING_VALUE",
//       StorageType: "EBS" || "EFS",
//       SupportedDeploymentModes: [ // __listOfDeploymentMode
//         "SINGLE_INSTANCE" || "ACTIVE_STANDBY_MULTI_AZ" || "CLUSTER_MULTI_AZ",
//       ],
//       SupportedEngineVersions: [ // __listOf__string
//         "STRING_VALUE",
//       ],
//     },
//   ],
//   MaxResults: Number("int"),
//   NextToken: "STRING_VALUE",
// };

DescribeBrokerInstanceOptionsCommand Input

See DescribeBrokerInstanceOptionsCommandInput for more details

Parameter
Type
Description
EngineType
string | undefined

Filter response by engine type.

HostInstanceType
string | undefined

Filter response by host instance type.

MaxResults
number | undefined

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.

NextToken
string | undefined

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

StorageType
string | undefined

Filter response by storage type.

DescribeBrokerInstanceOptionsCommand Output

See DescribeBrokerInstanceOptionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BrokerInstanceOptions
BrokerInstanceOption[] | undefined

List of available broker instance options.

MaxResults
number | undefined

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

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

Throws

Name
Fault
Details
BadRequestException
client

Returns information about an error.

ForbiddenException
client

Returns information about an error.

InternalServerErrorException
server

Returns information about an error.

MqServiceException
Base exception class for all service exceptions from Mq service.