Skip to content

MetricDataResult

Source code in docs_src/capo_cloudwatch/types/metric_data_result.py
class MetricDataResult(TypedDict, closed=True):
    id: NotRequired["capo_cloudwatch.types.metric_id.MetricId"]
    """<p>The short name you specified to represent this metric.</p>"""
    label: NotRequired["capo_cloudwatch.types.metric_label.MetricLabel"]
    """<p>The human-readable label associated with the data.</p>"""
    timestamps: NotRequired["capo_cloudwatch.types.timestamps.Timestamps"]
    """<p>The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].</p>"""
    values: NotRequired["capo_cloudwatch.types.datapoint_values.DatapointValues"]
    """<p>The data points for the metric corresponding to <code>Timestamps</code>. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].</p>"""
    status_code: NotRequired["capo_cloudwatch.types.status_code.StatusCode"]
    """<p>The status of the returned data. <code>Complete</code> indicates that all data points in the requested time range were returned. <code>PartialData</code> means that an incomplete set of data points were returned. You can use the <code>NextToken</code> value that was returned and repeat your request to get more data points. <code>NextToken</code> is not returned if you are performing a math expression. <code>InternalError</code> indicates that an error occurred. Retry your request using <code>NextToken</code>, if present.</p>"""
    messages: NotRequired[
        "capo_cloudwatch.types.metric_data_result_messages.MetricDataResultMessages"
    ]
    """<p>A list of messages with additional information about the data returned.</p>"""

id instance-attribute

id: NotRequired[MetricId]

The short name you specified to represent this metric.

label instance-attribute

label: NotRequired[MetricLabel]

The human-readable label associated with the data.

messages instance-attribute

messages: NotRequired[MetricDataResultMessages]

A list of messages with additional information about the data returned.

status_code instance-attribute

status_code: NotRequired[StatusCode]

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

timestamps instance-attribute

timestamps: NotRequired[Timestamps]

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

values instance-attribute

values: NotRequired[DatapointValues]

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].