PredictiveScalingMetricDataQuery ¶

class PredictiveScalingMetricDataQuery(TypedDict, closed=True):
    id: "capo_application_auto_scaling.types.id.Id"
    """<p> A short name that identifies the object's results in the response. This name must be unique among all <code>MetricDataQuery</code> objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter. </p>"""
    expression: NotRequired["capo_application_auto_scaling.types.expression.Expression"]
    """<p> The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other expressions to use the result of those expressions. </p> <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>"""
    metric_stat: NotRequired[
        "capo_application_auto_scaling.types.predictive_scaling_metric_stat.PredictiveScalingMetricStat"
    ]
    """<p> Information about the metric data to return. </p> <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>"""
    label: NotRequired["capo_application_auto_scaling.types.xml_string.XmlString"]
    """<p> A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. </p>"""
    return_data: NotRequired[
        "capo_application_auto_scaling.types.return_data.ReturnData"
    ]
    """<p> Indicates whether to return the timestamps and raw data values of this metric. </p> <p>If you use any math expressions, specify <code>true</code> for this value for only the final math expression that the metric specification is based on. You must specify <code>false</code> for <code>ReturnData</code> for all the other metrics and expressions used in the metric specification.</p> <p>If you are only retrieving metrics and not performing any math expressions, do not specify anything for <code>ReturnData</code>. This sets it to its default (<code>true</code>).</p>"""