Skip to content
AWS for Query.Farm

aws.lookoutmetrics.describe_alert

Example SQL Queries

SELECT * FROM
aws.lookoutmetrics.describe_alert
WHERE
"alert_arn" = 'VALUE';

Description

Describes an alert.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

Table Definition

Column NameColumn Data Type
alert_arn Required Input Column

The ARN of the alert to describe.

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
alert

Contains information about an alert.

STRUCT(
    "action" STRUCT(
        "sns_configuration" STRUCT(
            "role_arn" VARCHAR,
            "sns_topic_arn" VARCHAR,
            "sns_format" VARCHAR
        ),
        "lambda_configuration" STRUCT(
            "role_arn" VARCHAR,
            "lambda_arn" VARCHAR
        )
    ),
    "alert_description" VARCHAR,
    "alert_arn" VARCHAR,
    "anomaly_detector_arn" VARCHAR,
    "alert_name" VARCHAR,
    "alert_sensitivity_threshold" BIGINT,
    "alert_type" VARCHAR,
    "alert_status" VARCHAR,
    "last_modification_time" TIMESTAMP_S,
    "creation_time" TIMESTAMP_S,
    "alert_filters" STRUCT(
        "metric_list" VARCHAR[],
        "dimension_filter_list" STRUCT(
            "dimension_name" VARCHAR,
            "dimension_value_list" VARCHAR[]
        )[]
    )
)
Show child fields
alert.action

Action that will be triggered when there is an alert.

Show child fields
alert.action.lambda_configuration

A configuration for an AWS Lambda channel.

Show child fields
alert.action.lambda_configuration.lambda_arn

The ARN of the Lambda function.

alert.action.lambda_configuration.role_arn

The ARN of an IAM role that has permission to invoke the Lambda function.

alert.action.sns_configuration

A configuration for an Amazon SNS channel.

Show child fields
alert.action.sns_configuration.role_arn

The ARN of the IAM role that has access to the target SNS topic.

alert.action.sns_configuration.sns_format

The format of the SNS topic.

  • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.

  • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.

  • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

alert.action.sns_configuration.sns_topic_arn

The ARN of the target SNS topic.

alert.alert_arn

The ARN of the alert.

alert.alert_description

A description of the alert.

alert.alert_filters

The configuration of the alert filters, containing MetricList and DimensionFilter.

Show child fields
alert.alert_filters.dimension_filter_list[]
Show child fields
alert.alert_filters.dimension_filter_list[].dimension_name

The name of the dimension to filter on.

alert.alert_filters.dimension_filter_list[].dimension_value_list[]
alert.alert_filters.metric_list[]
alert.alert_name

The name of the alert.

alert.alert_sensitivity_threshold

The minimum severity for an anomaly to trigger the alert.

alert.alert_status

The status of the alert.

alert.alert_type

The type of the alert.

alert.anomaly_detector_arn

The ARN of the detector to which the alert is attached.

alert.creation_time

The time at which the alert was created.

alert.last_modification_time

The time at which the alert was last modified.