Skip to content

aws.iotevents.describe_detector_model

Example SQL Queries

SELECT * FROM
aws.iotevents.describe_detector_model
WHERE
"detector_model_name" = 'VALUE';

Description

Describes a detector model. If the version parameter is not specified, information about the latest version is returned.

Table Definition

Column NameColumn Data Type
detector_model_name Required Input Column

The name of the detector model.

VARCHAR
detector_model_version Input Column

The version of the detector model.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
detector_model

Information about the detector model.

STRUCT(
"detector_model_definition" STRUCT(
"states" STRUCT(
"state_name" VARCHAR,
"on_input" STRUCT(
"events" STRUCT(
"event_name" VARCHAR,
"condition" VARCHAR,
"actions" STRUCT(
"set_variable" STRUCT(
"variable_name" VARCHAR,
"value" VARCHAR
),
"sns" STRUCT(
"target_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_topic_publish" STRUCT(
"mqtt_topic" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"set_timer" STRUCT(
"timer_name" VARCHAR,
"seconds" BIGINT,
"duration_expression" VARCHAR
),
"clear_timer" STRUCT(
"timer_name" VARCHAR
),
"reset_timer" STRUCT(
"timer_name" VARCHAR
),
"lambda" STRUCT(
"function_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_events" STRUCT(
"input_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"sqs" STRUCT(
"queue_url" VARCHAR,
"use_base64" BOOLEAN,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"firehose" STRUCT(
"delivery_stream_name" VARCHAR,
"separator" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_db" STRUCT(
"hash_key_type" VARCHAR,
"hash_key_field" VARCHAR,
"hash_key_value" VARCHAR,
"range_key_type" VARCHAR,
"range_key_field" VARCHAR,
"range_key_value" VARCHAR,
"operation" VARCHAR,
"payload_field" VARCHAR,
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_d_bv2" STRUCT(
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_site_wise" STRUCT(
"entry_id" VARCHAR,
"asset_id" VARCHAR,
"property_id" VARCHAR,
"property_alias" VARCHAR,
"property_value" STRUCT(
"value" STRUCT(
"string_value" VARCHAR,
"integer_value" VARCHAR,
"double_value" VARCHAR,
"boolean_value" VARCHAR
),
"timestamp" STRUCT(
"time_in_seconds" VARCHAR,
"offset_in_nanos" VARCHAR
),
"quality" VARCHAR
)
)
)[]
)[],
"transition_events" STRUCT(
"event_name" VARCHAR,
"condition" VARCHAR,
"actions" STRUCT(
"set_variable" STRUCT(
"variable_name" VARCHAR,
"value" VARCHAR
),
"sns" STRUCT(
"target_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_topic_publish" STRUCT(
"mqtt_topic" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"set_timer" STRUCT(
"timer_name" VARCHAR,
"seconds" BIGINT,
"duration_expression" VARCHAR
),
"clear_timer" STRUCT(
"timer_name" VARCHAR
),
"reset_timer" STRUCT(
"timer_name" VARCHAR
),
"lambda" STRUCT(
"function_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_events" STRUCT(
"input_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"sqs" STRUCT(
"queue_url" VARCHAR,
"use_base64" BOOLEAN,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"firehose" STRUCT(
"delivery_stream_name" VARCHAR,
"separator" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_db" STRUCT(
"hash_key_type" VARCHAR,
"hash_key_field" VARCHAR,
"hash_key_value" VARCHAR,
"range_key_type" VARCHAR,
"range_key_field" VARCHAR,
"range_key_value" VARCHAR,
"operation" VARCHAR,
"payload_field" VARCHAR,
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_d_bv2" STRUCT(
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_site_wise" STRUCT(
"entry_id" VARCHAR,
"asset_id" VARCHAR,
"property_id" VARCHAR,
"property_alias" VARCHAR,
"property_value" STRUCT(
"value" STRUCT(
"string_value" VARCHAR,
"integer_value" VARCHAR,
"double_value" VARCHAR,
"boolean_value" VARCHAR
),
"timestamp" STRUCT(
"time_in_seconds" VARCHAR,
"offset_in_nanos" VARCHAR
),
"quality" VARCHAR
)
)
)[],
"next_state" VARCHAR
)[]
),
"on_enter" STRUCT(
"events" STRUCT(
"event_name" VARCHAR,
"condition" VARCHAR,
"actions" STRUCT(
"set_variable" STRUCT(
"variable_name" VARCHAR,
"value" VARCHAR
),
"sns" STRUCT(
"target_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_topic_publish" STRUCT(
"mqtt_topic" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"set_timer" STRUCT(
"timer_name" VARCHAR,
"seconds" BIGINT,
"duration_expression" VARCHAR
),
"clear_timer" STRUCT(
"timer_name" VARCHAR
),
"reset_timer" STRUCT(
"timer_name" VARCHAR
),
"lambda" STRUCT(
"function_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_events" STRUCT(
"input_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"sqs" STRUCT(
"queue_url" VARCHAR,
"use_base64" BOOLEAN,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"firehose" STRUCT(
"delivery_stream_name" VARCHAR,
"separator" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_db" STRUCT(
"hash_key_type" VARCHAR,
"hash_key_field" VARCHAR,
"hash_key_value" VARCHAR,
"range_key_type" VARCHAR,
"range_key_field" VARCHAR,
"range_key_value" VARCHAR,
"operation" VARCHAR,
"payload_field" VARCHAR,
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_d_bv2" STRUCT(
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_site_wise" STRUCT(
"entry_id" VARCHAR,
"asset_id" VARCHAR,
"property_id" VARCHAR,
"property_alias" VARCHAR,
"property_value" STRUCT(
"value" STRUCT(
"string_value" VARCHAR,
"integer_value" VARCHAR,
"double_value" VARCHAR,
"boolean_value" VARCHAR
),
"timestamp" STRUCT(
"time_in_seconds" VARCHAR,
"offset_in_nanos" VARCHAR
),
"quality" VARCHAR
)
)
)[]
)[]
),
"on_exit" STRUCT(
"events" STRUCT(
"event_name" VARCHAR,
"condition" VARCHAR,
"actions" STRUCT(
"set_variable" STRUCT(
"variable_name" VARCHAR,
"value" VARCHAR
),
"sns" STRUCT(
"target_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_topic_publish" STRUCT(
"mqtt_topic" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"set_timer" STRUCT(
"timer_name" VARCHAR,
"seconds" BIGINT,
"duration_expression" VARCHAR
),
"clear_timer" STRUCT(
"timer_name" VARCHAR
),
"reset_timer" STRUCT(
"timer_name" VARCHAR
),
"lambda" STRUCT(
"function_arn" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_events" STRUCT(
"input_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"sqs" STRUCT(
"queue_url" VARCHAR,
"use_base64" BOOLEAN,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"firehose" STRUCT(
"delivery_stream_name" VARCHAR,
"separator" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_db" STRUCT(
"hash_key_type" VARCHAR,
"hash_key_field" VARCHAR,
"hash_key_value" VARCHAR,
"range_key_type" VARCHAR,
"range_key_field" VARCHAR,
"range_key_value" VARCHAR,
"operation" VARCHAR,
"payload_field" VARCHAR,
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"dynamo_d_bv2" STRUCT(
"table_name" VARCHAR,
"payload" STRUCT(
"content_expression" VARCHAR,
"type" VARCHAR
)
),
"iot_site_wise" STRUCT(
"entry_id" VARCHAR,
"asset_id" VARCHAR,
"property_id" VARCHAR,
"property_alias" VARCHAR,
"property_value" STRUCT(
"value" STRUCT(
"string_value" VARCHAR,
"integer_value" VARCHAR,
"double_value" VARCHAR,
"boolean_value" VARCHAR
),
"timestamp" STRUCT(
"time_in_seconds" VARCHAR,
"offset_in_nanos" VARCHAR
),
"quality" VARCHAR
)
)
)[]
)[]
)
)[],
"initial_state_name" VARCHAR
),
"detector_model_configuration" STRUCT(
"detector_model_name" VARCHAR,
"detector_model_version" VARCHAR,
"detector_model_description" VARCHAR,
"detector_model_arn" VARCHAR,
"role_arn" VARCHAR,
"creation_time" TIMESTAMP_S,
"last_update_time" TIMESTAMP_S,
"status" VARCHAR,
"key" VARCHAR,
"evaluation_method" VARCHAR
)
)
Show child fields
detector_model.detector_model_configuration

Information about how the detector is configured.

Show child fields
detector_model.detector_model_configuration.creation_time

The time the detector model was created.

detector_model.detector_model_configuration.detector_model_arn

The ARN of the detector model.

detector_model.detector_model_configuration.detector_model_description

A brief description of the detector model.

detector_model.detector_model_configuration.detector_model_name

The name of the detector model.

detector_model.detector_model_configuration.detector_model_version

The version of the detector model.

detector_model.detector_model_configuration.evaluation_method

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

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

detector_model.detector_model_configuration.last_update_time

The time the detector model was last updated.

detector_model.detector_model_configuration.role_arn

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

detector_model.detector_model_configuration.status

The status of the detector model.

detector_model.detector_model_definition

Information that defines how a detector operates.

Show child fields
detector_model.detector_model_definition.initial_state_name

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

detector_model.detector_model_definition.states[]
Show child fields
detector_model.detector_model_definition.states[].on_enter

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[]
Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[]
Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].clear_timer

Information needed to clear the timer.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].clear_timer.timer_name

The name of the timer to clear.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_d_bv2

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.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_d_bv2.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_d_bv2.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_d_bv2.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_d_bv2.table_name

The name of the DynamoDB table.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db

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.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.hash_key_field

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.hash_key_type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.hash_key_value

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.payload_field

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.range_key_field

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.range_key_type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.range_key_value

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].dynamo_db.table_name

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].firehose

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].firehose.delivery_stream_name

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].firehose.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].firehose.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].firehose.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].firehose.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).

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_events

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_events.input_name

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_events.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_events.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_events.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.asset_id

The ID of the asset that has the specified property.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.entry_id

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_alias

The alias of the asset property.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_id

The ID of the asset property.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.quality

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.timestamp

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.timestamp.offset_in_nanos

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.timestamp.time_in_seconds

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.value

The value to send to an asset property.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.value.boolean_value

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.value.double_value

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.value.integer_value

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_site_wise.property_value.value.string_value

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_topic_publish

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_topic_publish.mqtt_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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_topic_publish.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_topic_publish.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].iot_topic_publish.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].lambda

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].lambda.function_arn

The ARN of the Lambda function that is executed.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].lambda.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].lambda.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].lambda.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].reset_timer

