Skip to content

/AWS1/CL_IOEALARMACTION

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

CONSTRUCTOR

IMPORTING

Optional arguments:

io_sns TYPE REF TO /AWS1/CL_IOESNSTOPICPUBACTION /AWS1/CL_IOESNSTOPICPUBACTION

Information required to publish the Amazon SNS message.

io_iottopicpublish TYPE REF TO /AWS1/CL_IOEIOTTOPICPUBACTION /AWS1/CL_IOEIOTTOPICPUBACTION

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

io_lambda TYPE REF TO /AWS1/CL_IOELAMBDAACTION /AWS1/CL_IOELAMBDAACTION

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

io_iotevents TYPE REF TO /AWS1/CL_IOEIOTEVENTSACTION /AWS1/CL_IOEIOTEVENTSACTION

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

io_sqs TYPE REF TO /AWS1/CL_IOESQSACTION /AWS1/CL_IOESQSACTION

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

io_firehose TYPE REF TO /AWS1/CL_IOEFIREHOSEACTION /AWS1/CL_IOEFIREHOSEACTION

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

io_dynamodb TYPE REF TO /AWS1/CL_IOEDYNAMODBACTION /AWS1/CL_IOEDYNAMODBACTION

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.

    '${$input.GreenhouseInput.temperature * 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 _raw.

io_dynamodbv2 TYPE REF TO /AWS1/CL_IOEDYNAMODBV2ACTION /AWS1/CL_IOEDYNAMODBV2ACTION

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.

    '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.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.

io_iotsitewise TYPE REF TO /AWS1/CL_IOEIOTSITEWISEACTION /AWS1/CL_IOEIOTSITEWISEACTION

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.

Queryable Attributes

sns

Information required to publish the Amazon SNS message.

Accessible with the following methods

Method Description
GET_SNS() Getter for SNS

iotTopicPublish

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

Accessible with the following methods

Method Description
GET_IOTTOPICPUBLISH() Getter for IOTTOPICPUBLISH

lambda

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

Accessible with the following methods

Method Description
GET_LAMBDA() Getter for LAMBDA

iotEvents

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

Accessible with the following methods

Method Description
GET_IOTEVENTS() Getter for IOTEVENTS

sqs

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

Accessible with the following methods

Method Description
GET_SQS() Getter for SQS

firehose

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

Accessible with the following methods

Method Description
GET_FIREHOSE() Getter for FIREHOSE

dynamoDB

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.

    '${$input.GreenhouseInput.temperature * 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 _raw.

Accessible with the following methods

Method Description
GET_DYNAMODB() Getter for DYNAMODB

dynamoDBv2

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.

    '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.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.

Accessible with the following methods

Method Description
GET_DYNAMODBV2() Getter for DYNAMODBV2

iotSiteWise

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.

Accessible with the following methods

Method Description
GET_IOTSITEWISE() Getter for IOTSITEWISE

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ALARMACTIONS

TYPES TT_ALARMACTIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_IOEALARMACTION WITH DEFAULT KEY
.