enable_metrics_collection

AutoScaling.Client.enable_metrics_collection(**kwargs)

Enables group metrics collection for the specified Auto Scaling group.

You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.enable_metrics_collection(
    AutoScalingGroupName='string',
    Metrics=[
        'string',
    ],
    Granularity='string'
)

Parameters

• AutoScalingGroupName (string) --

  [REQUIRED]

  The name of the Auto Scaling group.

• Metrics (list) --

  Identifies the metrics to enable.

  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 specify Granularity and don't specify any metrics, all metrics are enabled.

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

  • (string) --
• Granularity (string) --

  [REQUIRED]

  The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute .

Returns

None

Exceptions

• AutoScaling.Client.exceptions.ResourceContentionFault

Examples

This example enables data collection for the specified Auto Scaling group.

response = client.enable_metrics_collection(
    AutoScalingGroupName='my-auto-scaling-group',
    Granularity='1Minute',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}