/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::IoTEvents::IotSiteWiseAction

NAME

Paws::IoTEvents::IotSiteWiseAction

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::IoTEvents::IotSiteWiseAction object:

$service_obj->Method(Att1 => { AssetId => $value, ..., PropertyValue => $value  });

Results returned from an API call

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

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

DESCRIPTION

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

  • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the propertyAlias parameter uses a substitution template.

    'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the AWS IoT Events Developer Guide.

ATTRIBUTES

AssetId => Str

The ID of the asset that has the specified property.

EntryId => Str

A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

PropertyAlias => Str

The alias of the asset property.

PropertyId => Str

The ID of the asset property.

PropertyValue => Paws::IoTEvents::AssetPropertyValue

The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::IoTEvents

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