Skip to content
AWS for Query.Farm

aws.iotevents.describe_alarm_model

Example SQL Queries

SELECT * FROM
aws.iotevents.describe_alarm_model
WHERE
"alarm_model_name" = 'VALUE';

Description

Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

Table Definition

Column NameColumn Data Type
alarm_model_name Required Input Column

The name of the alarm model.

VARCHAR
alarm_model_version Input Column

The version of the alarm 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
alarm_capabilities

Contains the configuration information of alarm state changes.

STRUCT(
    "initialization_configuration" STRUCT(
        "disabled_on_initialization" BOOLEAN
    ),
    "acknowledge_flow" STRUCT(
        "enabled" BOOLEAN
    )
)
Show child fields
alarm_capabilities.acknowledge_flow

Specifies whether to get notified for alarm state changes.

Show child fields
alarm_capabilities.acknowledge_flow.enabled

The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.

alarm_capabilities.initialization_configuration

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

Show child fields
alarm_capabilities.initialization_configuration.disabled_on_initialization

The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE.

alarm_event_actions

Contains information about one or more alarm actions.

STRUCT(
    "alarm_actions" STRUCT(
        "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
            )
        ),
        "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
            )
        )
    )[]
)
Show child fields
alarm_event_actions.alarm_actions[]
Show child fields
alarm_event_actions.alarm_actions[].dynamo_d_bv2

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.

  • For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

    '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9/5 + 32}\"}'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the tableName parameter uses a string concatenation.

    'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

Show child fields
alarm_event_actions.alarm_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
alarm_event_actions.alarm_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.

alarm_event_actions.alarm_actions[].dynamo_d_bv2.payload.type

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

alarm_event_actions.alarm_actions[].dynamo_d_bv2.table_name

The name of the DynamoDB table.

alarm_event_actions.alarm_actions[].dynamo_db

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

  • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the hashKeyValue parameter uses a substitution template.

    '${$input.GreenhouseInput.temperature * 6/5 + 32} in Fahrenheit'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the tableName parameter uses a string concatenation.

    'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.

Show child fields
alarm_event_actions.alarm_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.

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

alarm_event_actions.alarm_actions[].dynamo_db.hash_key_value

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

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

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

alarm_event_actions.alarm_actions[].dynamo_db.payload.type

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

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

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

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

alarm_event_actions.alarm_actions[].dynamo_db.range_key_value

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

alarm_event_actions.alarm_actions[].dynamo_db.table_name

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

alarm_event_actions.alarm_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
alarm_event_actions.alarm_actions[].firehose.delivery_stream_name

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

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

alarm_event_actions.alarm_actions[].firehose.payload.type

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

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

alarm_event_actions.alarm_actions[].iot_events

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

Show child fields
alarm_event_actions.alarm_actions[].iot_events.input_name

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

alarm_event_actions.alarm_actions[].iot_events.payload

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

Show child fields
alarm_event_actions.alarm_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.

alarm_event_actions.alarm_actions[].iot_events.payload.type

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

alarm_event_actions.alarm_actions[].iot_site_wise

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

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

  • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the propertyAlias parameter uses a substitution template.

    'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

Show child fields
alarm_event_actions.alarm_actions[].iot_site_wise.asset_id

The ID of the asset that has the specified property.

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

alarm_event_actions.alarm_actions[].iot_site_wise.property_alias

The alias of the asset property.

alarm_event_actions.alarm_actions[].iot_site_wise.property_id

The ID of the asset property.

alarm_event_actions.alarm_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
alarm_event_actions.alarm_actions[].iot_site_wise.property_value.quality

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

alarm_event_actions.alarm_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
alarm_event_actions.alarm_actions[].iot_site_wise.property_value.timestamp.offset_in_nanos

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

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

alarm_event_actions.alarm_actions[].iot_site_wise.property_value.value

The value to send to an asset property.

Show child fields
alarm_event_actions.alarm_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.

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

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

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

alarm_event_actions.alarm_actions[].iot_topic_publish

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

Show child fields
alarm_event_actions.alarm_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.

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

alarm_event_actions.alarm_actions[].iot_topic_publish.payload.type

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

alarm_event_actions.alarm_actions[].lambda

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

Show child fields
alarm_event_actions.alarm_actions[].lambda.function_arn

The ARN of the Lambda function that is executed.

alarm_event_actions.alarm_actions[].lambda.payload

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

Show child fields
alarm_event_actions.alarm_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.

alarm_event_actions.alarm_actions[].lambda.payload.type

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

alarm_event_actions.alarm_actions[].sns

Information required to publish the Amazon SNS message.

Show child fields
alarm_event_actions.alarm_actions[].sns.payload

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

Show child fields
alarm_event_actions.alarm_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.

