Skip to content

SummaryMetricQueryResult

Source code in docs_src/capo_iot_wireless/types/summary_metric_query_result.py
class SummaryMetricQueryResult(TypedDict, closed=True):
    query_id: NotRequired["capo_iot_wireless.types.metric_query_id.MetricQueryId"]
    """<p>The ID of the summary metric results query operation.</p>"""
    query_status: NotRequired[
        "capo_iot_wireless.types.metric_query_status.MetricQueryStatus"
    ]
    """<p>The status of the summary metric query result.</p>"""
    error: NotRequired["capo_iot_wireless.types.metric_query_error.MetricQueryError"]
    """<p>The error message for the summary metric query result.</p>"""
    metric_name: NotRequired["capo_iot_wireless.types.metric_name.MetricName"]
    """<p>The name of the summary metric query result.</p>"""
    dimensions: NotRequired["capo_iot_wireless.types.dimensions.Dimensions"]
    """<p>The dimensions of the metric.</p>"""
    aggregation_period: NotRequired[
        "capo_iot_wireless.types.aggregation_period.AggregationPeriod"
    ]
    """<p>The aggregation period of the metric.</p>"""
    start_timestamp: NotRequired[
        "capo_iot_wireless.types.metric_query_start_timestamp.MetricQueryStartTimestamp"
    ]
    """<p>The start timestamp for the summary metric query.</p>"""
    end_timestamp: NotRequired[
        "capo_iot_wireless.types.metric_query_end_timestamp.MetricQueryEndTimestamp"
    ]
    """<p>The end timestamp for the summary metric query.</p>"""
    timestamps: NotRequired[
        "capo_iot_wireless.types.metric_query_timestamps.MetricQueryTimestamps"
    ]
    """<p>The timestamp of each aggregation result.</p>"""
    values: NotRequired["capo_iot_wireless.types.metric_query_values.MetricQueryValues"]
    """<p>The list of aggregated summary metric query results.</p>"""
    unit: NotRequired["capo_iot_wireless.types.metric_unit.MetricUnit"]
    """<p>The units of measurement to be used for interpreting the aggregation result.</p>"""

aggregation_period instance-attribute

aggregation_period: NotRequired[AggregationPeriod]

The aggregation period of the metric.

dimensions instance-attribute

dimensions: NotRequired[Dimensions]

The dimensions of the metric.

end_timestamp instance-attribute

end_timestamp: NotRequired[MetricQueryEndTimestamp]

The end timestamp for the summary metric query.

error instance-attribute

error: NotRequired[MetricQueryError]

The error message for the summary metric query result.

metric_name instance-attribute

metric_name: NotRequired[MetricName]

The name of the summary metric query result.

query_id instance-attribute

query_id: NotRequired[MetricQueryId]

The ID of the summary metric results query operation.

query_status instance-attribute

query_status: NotRequired[MetricQueryStatus]

The status of the summary metric query result.

start_timestamp instance-attribute

start_timestamp: NotRequired[MetricQueryStartTimestamp]

The start timestamp for the summary metric query.

timestamps instance-attribute

timestamps: NotRequired[MetricQueryTimestamps]

The timestamp of each aggregation result.

unit instance-attribute

unit: NotRequired[MetricUnit]

The units of measurement to be used for interpreting the aggregation result.

values instance-attribute

values: NotRequired[MetricQueryValues]

The list of aggregated summary metric query results.