Skip to content
AWS for Query.Farm

aws.iotevents_data.list_alarms

Example SQL Queries

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

Description

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

Table Definition

Column NameColumn Data Type
alarm_model_name Required Input Column

The name of the alarm model.

VARCHAR
max_results Input Column

The maximum number of results to be returned per request.

BIGINT
next_token Input Column

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

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_summaries

A list that summarizes each alarm.

STRUCT(
    "alarm_model_name" VARCHAR,
    "alarm_model_version" VARCHAR,
    "key_value" VARCHAR,
    "state_name" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "last_update_time" TIMESTAMP_S
)[]
Show child fields
alarm_summaries[]
Show child fields
alarm_summaries[].alarm_model_name

The name of the alarm model.

alarm_summaries[].alarm_model_version

The version of the alarm model.

alarm_summaries[].creation_time

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

alarm_summaries[].key_value

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

alarm_summaries[].last_update_time

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

alarm_summaries[].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.