alarm_event_actions.alarm_actions[].sns.payload.type

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

alarm_event_actions.alarm_actions[].sns.target_arn

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

alarm_event_actions.alarm_actions[].sqs

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

Show child fields
alarm_event_actions.alarm_actions[].sqs.payload

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

Show child fields
alarm_event_actions.alarm_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.

alarm_event_actions.alarm_actions[].sqs.payload.type

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

alarm_event_actions.alarm_actions[].sqs.queue_url

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

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

alarm_model_arn

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

VARCHAR
alarm_model_description

The description of the alarm model.

VARCHAR
alarm_notification

Contains information about one or more notification actions.

STRUCT(
    "notification_actions" STRUCT(
        "action" STRUCT(
            "lambda_action" STRUCT(
                "function_arn" VARCHAR,
                "payload" STRUCT(
                    "content_expression" VARCHAR,
                    "type" VARCHAR
                )
            )
        ),
        "sms_configurations" STRUCT(
            "sender_id" VARCHAR,
            "additional_message" VARCHAR,
            "recipients" STRUCT(
                "sso_identity" STRUCT(
                    "identity_store_id" VARCHAR,
                    "user_id" VARCHAR
                )
            )[]
        )[],
        "email_configurations" STRUCT(
            "from" VARCHAR,
            "content" STRUCT(
                "subject" VARCHAR,
                "additional_message" VARCHAR
            ),
            "recipients" STRUCT(
                "to" STRUCT(
                    "sso_identity" STRUCT(
                        "identity_store_id" VARCHAR,
                        "user_id" VARCHAR
                    )
                )[]
            )
        )[]
    )[]
)
Show child fields
alarm_notification.notification_actions[]
Show child fields
alarm_notification.notification_actions[].action

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

Show child fields
alarm_notification.notification_actions[].action.lambda_action

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

Show child fields
alarm_notification.notification_actions[].action.lambda_action.function_arn

The ARN of the Lambda function that is executed.

alarm_notification.notification_actions[].action.lambda_action.payload

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

Show child fields
alarm_notification.notification_actions[].action.lambda_action.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.

alarm_notification.notification_actions[].action.lambda_action.payload.type

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

alarm_notification.notification_actions[].email_configurations[]
Show child fields
alarm_notification.notification_actions[].email_configurations[].content

Contains the subject and message of an email.

Show child fields
alarm_notification.notification_actions[].email_configurations[].content.additional_message

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

alarm_notification.notification_actions[].email_configurations[].content.subject

The subject of the email.

alarm_notification.notification_actions[].email_configurations[].from

The email address that sends emails.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.

alarm_notification.notification_actions[].email_configurations[].recipients

Contains the information of one or more recipients who receive the emails.

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

Show child fields
alarm_notification.notification_actions[].email_configurations[].recipients.to[]
Show child fields
alarm_notification.notification_actions[].email_configurations[].recipients.to[].sso_identity

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

Show child fields
alarm_notification.notification_actions[].email_configurations[].recipients.to[].sso_identity.identity_store_id

The ID of the AWS SSO identity store.

alarm_notification.notification_actions[].email_configurations[].recipients.to[].sso_identity.user_id

The user ID.

alarm_notification.notification_actions[].sms_configurations[]
Show child fields
alarm_notification.notification_actions[].sms_configurations[].additional_message

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

alarm_notification.notification_actions[].sms_configurations[].recipients[]
Show child fields
alarm_notification.notification_actions[].sms_configurations[].recipients[].sso_identity

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

Show child fields
alarm_notification.notification_actions[].sms_configurations[].recipients[].sso_identity.identity_store_id

The ID of the AWS SSO identity store.

alarm_notification.notification_actions[].sms_configurations[].recipients[].sso_identity.user_id

The user ID.

alarm_notification.notification_actions[].sms_configurations[].sender_id

The sender ID.

alarm_rule

Defines when your alarm is invoked.

STRUCT(
    "simple_rule" STRUCT(
        "input_property" VARCHAR,
        "comparison_operator" VARCHAR,
        "threshold" VARCHAR
    )
)
Show child fields
alarm_rule.simple_rule

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

Show child fields
alarm_rule.simple_rule.comparison_operator

The comparison operator.

alarm_rule.simple_rule.input_property

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

alarm_rule.simple_rule.threshold

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

creation_time

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

TIMESTAMP_S
key

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

VARCHAR
last_update_time

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

TIMESTAMP_S
role_arn

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

VARCHAR
severity

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

BIGINT
status

The status of the alarm model. The status can be one of the following values:

  • ACTIVE - The alarm model is active and it's ready to evaluate data.

  • ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

  • INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.

  • FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

VARCHAR
status_message

Contains information about the status of the alarm model. 

VARCHAR