describeBrokerInstanceOptions method

Future<DescribeBrokerInstanceOptionsResponse> describeBrokerInstanceOptions({
  1. String? engineType,
  2. String? hostInstanceType,
  3. int? maxResults,
  4. String? nextToken,
  5. String? storageType,

Describe available broker instance options.

May throw BadRequestException. May throw InternalServerErrorException. May throw ForbiddenException.

Parameter engineType : Filter response by engine type.

Parameter hostInstanceType : Filter response by host instance type.

Parameter maxResults : The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

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

Parameter storageType : Filter response by storage type.


Future<DescribeBrokerInstanceOptionsResponse> describeBrokerInstanceOptions({
  String? engineType,
  String? hostInstanceType,
  int? maxResults,
  String? nextToken,
  String? storageType,
}) async {
  final $query = <String, List<String>>{
    if (engineType != null) 'engineType': [engineType],
    if (hostInstanceType != null) 'hostInstanceType': [hostInstanceType],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (storageType != null) 'storageType': [storageType],
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/v1/broker-instance-options',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  return DescribeBrokerInstanceOptionsResponse.fromJson(response);