disableMetricsCollection method

Future<void> disableMetricsCollection({
  1. required String autoScalingGroupName,
  2. List<String>? metrics,
})

Disables group metrics collection for the specified Auto Scaling group.

May throw ResourceContentionFault.

Parameter autoScalingGroupName : The name of the Auto Scaling group.

Parameter metrics : Identifies the metrics to disable.

You can specify one or more of the following metrics:

  • GroupMinSize
  • GroupMaxSize
  • GroupDesiredCapacity
  • GroupInServiceInstances
  • GroupPendingInstances
  • GroupStandbyInstances
  • GroupTerminatingInstances
  • GroupTotalInstances
  • GroupInServiceCapacity
  • GroupPendingCapacity
  • GroupStandbyCapacity
  • GroupTerminatingCapacity
  • GroupTotalCapacity
  • WarmPoolDesiredCapacity
  • WarmPoolWarmedCapacity
  • WarmPoolPendingCapacity
  • WarmPoolTerminatingCapacity
  • WarmPoolTotalCapacity
  • GroupAndWarmPoolDesiredCapacity
  • GroupAndWarmPoolTotalCapacity
If you omit this property, all metrics are disabled.

For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

Implementation

Future<void> disableMetricsCollection({
  required String autoScalingGroupName,
  List<String>? metrics,
}) async {
  final $request = <String, String>{
    'AutoScalingGroupName': autoScalingGroupName,
    if (metrics != null)
      if (metrics.isEmpty)
        'Metrics': ''
      else
        for (var i1 = 0; i1 < metrics.length; i1++)
          'Metrics.member.${i1 + 1}': metrics[i1],
  };
  await _protocol.send(
    $request,
    action: 'DisableMetricsCollection',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
  );
}