Skip to content

aws.iotevents_data.describe_alarm

Example SQL Queries

SELECT * FROM
aws.iotevents_data.describe_alarm
WHERE
"alarm_model_name" = 'VALUE';

Description

Retrieves information about an alarm.

Table Definition

Column NameColumn Data Type
alarm_model_name Required Input Column

The name of the alarm model.

VARCHAR
key_value Input Column

The value of the key used as a filter to select only the alarms associated with the key.

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.

alarm

Contains information about an alarm.

STRUCT(
"alarm_model_name" VARCHAR,
"alarm_model_version" VARCHAR,
"key_value" VARCHAR,
"alarm_state" STRUCT(
"state_name" VARCHAR,
"rule_evaluation" STRUCT(
"simple_rule_evaluation" STRUCT(
"input_property_value" VARCHAR,
"operator" VARCHAR,
"threshold_value" VARCHAR
)
),
"customer_action" STRUCT(
"action_name" VARCHAR,
"snooze_action_configuration" STRUCT(
"snooze_duration" BIGINT,
"note" VARCHAR
),
"enable_action_configuration" STRUCT(
"note" VARCHAR
),
"disable_action_configuration" STRUCT(
"note" VARCHAR
),
"acknowledge_action_configuration" STRUCT(
"note" VARCHAR
),
"reset_action_configuration" STRUCT(
"note" VARCHAR
)
),
"system_event" STRUCT(
"event_type" VARCHAR,
"state_change_configuration" STRUCT(
"trigger_type" VARCHAR
)
)
),
"severity" BIGINT,
"creation_time" TIMESTAMP_S,
"last_update_time" TIMESTAMP_S
)
Show child fields
alarm.alarm_model_name

The name of the alarm model.

alarm.alarm_model_version

The version of the alarm model.

alarm.alarm_state

Contains information about the current state of the alarm.

Show child fields
alarm.alarm_state.customer_action

Contains information about the action that you can take to respond to the alarm.

Show child fields
alarm.alarm_state.customer_action.acknowledge_action_configuration

Contains the configuration information of an acknowledge action.

Show child fields
alarm.alarm_state.customer_action.acknowledge_action_configuration.note

The note that you can leave when you acknowledge the alarm.

alarm.alarm_state.customer_action.action_name

The name of the action. The action name can be one of the following values:

  • SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

  • ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

  • DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

  • ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

  • RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

alarm.alarm_state.customer_action.disable_action_configuration

Contains the configuration information of a disable action.

Show child fields
alarm.alarm_state.customer_action.disable_action_configuration.note

The note that you can leave when you disable the alarm.

alarm.alarm_state.customer_action.enable_action_configuration

Contains the configuration information of an enable action.

Show child fields
alarm.alarm_state.customer_action.enable_action_configuration.note

The note that you can leave when you enable the alarm.

alarm.alarm_state.customer_action.reset_action_configuration

Contains the configuration information of a reset action.

Show child fields
alarm.alarm_state.customer_action.reset_action_configuration.note

The note that you can leave when you reset the alarm.

alarm.alarm_state.customer_action.snooze_action_configuration

Contains the configuration information of a snooze action.

Show child fields
alarm.alarm_state.customer_action.snooze_action_configuration.note

The note that you can leave when you snooze the alarm.

alarm.alarm_state.customer_action.snooze_action_configuration.snooze_duration

The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.

alarm.alarm_state.rule_evaluation

Information needed to evaluate data.

Show child fields
alarm.alarm_state.rule_evaluation.simple_rule_evaluation

Information needed to compare two values with a comparison operator.

Show child fields
alarm.alarm_state.rule_evaluation.simple_rule_evaluation.input_property_value

The value of the input property, on the left side of the comparison operator.

alarm.alarm_state.rule_evaluation.simple_rule_evaluation.operator

The comparison operator.

alarm.alarm_state.rule_evaluation.simple_rule_evaluation.threshold_value

The threshold value, on the right side of the comparison operator.

alarm.alarm_state.state_name

The name of the alarm state. The state name can be one of the following values:

  • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

  • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

  • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

  • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

  • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

  • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

alarm.alarm_state.system_event

Contains information about alarm state changes.

Show child fields
alarm.alarm_state.system_event.event_type

The event type. If the value is STATE_CHANGE, the event contains information about alarm state changes.

alarm.alarm_state.system_event.state_change_configuration

Contains the configuration information of alarm state changes.

Show child fields
alarm.alarm_state.system_event.state_change_configuration.trigger_type

The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and the alarm automatically changes to the NORMAL state.

alarm.creation_time

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

alarm.key_value

The value of the key used as a filter to select only the alarms associated with the key.

alarm.last_update_time

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

alarm.severity

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