Class: Aws::IoTEvents::Types::AlarmAction

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

Overview

Specifies one of the following actions to receive notifications when the alarm state changes.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dynamo_d_bv_2 ⇒ Types::DynamoDBv2Action

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload]. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in ‘DynamoDBv2Action`. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the ‘tableName` parameter can be `’GreenhouseTemperatureTable’‘.

  • For references, you must specify either variables or input values. For example, the value for the ‘tableName` parameter can be `$variable.ddbtableName`.

  • 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 ‘contentExpression` parameter in `Payload` uses a substitution template.

    ‘’“${$input.GreenhouseInput.sensor_id”, “temperature”: “$* 9 / 5 + 32”}‘`

  • For a string concatenation, you must use ‘+`. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the ‘tableName` parameter uses a string concatenation.

    ‘’GreenhouseTemperatureTable ‘ + $input.GreenhouseInput.date`

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

The value for the ‘type` parameter in `Payload` must be `JSON`.

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html [2]: docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#dynamo_db ⇒ Types::DynamoDBAction

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload]. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in ‘DynamoDBAction`. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the ‘hashKeyType` parameter can be `’STRING’‘.

  • For references, you must specify either variables or input values. For example, the value for the ‘hashKeyField` parameter can be `$input.GreenhouseInput.name`.

  • 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 ‘hashKeyValue` parameter uses a substitution template.

    ‘’$* 6 / 5 + 32 in Fahrenheit’‘

  • For a string concatenation, you must use ‘+`. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the ‘tableName` parameter uses a string concatenation.

    ‘’GreenhouseTemperatureTable ‘ + $input.GreenhouseInput.date`

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

If the defined payload type is a string, ‘DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw`.

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html [2]: docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#firehose ⇒ Types::FirehoseAction

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#iot_events ⇒ Types::IotEventsAction

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#iot_site_wise ⇒ Types::IotSiteWiseAction

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/$Aws::IoTEvents::Types::AlarmAction.$input$input.TemperatureInput$input.TemperatureInput.sensorData$input.TemperatureInput.sensorData.windfarmID/turbine/ $Aws::IoTEvents::Types::AlarmAction.$input$input.TemperatureInput$input.TemperatureInput.sensorData$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*.

[1]: docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#iot_topic_publish ⇒ Types::IotTopicPublishAction

Information required to publish the MQTT message through the AWS IoT message broker.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#lambda ⇒ Types::LambdaAction

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#sns ⇒ Types::SNSTopicPublishAction

Information required to publish the Amazon SNS message.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end

#sqs ⇒ Types::SqsAction

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Returns:



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-iotevents/types.rb', line 316

class AlarmAction < Struct.new(
  :sns,
  :iot_topic_publish,
  :lambda,
  :iot_events,
  :sqs,
  :firehose,
  :dynamo_db,
  :dynamo_d_bv_2,
  :iot_site_wise)
  SENSITIVE = []
  include Aws::Structure
end