Skip to content
AWS for Query.Farm

aws.resiliencehub.list_alarm_recommendations

Example SQL Queries

SELECT * FROM
aws.resiliencehub.list_alarm_recommendations
WHERE
"assessment_arn" = 'VALUE';

Description

Lists the alarm recommendations for an Resilience Hub application.

Table Definition

Column NameColumn Data Type
assessment_arn Required Input Column

Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

VARCHAR
max_results Input Column

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

BIGINT
next_token Input Column

Token for 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.

_aws_region Input Column

The AWS region to use.

VARCHAR
alarm_recommendations

The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

STRUCT(
    "app_component_name" VARCHAR,
    "app_component_names" VARCHAR[],
    "description" VARCHAR,
    "items" STRUCT(
        "already_implemented" BOOLEAN,
        "exclude_reason" VARCHAR,
        "excluded" BOOLEAN,
        "resource_id" VARCHAR,
        "target_account_id" VARCHAR,
        "target_region" VARCHAR
    )[],
    "name" VARCHAR,
    "prerequisite" VARCHAR,
    "recommendation_id" VARCHAR,
    "recommendation_status" VARCHAR,
    "reference_id" VARCHAR,
    "type" VARCHAR
)[]
Show child fields
alarm_recommendations[]
Show child fields
alarm_recommendations[].app_component_name

Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

alarm_recommendations[].app_component_names[]
alarm_recommendations[].description

Description of the alarm recommendation.

alarm_recommendations[].items[]
Show child fields
alarm_recommendations[].items[].already_implemented

Specifies if the recommendation has already been implemented.

alarm_recommendations[].items[].exclude_reason

Indicates the reason for excluding an operational recommendation.

alarm_recommendations[].items[].excluded

Indicates if an operational recommendation item is excluded.

alarm_recommendations[].items[].resource_id

Identifier of the resource.

alarm_recommendations[].items[].target_account_id

Identifier of the target account.

alarm_recommendations[].items[].target_region

The target region.

alarm_recommendations[].name

Name of the alarm recommendation.

alarm_recommendations[].prerequisite

The prerequisite for the alarm recommendation.

alarm_recommendations[].recommendation_id

Identifier of the alarm recommendation.

alarm_recommendations[].recommendation_status

Status of the recommended Amazon CloudWatch alarm.

alarm_recommendations[].reference_id

Reference identifier of the alarm recommendation.

alarm_recommendations[].type

Type of alarm recommendation.