Metric - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Metric

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

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

Contents

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 Amazon IoT SiteWise User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

variables

The list of variables used in the expression.

Type: Array of ExpressionVariable objects

Required: Yes

window

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

Type: MetricWindow object

Required: Yes

processingConfig

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

Type: MetricProcessingConfig object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: