The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

Summary information about the inputs.

The token that you can use to return the next set of results, or null if there are no more results.

The response's http status code.

Undocumented member.

The ID that you can use to retrieve the analysis result.

The response's http status code.

The new values of the AWS IoT Events logging options.

The ID of the analysis result that you want to retrieve.

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.

The response's http status code.

A brief description of the input.

Metadata that can be used to manage the input.

The name you want to give to the input.

The definition of the input.

Information about the configuration of the input.

The response's http status code.

The ARN of the resource.

The list of tags assigned to the resource.

The response's http status code.

The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

The token that you can use to return the next set of results, or null if there are no more results.

A list that summarizes each alarm model.

The response's http status code.

The name of the alarm model.

The response's http status code.

A non-negative integer that reflects the severity level of the alarm.

Contains information about one or more notification actions.

The description of the alarm model.

Contains information about one or more alarm actions.

Contains the configuration information of alarm state changes.

The name of the alarm model.

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.

Defines when your alarm is invoked.

The time the alarm model was created, in the Unix epoch format.

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.

The time the alarm model was last updated, in the Unix epoch format.

The version of the alarm model.

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

The response's http status code.

A non-negative integer that reflects the severity level of the alarm.

Contains information about one or more notification actions.

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

A description that tells you what the alarm model detects.

Contains information about one or more alarm actions.

Contains the configuration information of alarm state changes.

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.

A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

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.

Defines when your alarm is invoked.

The time the alarm model was created, in the Unix epoch format.

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.

The time the alarm model was last updated, in the Unix epoch format.

The version of the alarm model.

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

The response's http status code.

The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

The ID of the analysis result that you want to retrieve.

The token that you can use to return the next set of results, or null if there are no more results.

Contains information about one or more analysis results.

The response's http status code.

The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

The name of the detector model whose versions are returned.

The token that you can use to return the next set of results, or null if there are no more results.

Summary information about the detector model versions.

The response's http status code.

The version of the alarm model.

The name of the alarm model.

The time the alarm model was created, in the Unix epoch format.

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.

Defines when your alarm is invoked.

The name of the alarm model.

A non-negative integer that reflects the severity level of the alarm.

Contains information about one or more notification actions.

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

Contains information about the status of the alarm model.

The description of the alarm model.

Contains information about one or more alarm actions.

Contains the configuration information of alarm state changes.

The time the alarm model was last updated, in the Unix epoch format.

The version of the alarm model.

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

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.

The response's http status code.

A brief description of the detector model.

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.

Information about the order in which events are evaluated and how actions are executed.

Metadata that can be used to manage the detector model.

The name of the detector model.

Information that defines how the detectors operate.

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Information about how the detector model is configured.

The response's http status code.

The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

The token that you can use to return the next set of results, or null if there are no more results.

Summary information about the detector models.

The response's http status code.

A brief description of the detector model.

Information about the order in which events are evaluated and how actions are executed.

The name of the detector model that is updated.

Information that defines how a detector operates.

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Information about how the detector model is configured.

The response's http status code.

The name of the detector model to be deleted.

The response's http status code.

The name of the input to delete.

The response's http status code.

A brief description of the input.

The name of the input you want to update.

The definition of the input.

Information about the configuration of the input.

The response's http status code.

The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

The name of the alarm model.

A list that summarizes each alarm model version.

The token that you can use to return the next set of results, or null if there are no more results.

The response's http status code.

The ARN of the resource.

The new or modified tags for the resource.

The response's http status code.

The version of the detector model.

The name of the detector model.

Information about the detector model.

The response's http status code.

The name of the input.

Information about the input.

The response's http status code.

The ARN of the resource.

A list of the keys of the tags to be removed from the resource.

The response's http status code.

The token that you can use to return the next set of results.

The maximum number of results to be returned per request.

The identifer of the routed input.

Summary information about the routed resources.

The token that you can use to return the next set of results, or null if there are no more results.

The response's http status code.

The current settings of the AWS IoT Events logging options.

The response's http status code.

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.

Publishes an MQTT message with the given topic to the AWS IoT message broker.

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.

Information needed to reset the timer.

Information needed to set the timer.

Sends an Amazon SNS message.

Information needed to clear the timer.

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.

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

Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .

Sets a variable to a specified value.

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

Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.

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

Undocumented member.

Undocumented member.

Undocumented member.

Undocumented member.

Undocumented member.

Undocumented member.

Undocumented member.

Undocumented member.

Undocumented member.

Specifies whether to get notified for alarm state changes.

Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

Specifies one or more supported actions to receive notifications when the alarm state changes.

The time the alarm model was created, in the Unix epoch format.

The name of the alarm model.