Information needed to reset the timer.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].reset_timer.timer_name

The name of the timer to reset.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_timer

Information needed to set the timer.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_timer.duration_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_timer.seconds

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_timer.timer_name

The name of the timer.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_variable

Sets a variable to a specified value.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_variable.value

The new value of the variable.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].set_variable.variable_name

The name of the variable.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sns

Sends an Amazon SNS message.

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].sns.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].sns.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sns.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sns.target_arn

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sqs

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].sqs.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_enter.events[].actions[].sqs.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sqs.payload.type

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sqs.queue_url

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

detector_model.detector_model_definition.states[].on_enter.events[].actions[].sqs.use_base64

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.

detector_model.detector_model_definition.states[].on_enter.events[].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).

detector_model.detector_model_definition.states[].on_enter.events[].event_name

The name of the event.

detector_model.detector_model_definition.states[].on_exit

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[]
Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[]
Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].clear_timer

Information needed to clear the timer.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].clear_timer.timer_name

The name of the timer to clear.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_d_bv2

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.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_d_bv2.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_d_bv2.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_d_bv2.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_d_bv2.table_name

The name of the DynamoDB table.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db

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.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.hash_key_field

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.hash_key_type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.hash_key_value

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.payload_field

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.range_key_field

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.range_key_type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.range_key_value

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].dynamo_db.table_name

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].firehose

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].firehose.delivery_stream_name

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].firehose.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].firehose.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].firehose.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].firehose.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).

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_events

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_events.input_name

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_events.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_events.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_events.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.asset_id

