Skip to content

Metric

Source code in docs_src/capo_iotsitewise/types/metric.py 
16
17
18
19
20
21
22
23
24
25
26
class Metric(TypedDict, closed=True):
    expression: "capo_iotsitewise.types.expression.Expression"
    """<p>The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    variables: "capo_iotsitewise.types.expression_variables.ExpressionVariables"
    """<p>The list of variables used in the expression.</p>"""
    window: "capo_iotsitewise.types.metric_window.MetricWindow"
    """<p>The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per <code>window</code>.</p>"""
    processing_config: NotRequired[
        "capo_iotsitewise.types.metric_processing_config.MetricProcessingConfig"
    ]
    """<p>The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.</p>"""

expression instance-attribute 

expression: Expression

The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

For more information, see Quotas in the IoT SiteWise User Guide.

processing_config instance-attribute 

processing_config: NotRequired[MetricProcessingConfig]

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

variables instance-attribute 

variables: ExpressionVariables

The list of variables used in the expression.

window instance-attribute 

window: MetricWindow

The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.