The description of the alarm model.

The time the alarm model was created, in the Unix epoch format.

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.

The name of the alarm model.

Contains information about the status of the alarm model version.

The time the alarm model was last updated, in the Unix epoch format.

The version of the alarm model.

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

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.

Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.

A rule that compares an input property value to a threshold value with a comparison operator.

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.

Contains additional information about the analysis result.

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.

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

A JsonPath expression that identifies the error field in your detector model.

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.

The value to send to an asset property.

The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.

The timestamp associated with the asset property value. The default is the current event time.

The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

The asset property value is a double. You must use an expression, and the evaluated result should be a double.

The asset property value is a string. You must use an expression, and the evaluated result should be a string.

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.

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>...

The name of the timer to clear.

The value of the input attribute key used to create the detector (the instance of the detector model).

The name of the detector model.

Information about how the detector is configured.

Information that defines how a detector operates.

The time the detector model was created.

The status of the detector model.

The name of the detector model.

The ARN of the detector model.

A brief description of the detector model.

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.

The version of the detector model.

The time the detector model was last updated.

Information about the order in which events are evaluated and how actions are executed.

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Information about the states of the detector.

The state that is entered at the creation of each detector (instance).

The time the detector model was created.

The name of the detector model.

A brief description of the detector model.

The time the detector model version was created.

The status of the detector model version.

The name of the detector model.

The ARN of the detector model version.

The ID of the detector model version.

The last time the detector model version was updated.

Information about the order in which events are evaluated and how actions are executed.

The ARN of the role that grants the detector model permission to perform its tasks.

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'.

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.

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'.

Undocumented member.

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.

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

The value of the range key (also called the sort key).

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

The value of the hash key (also called the partition key).

The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.

Undocumented member.

The name of the DynamoDB table.

Contains the subject and message of an email.

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.

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.

The subject of the email.

The message that you want to send. The message can be up to 200 characters.

Specifies one or more recipients who receive the email.

The actions to be performed.

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).

The name of the event.

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).

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

The name of the Kinesis Data Firehose delivery stream where the data is written.

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.

The definition of the input.

Information about the configuration of an input.

A brief description of the input.

The name of the input.

The ARN of the input.

The time the input was created.

The last time the input was updated.

The status of the input.

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.

The identifer of the input routed from AWS IoT SiteWise.

The identifier of the input routed to AWS IoT Events.

The time the input was created.

The status of the input.

The name of the input.

A brief description of the input.

The ARN of the input.

The last time the input was updated.

You can configure the action payload when you send a message to an AWS IoT Events input.

The name of the AWS IoT Events input where the data is sent.

The name of the input routed to AWS IoT Events.

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.

The alias of the asset property.

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

The ID of the asset property.

The ID of the asset that has the specified property.

The ID of the AWS IoT SiteWise asset model.

The ID of the AWS IoT SiteWise asset property.

The identifier of the AWS IoT SiteWise asset model property.

You can configure the action payload when you publish a message to an AWS IoT Core topic.

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.

You can configure the action payload when you send a message to a Lambda function.

The ARN of the Lambda function that is executed.

Information that identifies those detector models and their detectors (instances) for which the logging level is given.

The ARN of the role that grants permission to AWS IoT Events to perform logging.

The logging level.

If TRUE, logging is enabled for AWS IoT Events.

Contains the configuration information of email notifications.

Contains the configuration information of SMS notifications.

Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.

Undocumented member.

Specifies the actions that are performed when the state is entered and the condition is TRUE.

Specifies the actions that are performed when the state is exited and the condition is TRUE.

Specifies the actions performed when the condition evaluates to TRUE.

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

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.

The value of the payload type can be either STRING or JSON.

The AWS Single Sign-On (AWS SSO) authentication information.

The name of the timer to reset.

The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

The name of the routed resource.

The message that you want to send. The message can be up to 200 characters.

The sender ID.

Specifies one or more recipients who receive the message.

You must add the users that receive SMS messages to your AWS SSO store.

You can configure the action payload when you send a message as an Amazon SNS push notification.

The ARN of the Amazon SNS target where the message is sent.

The user ID.

The ID of the AWS SSO identity store.

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.

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

The name of the timer.

The name of the variable.

The new value of the variable.

The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.

The comparison operator.

The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.

You can configure the action payload when you send a message to an Amazon SQS queue.

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.

The URL of the SQS queue where the data is written.

When entering this state, perform these actions if the condition is TRUE.

When an input is received and the condition is TRUE, perform the specified actions.

When exiting this state, perform these actions if the specified condition is TRUE.

The name of the state.

The tag's key.

The tag's value.

The actions to be performed.

The name of the transition event.

Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

The next state to enter.