Boolean enabled
The value must be TRUE or FALSE. If TRUE, you receive a notification when
the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to
NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to
the NORMAL state when the input property value returns to the specified range.
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 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 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 .
SNSTopicPublishAction sns
IotTopicPublishAction iotTopicPublish
LambdaAction lambda
IotEventsAction iotEvents
SqsAction sqs
FirehoseAction firehose
DynamoDBAction dynamoDB
DynamoDBv2Action dynamoDBv2
IotSiteWiseAction iotSiteWise
InitializationConfiguration initializationConfiguration
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
AcknowledgeFlow acknowledgeFlow
Specifies whether to get notified for alarm state changes.
String alarmModelName
The name of the alarm model.
String alarmModelArn
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
String alarmModelVersion
The version of the alarm model.
String roleArn
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
Date creationTime
The time the alarm model was created, in the Unix epoch format.
Date lastUpdateTime
The time the alarm model was last updated, in the Unix epoch format.
String status
The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to
a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model
information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try
again.
String statusMessage
Contains information about the status of the alarm model version.
SimpleRule simpleRule
A rule that compares an input property value to a threshold value with a comparison operator.
String type
The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
supported-actions - You must specify AWS IoT Events supported actions that work with other AWS
services in a supported AWS Region.
service-limits - Resources or API operations can't exceed service quotas (also known as limits).
Update your detector model or request a quota increase.
structure - The detector model must follow a structure that AWS IoT Events supports.
expression-syntax - Your expression must follow the required syntax.
data-type - Data types referenced in the detector model must be compatible.
referenced-data - You must define the data referenced in your detector model before you can use the
data.
referenced-resource - Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
String level
The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
INFO - An information result tells you about a significant field in your detector model. This type
of result usually doesn't require immediate action.
WARNING - A warning result draws special attention to fields that might cause issues for your
detector model. We recommend that you review warnings and take necessary actions before you use your detector
model in production environments. Otherwise, the detector model might not work as expected.
ERROR - An error result notifies you about a problem found in your detector model. You must fix all
errors before you can publish your detector model.
String message
Contains additional information about the analysis result.
List<E> locations
Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
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'.
String stringValue
The asset property value is a string. You must use an expression, and the evaluated result should be a string.
String integerValue
The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
String doubleValue
The asset property value is a double. You must use an expression, and the evaluated result should be a double.
String booleanValue
The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must
use an expression, and 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 alarmModelName
A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.
String alarmModelDescription
A description that tells you what the alarm model detects.
String roleArn
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
List<E> tags
A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.
You can create up to 50 tags for one alarm model.
String key
An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
Integer severity
A non-negative integer that reflects the severity level of the alarm.
AlarmRule alarmRule
Defines when your alarm is invoked.
AlarmNotification alarmNotification
Contains information about one or more notification actions.
AlarmEventActions alarmEventActions
Contains information about one or more alarm actions.
AlarmCapabilities alarmCapabilities
Contains the configuration information of alarm state changes.
Date creationTime
The time the alarm model was created, in the Unix epoch format.
String alarmModelArn
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
String alarmModelVersion
The version of the alarm model.
Date lastUpdateTime
The time the alarm model was last updated, in the Unix epoch format.
String status
The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to
a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model
information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try
again.
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 alarmModelName
The name of the alarm model.
String detectorModelName
The name of the detector model to be deleted.
String inputName
The name of the input to delete.
Date creationTime
The time the alarm model was created, in the Unix epoch format.
String alarmModelArn
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
String alarmModelVersion
The version of the alarm model.
Date lastUpdateTime
The time the alarm model was last updated, in the Unix epoch format.
String status
The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to
a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model
information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try
again.
String statusMessage
Contains information about the status of the alarm model.
String alarmModelName
The name of the alarm model.
String alarmModelDescription
The description of the alarm model.
String roleArn
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
String key
An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
Integer severity
A non-negative integer that reflects the severity level of the alarm.
AlarmRule alarmRule
Defines when your alarm is invoked.
AlarmNotification alarmNotification
Contains information about one or more notification actions.
AlarmEventActions alarmEventActions
Contains information about one or more alarm actions.
AlarmCapabilities alarmCapabilities
Contains the configuration information of alarm state changes.
String analysisId
The ID of the analysis result that you want to retrieve.
String status
The status of the analysis activity. The status can be one of the following values:
RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to
complete.
COMPLETE - AWS IoT Events finished analyzing your detector model.
FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.
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). The hashKeyField value must match the
partition key of the target DynamoDB table.
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). The rangeKeyField value must match the sort
key of the target DynamoDB table.
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. The tableName value must match the table name of the target DynamoDB
table.
Payload payload
String from
The email address that sends emails.
If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.
EmailContent content
Contains the subject and message of an email.
EmailRecipients recipients
Contains the information of one or more recipients who receive the emails.
You must add the users that receive emails to your AWS SSO store.
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.
Boolean disabledOnInitialization
The value must be TRUE or FALSE. If FALSE, all alarm instances created
based on the alarm model are activated. The default value is TRUE.
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.
IotEventsInputIdentifier iotEventsInputIdentifier
The identifier of the input routed to AWS IoT Events.
IotSiteWiseInputIdentifier iotSiteWiseInputIdentifier
The identifer of the input routed from AWS IoT SiteWise.
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 inputName
The name of the input routed to AWS IoT Events.
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.
String assetId
The ID of the asset that has the specified property.
String propertyId
The ID of the asset property.
String propertyAlias
The alias of the asset property.
AssetPropertyValue propertyValue
The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
IotSiteWiseAssetModelPropertyIdentifier iotSiteWiseAssetModelPropertyIdentifier
The identifier of the AWS IoT SiteWise asset model property.
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.
InputIdentifier inputIdentifier
The identifer of the routed input.
Integer maxResults
The maximum number of results to be returned per request.
String nextToken
The token that you can use to return the next set of results.
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.
NotificationTargetActions action
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
List<E> smsConfigurations
Contains the configuration information of SMS notifications.
List<E> emailConfigurations
Contains the configuration information of email notifications.
LambdaAction lambdaAction
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.
SSOIdentity ssoIdentity
The AWS Single Sign-On (AWS SSO) authentication information.
String timerName
The name of the timer to reset.
String name
The name of the routed resource.
String arn
The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
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 inputProperty
The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
String comparisonOperator
The comparison operator.
String threshold
The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
String senderId
The sender ID.
String additionalMessage
The message that you want to send. The message can be up to 200 characters.
List<E> recipients
Specifies one or more recipients who receive the message.
You must add the users that receive SMS messages to your AWS SSO store.
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.
DetectorModelDefinition detectorModelDefinition
String analysisId
The ID that you can use to retrieve the analysis result.
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 alarmModelName
The name of the alarm model.
String alarmModelDescription
The description of the alarm model.
String roleArn
The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
Integer severity
A non-negative integer that reflects the severity level of the alarm.
AlarmRule alarmRule
Defines when your alarm is invoked.
AlarmNotification alarmNotification
Contains information about one or more notification actions.
AlarmEventActions alarmEventActions
Contains information about one or more alarm actions.
AlarmCapabilities alarmCapabilities
Contains the configuration information of alarm state changes.
Date creationTime
The time the alarm model was created, in the Unix epoch format.
String alarmModelArn
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
String alarmModelVersion
The version of the alarm model.
Date lastUpdateTime
The time the alarm model was last updated, in the Unix epoch format.
String status
The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to
a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model
information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try
again.
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 © 2023. All rights reserved.