NAME

Paws::IoTSiteWise::Metric

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::IoTSiteWise::Metric object:

  $service_obj->Method(Att1 => { Expression => $value, ..., Window => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::IoTSiteWise::Metric object:

  $result = $service_obj->Method(...);
  $result->Att1->Expression

DESCRIPTION

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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the AWS IoT SiteWise User Guide.

ATTRIBUTES

REQUIRED Expression => Str

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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.

REQUIRED Variables => ArrayRef[Paws::IoTSiteWise::ExpressionVariable]

The list of variables used in the expression.

REQUIRED Window => Paws::IoTSiteWise::MetricWindow

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>