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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_id ⇒ String

The ID of the asset that has the specified property.

Returns:

  • (String) 


2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2093

class IotSiteWiseAction < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :property_value)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2093

class IotSiteWiseAction < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :property_value)
  SENSITIVE = []
  include Aws::Structure
end

#property_alias ⇒ String

The alias of the asset property.

Returns:

  • (String) 


2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2093

class IotSiteWiseAction < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :property_value)
  SENSITIVE = []
  include Aws::Structure
end

#property_id ⇒ String

The ID of the asset property.

Returns:

  • (String) 


2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2093

class IotSiteWiseAction < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :property_value)
  SENSITIVE = []
  include Aws::Structure
end

#property_value ⇒ Types::AssetPropertyValue

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

Returns:



2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 2093

class IotSiteWiseAction < Struct.new(
  :entry_id,
  :asset_id,
  :property_id,
  :property_alias,
  :property_value)
  SENSITIVE = []
  include Aws::Structure
end