EnableMetricsCollection
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- Granularity
-
The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- Metrics.member.N
-
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
Granularityand don't specify any metrics, all metrics are enabled.For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of EnableMetricsCollection.
Sample Request
https://autoscaling.amazonaws.com/?Action=EnableMetricsCollection
&AutoScalingGroupName=my-asg
&Granularity=1Minute
&Metrics.member.1=GroupDesiredCapacity
&Version=2011-01-01
&AUTHPARAMS See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