The ID of the asset that has the specified property.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.entry_id

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_alias

The alias of the asset property.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_id

The ID of the asset property.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.quality

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.timestamp

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.timestamp.offset_in_nanos

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.timestamp.time_in_seconds

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.value

The value to send to an asset property.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.value.boolean_value

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.value.double_value

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.value.integer_value

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_site_wise.property_value.value.string_value

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_topic_publish

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_topic_publish.mqtt_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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_topic_publish.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_topic_publish.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].iot_topic_publish.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].lambda

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].lambda.function_arn

The ARN of the Lambda function that is executed.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].lambda.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].lambda.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].lambda.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].reset_timer

Information needed to reset the timer.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].reset_timer.timer_name

The name of the timer to reset.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_timer

Information needed to set the timer.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_timer.duration_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_timer.seconds

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_timer.timer_name

The name of the timer.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_variable

Sets a variable to a specified value.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_variable.value

The new value of the variable.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].set_variable.variable_name

The name of the variable.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sns

Sends an Amazon SNS message.

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].sns.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].sns.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sns.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sns.target_arn

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sqs

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].sqs.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_exit.events[].actions[].sqs.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sqs.payload.type

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sqs.queue_url

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

detector_model.detector_model_definition.states[].on_exit.events[].actions[].sqs.use_base64

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.

detector_model.detector_model_definition.states[].on_exit.events[].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).

detector_model.detector_model_definition.states[].on_exit.events[].event_name

The name of the event.

detector_model.detector_model_definition.states[].on_input

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[]
Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[]
Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].clear_timer

Information needed to clear the timer.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].clear_timer.timer_name

The name of the timer to clear.

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_d_bv2

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.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_d_bv2.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_d_bv2.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_d_bv2.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_d_bv2.table_name

