Skip to content
AWS for Query.Farm

aws.wellarchitected.get_review_template_answer

Example SQL Queries

SELECT * FROM
aws.wellarchitected.get_review_template_answer
WHERE
"template_arn" = 'VALUE'
AND "lens_alias" = 'VALUE'
AND "question_id" = 'VALUE';

Description

Get review template answer.

Table Definition

Column NameColumn Data Type
lens_alias Required Input Column

The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.

VARCHAR
question_id Required Input Column

The ID of the question.

VARCHAR
template_arn Required Input Column

The review template ARN.

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
answer

An answer of the question.

STRUCT(
    "question_id" VARCHAR,
    "pillar_id" VARCHAR,
    "question_title" VARCHAR,
    "question_description" VARCHAR,
    "improvement_plan_url" VARCHAR,
    "helpful_resource_url" VARCHAR,
    "helpful_resource_display_text" VARCHAR,
    "choices" STRUCT(
        "choice_id" VARCHAR,
        "title" VARCHAR,
        "description" VARCHAR,
        "helpful_resource" STRUCT(
            "display_text" VARCHAR,
            "url" VARCHAR
        ),
        "improvement_plan" STRUCT(
            "display_text" VARCHAR,
            "url" VARCHAR
        ),
        "additional_resources" STRUCT(
            "type" VARCHAR,
            "content" STRUCT(
                "display_text" VARCHAR,
                "url" VARCHAR
            )[]
        )[]
    )[],
    "selected_choices" VARCHAR[],
    "choice_answers" STRUCT(
        "choice_id" VARCHAR,
        "status" VARCHAR,
        "reason" VARCHAR,
        "notes" VARCHAR
    )[],
    "is_applicable" BOOLEAN,
    "answer_status" VARCHAR,
    "notes" VARCHAR,
    "reason" VARCHAR
)
Show child fields
answer.answer_status

The status of whether or not this question has been answered.

answer.choice_answers[]
Show child fields
answer.choice_answers[].choice_id

The ID of a choice.

answer.choice_answers[].notes

The notes associated with a choice.

answer.choice_answers[].reason

The reason why a choice is non-applicable to a question in your workload.

answer.choice_answers[].status

The status of a choice.

answer.choices[]
Show child fields
answer.choices[].additional_resources[]
Show child fields
answer.choices[].additional_resources[].content[]
Show child fields
answer.choices[].additional_resources[].content[].display_text

The display text for the choice content.

answer.choices[].additional_resources[].content[].url

The URL for the choice content.

answer.choices[].additional_resources[].type

Type of additional resource for a custom lens.

answer.choices[].choice_id

The ID of a choice.

answer.choices[].description

The description of a choice.

answer.choices[].helpful_resource

The helpful resource (both text and URL) for a particular choice.

This field only applies to custom lenses. Each choice can have only one helpful resource.

Show child fields
answer.choices[].helpful_resource.display_text

The display text for the choice content.

answer.choices[].helpful_resource.url

The URL for the choice content.

answer.choices[].improvement_plan

The improvement plan (both text and URL) for a particular choice.

This field only applies to custom lenses. Each choice can have only one improvement plan.

Show child fields
answer.choices[].improvement_plan.display_text

The display text for the choice content.

answer.choices[].improvement_plan.url

The URL for the choice content.

answer.choices[].title

The title of a choice.

answer.helpful_resource_display_text

The helpful resource text to be displayed for a custom lens.

This field does not apply to Amazon Web Services official lenses.

answer.helpful_resource_url

The helpful resource URL.

For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

answer.improvement_plan_url

The improvement plan URL for a question in an Amazon Web Services official lenses.

This value is only available if the question has been answered.

This value does not apply to custom lenses.

answer.is_applicable

Defines whether this question is applicable to a lens review.

answer.notes

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

answer.pillar_id

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

answer.question_description

The description of the question.

answer.question_id

The ID of the question.

answer.question_title

The title of the question.

answer.reason

The reason why the question is not applicable to your review template.

answer.selected_choices[]