Skip to content

GetMetricDataOutput

Source code in docs_src/capo_cloudwatch/types/get_metric_data_output.py
class GetMetricDataOutput(TypedDict, closed=True):
    metric_data_results: NotRequired[
        "capo_cloudwatch.types.metric_data_results.MetricDataResults"
    ]
    """<p>The metrics that are returned, including the metric name, namespace, and dimensions.</p>"""
    next_token: NotRequired["capo_cloudwatch.types.next_token.NextToken"]
    """<p>A token that marks the next batch of returned results.</p>"""
    messages: NotRequired[
        "capo_cloudwatch.types.metric_data_result_messages.MetricDataResultMessages"
    ]
    """<p>Contains a message about this <code>GetMetricData</code> operation, if the operation results in such a message. An example of a message that might be returned is <code>Maximum number of allowed metrics exceeded</code>. If there is a message, as much of the operation as possible is still executed.</p> <p>A message appears here only if it is related to the global <code>GetMetricData</code> operation. Any message about a specific metric returned by the operation appears in the <code>MetricDataResult</code> object returned for that metric.</p>"""

messages instance-attribute

messages: NotRequired[MetricDataResultMessages]

Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that might be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed.

A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

metric_data_results instance-attribute

metric_data_results: NotRequired[MetricDataResults]

The metrics that are returned, including the metric name, namespace, and dimensions.

next_token instance-attribute

next_token: NotRequired[NextToken]

A token that marks the next batch of returned results.