Struct aws_sdk_iotevents::types::IotSiteWiseAction

#[non_exhaustive]
pub struct IotSiteWiseAction {
    pub entry_id: Option<String>,
    pub asset_id: Option<String>,
    pub property_id: Option<String>,
    pub property_alias: Option<String>,
    pub property_value: Option<AssetPropertyValue>,
}

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 in the AWS IoT Events Developer Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entry_id: Option<String>

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.

asset_id: Option<String>

The ID of the asset that has the specified property.

property_id: Option<String>

The ID of the asset property.

property_alias: Option<String>

The alias of the asset property.

property_value: Option<AssetPropertyValue>

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

Implementations

impl IotSiteWiseAction

pub fn entry_id(&self) -> Option<&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.

pub fn asset_id(&self) -> Option<&str>

The ID of the asset that has the specified property.

pub fn property_id(&self) -> Option<&str>

The ID of the asset property.

pub fn property_alias(&self) -> Option<&str>

The alias of the asset property.

pub fn property_value(&self) -> Option<&AssetPropertyValue>

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

impl IotSiteWiseAction

pub fn builder() -> IotSiteWiseActionBuilder

Creates a new builder-style object to manufacture IotSiteWiseAction.

Trait Implementations

impl Clone for IotSiteWiseAction

fn clone(&self) -> IotSiteWiseAction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IotSiteWiseAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for IotSiteWiseAction

fn eq(&self, other: &IotSiteWiseAction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IotSiteWiseAction