The name of the DynamoDB table.

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db

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.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.hash_key_field

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.hash_key_type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.hash_key_value

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.payload_field

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.range_key_field

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.range_key_type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.range_key_value

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].dynamo_db.table_name

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].firehose

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].firehose.delivery_stream_name

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].firehose.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].firehose.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].firehose.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].firehose.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).

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_events

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_events.input_name

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_events.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_events.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_events.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.asset_id

The ID of the asset that has the specified property.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.entry_id

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_alias

The alias of the asset property.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_id

The ID of the asset property.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.quality

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.timestamp

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.timestamp.offset_in_nanos

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.timestamp.time_in_seconds

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.value

The value to send to an asset property.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.value.boolean_value

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.value.double_value

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.value.integer_value

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_site_wise.property_value.value.string_value

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_topic_publish

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_topic_publish.mqtt_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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_topic_publish.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_topic_publish.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].iot_topic_publish.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].lambda

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].lambda.function_arn

The ARN of the Lambda function that is executed.

detector_model.detector_model_definition.states[].on_input.events[].actions[].lambda.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].lambda.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].lambda.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].reset_timer

Information needed to reset the timer.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].reset_timer.timer_name

The name of the timer to reset.

detector_model.detector_model_definition.states[].on_input.events[].actions[].set_timer

Information needed to set the timer.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].set_timer.duration_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].set_timer.seconds

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].set_timer.timer_name

The name of the timer.

detector_model.detector_model_definition.states[].on_input.events[].actions[].set_variable

Sets a variable to a specified value.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].set_variable.value

The new value of the variable.

detector_model.detector_model_definition.states[].on_input.events[].actions[].set_variable.variable_name

The name of the variable.

detector_model.detector_model_definition.states[].on_input.events[].actions[].sns

Sends an Amazon SNS message.

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].sns.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].sns.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].sns.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].sns.target_arn

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].sqs

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].sqs.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.events[].actions[].sqs.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.events[].actions[].sqs.payload.type

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].sqs.queue_url

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

detector_model.detector_model_definition.states[].on_input.events[].actions[].sqs.use_base64

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.

detector_model.detector_model_definition.states[].on_input.events[].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).

detector_model.detector_model_definition.states[].on_input.events[].event_name

The name of the event.

detector_model.detector_model_definition.states[].on_input.transition_events[]
Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[]
Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].clear_timer

Information needed to clear the timer.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].clear_timer.timer_name

The name of the timer to clear.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_d_bv2

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.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_d_bv2.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_d_bv2.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_d_bv2.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_d_bv2.table_name

The name of the DynamoDB table.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db

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.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.hash_key_field

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.hash_key_type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.hash_key_value

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.payload_field

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.range_key_field

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.range_key_type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.range_key_value

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].dynamo_db.table_name

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].firehose

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].firehose.delivery_stream_name

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].firehose.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].firehose.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].firehose.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].firehose.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).

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_events

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_events.input_name

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_events.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_events.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_events.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.asset_id

The ID of the asset that has the specified property.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.entry_id

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_alias

The alias of the asset property.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_id

The ID of the asset property.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.quality

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.timestamp

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.timestamp.offset_in_nanos

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.timestamp.time_in_seconds

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.value

The value to send to an asset property.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.value.boolean_value

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.value.double_value

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.value.integer_value

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_site_wise.property_value.value.string_value

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_topic_publish

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_topic_publish.mqtt_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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_topic_publish.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_topic_publish.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].iot_topic_publish.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].lambda

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].lambda.function_arn

The ARN of the Lambda function that is executed.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].lambda.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].lambda.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].lambda.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].reset_timer

Information needed to reset the timer.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].reset_timer.timer_name

The name of the timer to reset.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_timer

Information needed to set the timer.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_timer.duration_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_timer.seconds

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_timer.timer_name

The name of the timer.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_variable

Sets a variable to a specified value.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_variable.value

The new value of the variable.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].set_variable.variable_name

The name of the variable.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sns

Sends an Amazon SNS message.

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sns.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sns.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sns.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sns.target_arn

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sqs

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sqs.payload

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

Show child fields
detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sqs.payload.content_expression

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sqs.payload.type

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sqs.queue_url

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

detector_model.detector_model_definition.states[].on_input.transition_events[].actions[].sqs.use_base64

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.

detector_model.detector_model_definition.states[].on_input.transition_events[].condition

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

detector_model.detector_model_definition.states[].on_input.transition_events[].event_name

The name of the transition event.

detector_model.detector_model_definition.states[].on_input.transition_events[].next_state

The next state to enter.

detector_model.detector_model_definition.states[].state_name

The name of the state.