Skip to content

PredictiveScalingMetricStat

Source code in docs_src/capo_application_auto_scaling/types/predictive_scaling_metric_stat.py
class PredictiveScalingMetricStat(TypedDict, closed=True):
    metric: "capo_application_auto_scaling.types.predictive_scaling_metric.PredictiveScalingMetric"
    """<p> The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object that is returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>. </p>"""
    stat: "capo_application_auto_scaling.types.xml_string.XmlString"
    """<p> The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>. </p> <p>The most commonly used metrics for predictive scaling are <code>Average</code> and <code>Sum</code>.</p>"""
    unit: NotRequired[
        "capo_application_auto_scaling.types.predictive_scaling_metric_unit.PredictiveScalingMetricUnit"
    ]
    """<p> The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a> data type in the <i>Amazon CloudWatch API Reference</i>. </p>"""

metric instance-attribute

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

stat instance-attribute

stat: XmlString

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metrics for predictive scaling are Average and Sum.

unit instance-attribute

unit: NotRequired[PredictiveScalingMetricUnit]

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.