AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

Note:

When making an API call, you may pass IotSiteWiseAction data as a hash:

{
  entry_id: "AssetPropertyEntryId",
  asset_id: "AssetId",
  property_id: "AssetPropertyId",
  property_alias: "AssetPropertyAlias",
  property_value: {
    value: {
      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 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_idString

The ID of the asset that has the specified property.

Returns:

  • (String)


3978
3979
3980
3981
3982
3983
3984
3985
3986
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3978

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

#entry_idString

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)


3978
3979
3980
3981
3982
3983
3984
3985
3986
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3978

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

#property_aliasString

The alias of the asset property.

Returns:

  • (String)


3978
3979
3980
3981
3982
3983
3984
3985
3986
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3978

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

#property_idString

The ID of the asset property.

Returns:

  • (String)


3978
3979
3980
3981
3982
3983
3984
3985
3986
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3978

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

#property_valueTypes::AssetPropertyValue

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



3978
3979
3980
3981
3982
3983
3984
3985
3986
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 3978

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