describeBrokerEngineTypes method

Future<DescribeBrokerEngineTypesResponse> describeBrokerEngineTypes({
  1. String? engineType,
  2. int? maxResults,
  3. String? nextToken,
})

Describe available engine types and versions.

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

Parameter engineType : Filter response by engine type.

Parameter maxResults : The maximum number of engine types 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.

Implementation

Future<DescribeBrokerEngineTypesResponse> describeBrokerEngineTypes({
  String? engineType,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (engineType != null) 'engineType': [engineType],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/v1/broker-engine-types',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeBrokerEngineTypesResponse.fromJson(response);
}