Skip to content
AWS for Query.Farm

aws.resiliencehub.describe_app_assessment

Example SQL Queries

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

Description

Describes an assessment 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
_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
assessment

The assessment for an Resilience Hub application, returned as an object. This object includes Amazon Resource Names (ARNs), compliance information, compliance status, cost, messages, resiliency scores, and more.

STRUCT(
    "app_arn" VARCHAR,
    "app_version" VARCHAR,
    "assessment_arn" VARCHAR,
    "assessment_name" VARCHAR,
    "assessment_status" VARCHAR,
    "compliance" MAP(VARCHAR, STRUCT(
            "achievable_rpo_in_secs" BIGINT,
            "achievable_rto_in_secs" BIGINT,
            "compliance_status" VARCHAR,
            "current_rpo_in_secs" BIGINT,
            "current_rto_in_secs" BIGINT,
            "message" VARCHAR,
            "rpo_description" VARCHAR,
            "rpo_reference_id" VARCHAR,
            "rto_description" VARCHAR,
            "rto_reference_id" VARCHAR
        )),
    "compliance_status" VARCHAR,
    "cost" STRUCT(
        "amount" DOUBLE,
        "currency" VARCHAR,
        "frequency" VARCHAR
    ),
    "drift_status" VARCHAR,
    "end_time" TIMESTAMP_S,
    "invoker" VARCHAR,
    "message" VARCHAR,
    "policy" STRUCT(
        "creation_time" TIMESTAMP_S,
        "data_location_constraint" VARCHAR,
        "estimated_cost_tier" VARCHAR,
        "policy" MAP(VARCHAR, STRUCT(
                "rpo_in_secs" BIGINT,
                "rto_in_secs" BIGINT
            )),
        "policy_arn" VARCHAR,
        "policy_description" VARCHAR,
        "policy_name" VARCHAR,
        "tags" MAP(VARCHAR, VARCHAR),
        "tier" VARCHAR
    ),
    "resiliency_score" STRUCT(
        "component_score" MAP(VARCHAR, STRUCT(
                "excluded_count" BIGINT,
                "outstanding_count" BIGINT,
                "possible_score" DOUBLE,
                "score" DOUBLE
            )),
        "disruption_score" MAP(VARCHAR, DOUBLE),
        "score" DOUBLE
    ),
    "resource_errors_details" STRUCT(
        "has_more_errors" BOOLEAN,
        "resource_errors" STRUCT(
            "logical_resource_id" VARCHAR,
            "physical_resource_id" VARCHAR,
            "reason" VARCHAR
        )[]
    ),
    "start_time" TIMESTAMP_S,
    "summary" STRUCT(
        "risk_recommendations" STRUCT(
            "app_components" VARCHAR[],
            "recommendation" VARCHAR,
            "risk" VARCHAR
        )[],
        "summary" VARCHAR
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "version_name" VARCHAR
)
Show child fields
assessment.app_arn

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

assessment.app_version

Version of an application.

assessment.assessment_arn

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.

assessment.assessment_name

Name of the assessment.

assessment.assessment_status

Current status of the assessment for the resiliency policy.

assessment.compliance

Application compliance against the resiliency policy.

assessment.compliance_status

Current status of the compliance for the resiliency policy.

assessment.cost

Cost for the application.

Show child fields
assessment.cost.amount

The cost amount.

assessment.cost.currency

The cost currency, for example USD.

assessment.cost.frequency

The cost frequency.

assessment.drift_status

Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

assessment.end_time

End time for the action.

assessment.invoker

The entity that invoked the assessment.

assessment.message

Error or warning message from the assessment execution

assessment.policy

Resiliency policy of an application.

Show child fields
assessment.policy.creation_time

Date and time when the resiliency policy was created.

assessment.policy.data_location_constraint

Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

assessment.policy.estimated_cost_tier

Specifies the estimated cost tier of the resiliency policy.

assessment.policy.policy

The resiliency policy.

assessment.policy.policy_arn

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

assessment.policy.policy_description

The description for the policy.

assessment.policy.policy_name

The name of the policy

assessment.policy.tags

Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

assessment.policy.tier

The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).

assessment.resiliency_score

Current resiliency score for an application.

Show child fields
assessment.resiliency_score.component_score

The score generated by Resilience Hub for the scoring component after running an assessment.

For example, if the score is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment.

assessment.resiliency_score.disruption_score

The disruption score for a valid key.

assessment.resiliency_score.score

The outage score for a valid key.

assessment.resource_errors_details

A resource error object containing a list of errors retrieving an application's resources.

Show child fields
assessment.resource_errors_details.has_more_errors

This indicates if there are more errors not listed in the resourceErrors list.

assessment.resource_errors_details.resource_errors[]
Show child fields
assessment.resource_errors_details.resource_errors[].logical_resource_id

Identifier of the logical resource.

assessment.resource_errors_details.resource_errors[].physical_resource_id

Identifier of the physical resource.

assessment.resource_errors_details.resource_errors[].reason

This is the error message.

assessment.start_time

Starting time for the action.

assessment.summary

Indicates a concise summary that provides an overview of the Resilience Hub assessment.

Show child fields
assessment.summary.risk_recommendations[]
Show child fields
assessment.summary.risk_recommendations[].app_components[]
assessment.summary.risk_recommendations[].recommendation

Indicates the recommendation provided by the Resilience Hub to address the identified risks in the application.

This property is available only in the US East (N. Virginia) Region.

assessment.summary.risk_recommendations[].risk

Indicates the description of the potential risk identified in the application as part of the Resilience Hub assessment.

This property is available only in the US East (N. Virginia) Region.

assessment.summary.summary

Indicates a concise summary that provides an overview of the Resilience Hub assessment.

This property is available only in the US East (N. Virginia) Region.

assessment.tags

Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

assessment.version_name

Version name of the published application.