SetVariableAction setVariable
Sets a variable to a specified value.
SNSTopicPublishAction sns
Sends an Amazon SNS message.
IotTopicPublishAction iotTopicPublish
Publishes an MQTT message with the given topic to the AWS IoT message broker.
SetTimerAction setTimer
Information needed to set the timer.
ClearTimerAction clearTimer
Information needed to clear the timer.
ResetTimerAction resetTimer
Information needed to reset the timer.
LambdaAction lambda
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
IotEventsAction iotEvents
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
SqsAction sqs
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
FirehoseAction firehose
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
DynamoDBAction dynamoDB
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
DynamoDBv2Action dynamoDBv2
Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.
IotSiteWiseAction iotSiteWise
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
String timeInSeconds
The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.
String offsetInNanos
The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can
also specify an expression.
AssetPropertyVariant value
The value to send to an asset property.
AssetPropertyTimestamp timestamp
The timestamp associated with the asset property value. The default is the current event time.
String quality
The quality of the asset property value. The value must be GOOD, BAD, or
UNCERTAIN. You can also specify an expression.
String stringValue
The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.
String integerValue
The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.
String doubleValue
The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.
String booleanValue
The asset property value is a Boolean value that must be TRUE or FALSE. You can also
specify an expression. If you use an expression, the evaluated result should be a Boolean value.
String jsonPath
An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from
the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (
BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value)
specified here are available for use in the condition expressions used by detectors.
Syntax: <field-name>.<field-name>...
String timerName
The name of the timer to clear.
String detectorModelName
The name of the detector model.
DetectorModelDefinition detectorModelDefinition
Information that defines how the detectors operate.
String detectorModelDescription
A brief description of the detector model.
String key
The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
String roleArn
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
List<E> tags
Metadata that can be used to manage the detector model.
String evaluationMethod
Information about the order in which events are evaluated and how actions are executed.
DetectorModelConfiguration detectorModelConfiguration
Information about how the detector model is configured.
String inputName
The name you want to give to the input.
String inputDescription
A brief description of the input.
InputDefinition inputDefinition
The definition of the input.
List<E> tags
Metadata that can be used to manage the input.
InputConfiguration inputConfiguration
Information about the configuration of the input.
String detectorModelName
The name of the detector model to be deleted.
String inputName
The name of the input to delete.
DetectorModel detectorModel
Information about the detector model.
String inputName
The name of the input.
Input input
Information about the input.
LoggingOptions loggingOptions
The current settings of the AWS IoT Events logging options.
DetectorModelDefinition detectorModelDefinition
Information that defines how a detector operates.
DetectorModelConfiguration detectorModelConfiguration
Information about how the detector is configured.
String detectorModelName
The name of the detector model.
String detectorModelVersion
The version of the detector model.
String detectorModelDescription
A brief description of the detector model.
String detectorModelArn
The ARN of the detector model.
String roleArn
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
Date creationTime
The time the detector model was created.
Date lastUpdateTime
The time the detector model was last updated.
String status
The status of the detector model.
String key
The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
String evaluationMethod
Information about the order in which events are evaluated and how actions are executed.
String detectorModelName
The name of the detector model.
String detectorModelVersion
The ID of the detector model version.
String detectorModelArn
The ARN of the detector model version.
String roleArn
The ARN of the role that grants the detector model permission to perform its tasks.
Date creationTime
The time the detector model version was created.
Date lastUpdateTime
The last time the detector model version was updated.
String status
The status of the detector model version.
String evaluationMethod
Information about the order in which events are evaluated and how actions are executed.
String hashKeyType
The data type for the hash key (also called the partition key). You can specify the following values:
STRING - The hash key is a string.
NUMBER - The hash key is a number.
If you don't specify hashKeyType, the default value is STRING.
String hashKeyField
The name of the hash key (also called the partition key).
String hashKeyValue
The value of the hash key (also called the partition key).
String rangeKeyType
The data type for the range key (also called the sort key), You can specify the following values:
STRING - The range key is a string.
NUMBER - The range key is number.
If you don't specify rangeKeyField, the default value is STRING.
String rangeKeyField
The name of the range key (also called the sort key).
String rangeKeyValue
The value of the range key (also called the sort key).
String operation
The type of operation to perform. You can specify the following values:
INSERT - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as
a partition key. If you specified a range key, the item uses the range key as a sort key.
UPDATE - Update an existing item of the DynamoDB table with new data. This item's partition key must
match the specified hash key. If you specified a range key, the range key must match the item's sort key.
DELETE - Delete an existing item of the DynamoDB table. This item's partition key must match the
specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the INSERT operation.
String payloadField
The name of the DynamoDB column that receives the action payload.
If you don't specify this parameter, the name of the DynamoDB column is payload.
String tableName
The name of the DynamoDB table.
Payload payload
String eventName
The name of the event.
String condition
Optional. The Boolean expression that, when TRUE, causes the actions to be performed. If not
present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not
performed (=FALSE).
List<E> actions
The actions to be performed.
String deliveryStreamName
The name of the Kinesis Data Firehose delivery stream where the data is written.
String separator
A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
Payload payload
You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
InputConfiguration inputConfiguration
Information about the configuration of an input.
InputDefinition inputDefinition
The definition of the input.
String inputName
The name of the input.
String inputDescription
A brief description of the input.
String inputArn
The ARN of the input.
Date creationTime
The time the input was created.
Date lastUpdateTime
The last time the input was updated.
String status
The status of the input.
List<E> attributes
The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent
to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and
those attributes (and their paired values) specified here are available for use in the condition
expressions used by detectors that monitor this input.
String inputName
The name of the input.
String inputDescription
A brief description of the input.
String inputArn
The ARN of the input.
Date creationTime
The time the input was created.
Date lastUpdateTime
The last time the input was updated.
String status
The status of the input.
String entryId
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.
String assetId
The ID of the asset that has the specified property. You can specify an expression.
String propertyId
The ID of the asset property. You can specify an expression.
String propertyAlias
The alias of the asset property. You can also specify an expression.
AssetPropertyValue propertyValue
The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
String mqttTopic
The MQTT topic of the message. You can use a string expression that includes variables (
$variable.<variable-name>) and input values (
$input.<input-name>.<path-to-datum>) as the topic string.
Payload payload
You can configure the action payload when you publish a message to an AWS IoT Core topic.
String resourceArn
The ARN of the resource.
String roleArn
The ARN of the role that grants permission to AWS IoT Events to perform logging.
String level
The logging level.
Boolean enabled
If TRUE, logging is enabled for AWS IoT Events.
List<E> detectorDebugOptions
Information that identifies those detector models and their detectors (instances) for which the logging level is given.
String contentExpression
The content of the payload. You can use a string expression that includes quoted strings (
'<string>'), variables ($variable.<variable-name>), input values (
$input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that
contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
String type
The value of the payload type can be either STRING or JSON.
LoggingOptions loggingOptions
The new values of the AWS IoT Events logging options.
String timerName
The name of the timer to reset.
String timerName
The name of the timer.
Integer seconds
The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
String durationExpression
The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (
$variable.<variable-name>), and input values (
$input.<input-name>.<path-to-datum>) as the duration. The range of the duration is
1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration
is rounded down to the nearest whole number.
String queueUrl
The URL of the SQS queue where the data is written.
Boolean useBase64
Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
Payload payload
You can configure the action payload when you send a message to an Amazon SQS queue.
String stateName
The name of the state.
OnInputLifecycle onInput
When an input is received and the condition is TRUE, perform the specified actions.
OnEnterLifecycle onEnter
When entering this state, perform these actions if the condition is TRUE.
OnExitLifecycle onExit
When exiting this state, perform these actions if the specified condition is
TRUE.
String eventName
The name of the transition event.
String condition
Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState
to be entered.
List<E> actions
The actions to be performed.
String nextState
The next state to enter.
String detectorModelName
The name of the detector model that is updated.
DetectorModelDefinition detectorModelDefinition
Information that defines how a detector operates.
String detectorModelDescription
A brief description of the detector model.
String roleArn
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
String evaluationMethod
Information about the order in which events are evaluated and how actions are executed.
DetectorModelConfiguration detectorModelConfiguration
Information about how the detector model is configured.
String inputName
The name of the input you want to update.
String inputDescription
A brief description of the input.
InputDefinition inputDefinition
The definition of the input.
InputConfiguration inputConfiguration
Information about the configuration of the input.
Copyright © 2020. All rights reserved.