describeCustomAvailabilityZones method

Future<CustomAvailabilityZoneMessage> describeCustomAvailabilityZones({ String? customAvailabilityZoneId, List<Filter>? filters, String? marker, int? maxRecords, })

Returns information about custom Availability Zones (AZs).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

May throw CustomAvailabilityZoneNotFoundFault.

Parameter customAvailabilityZoneId : The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

Parameter filters : A filter that specifies one or more custom AZs to describe.

Parameter marker : An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Implementation

Future<CustomAvailabilityZoneMessage> describeCustomAvailabilityZones({
  String? customAvailabilityZoneId,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  customAvailabilityZoneId
      ?.also((arg) => $request['CustomAvailabilityZoneId'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeCustomAvailabilityZones',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeCustomAvailabilityZonesMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeCustomAvailabilityZonesResult',
  );
  return CustomAvailabilityZoneMessage.fromXml($result);
}