describeAutoScalingGroups method

Future<AutoScalingGroupsType> describeAutoScalingGroups({ List<String>? autoScalingGroupNames, int? maxRecords, String? nextToken, })

Describes one or more Auto Scaling groups.

May throw InvalidNextToken. May throw ResourceContentionFault.

Parameter autoScalingGroupNames : The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

Parameter maxRecords : The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Parameter nextToken : The token for the next set of items to return. (You received this token from a previous call.)

Implementation

Future<AutoScalingGroupsType> describeAutoScalingGroups({
  List<String>? autoScalingGroupNames,
  int? maxRecords,
  String? nextToken,
}) async {
  final $request = <String, dynamic>{};
  autoScalingGroupNames
      ?.also((arg) => $request['AutoScalingGroupNames'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeAutoScalingGroups',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['AutoScalingGroupNamesType'],
    shapes: shapes,
    resultWrapper: 'DescribeAutoScalingGroupsResult',
  );
  return AutoScalingGroupsType.fromXml($result);
}