You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTEvents::Types::IotSiteWiseAction

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing IotSiteWiseAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  entry_id: "AssetPropertyEntryId",
  asset_id: "AssetId",
  property_id: "AssetPropertyId",
  property_alias: "AssetPropertyAlias",
  property_value: { # required
    value: { # required
      string_value: "AssetPropertyStringValue",
      integer_value: "AssetPropertyIntegerValue",
      double_value: "AssetPropertyDoubleValue",
      boolean_value: "AssetPropertyBooleanValue",
    },
    timestamp: {
      time_in_seconds: "AssetPropertyTimeInSeconds", # required
      offset_in_nanos: "AssetPropertyOffsetInNanos",
    },
    quality: "AssetPropertyQuality",
  },
}

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 specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For parameters that are string data type, you can specify the following options:

  • Use a string. For example, the propertyAlias value can be '/company/windfarm/3/turbine/7/temperature'.

  • Use an expression. For example, the propertyAlias value can be 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature'.

    For more information, see Expressions in the AWS IoT Events Developer Guide.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#asset_id ⇒ String

The ID of the asset that has the specified property. You can specify an expression.

Returns:

  • (String) —

    The ID of the asset that has the specified property.

#entry_id ⇒ 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. You can also specify an expression.

Returns:

  • (String) —

    A unique identifier for this entry.

#property_alias ⇒ String

The alias of the asset property. You can also specify an expression.

Returns:

  • (String) —

    The alias of the asset property.

#property_id ⇒ String

The ID of the asset property. You can specify an expression.

Returns:

  • (String) —

    The ID of the asset property.

#property_value ⇒ Types::AssetPropertyValue

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

Returns: