Skip to content

aws.wellarchitected.get_consolidated_report

Example SQL Queries

SELECT * FROM
aws.wellarchitected.get_consolidated_report
WHERE
"format" = 'VALUE';

Description

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

Table Definition

Column NameColumn Data Type
format Required Input Column

The format of the consolidated report.

For PDF, Base64String is returned. For JSON, Metrics is returned.

VARCHAR
include_shared_resources Input Column

Set to true to have shared resources included in the report.

BOOLEAN
max_results Input Column

The maximum number of results to return for this request.

BIGINT
next_token Input Column

The token to use to retrieve the next set of 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
base64_string

The Base64-encoded string representation of a lens review report.

This data can be used to create a PDF file.

Only returned by GetConsolidatedReport when PDF format is requested.

VARCHAR
metrics

The metrics that make up the consolidated report.

Only returned when JSON format is requested.

STRUCT(
"metric_type" VARCHAR,
"risk_counts" MAP(VARCHAR, BIGINT),
"workload_id" VARCHAR,
"workload_name" VARCHAR,
"workload_arn" VARCHAR,
"updated_at" TIMESTAMP_S,
"lenses" STRUCT(
"lens_arn" VARCHAR,
"pillars" STRUCT(
"pillar_id" VARCHAR,
"risk_counts" MAP(VARCHAR, BIGINT),
"questions" STRUCT(
"question_id" VARCHAR,
"risk" VARCHAR,
"best_practices" STRUCT(
"choice_id" VARCHAR,
"choice_title" VARCHAR
)[]
)[]
)[],
"risk_counts" MAP(VARCHAR, BIGINT)
)[],
"lenses_applied_count" BIGINT
)[]
Show child fields
metrics[]
Show child fields
metrics[].lenses[]
Show child fields
metrics[].lenses[].lens_arn

The lens ARN.

metrics[].lenses[].pillars[]
Show child fields
metrics[].lenses[].pillars[].pillar_id

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

A pillar is identified by its PillarReviewSummary$PillarId.

metrics[].lenses[].pillars[].questions[]
Show child fields
metrics[].lenses[].pillars[].questions[].best_practices[]
Show child fields
metrics[].lenses[].pillars[].questions[].best_practices[].choice_id

The ID of a choice.

metrics[].lenses[].pillars[].questions[].best_practices[].choice_title

The title of a choice.

metrics[].lenses[].pillars[].questions[].question_id

The ID of the question.

metrics[].lenses[].pillars[].questions[].risk

The risk for a given workload, lens review, pillar, or question.

metrics[].lenses[].pillars[].risk_counts

A map from risk names to the count of how many questions have that rating.

metrics[].lenses[].risk_counts

A map from risk names to the count of how many questions have that rating.

metrics[].lenses_applied_count

The total number of lenses applied to the workload.

metrics[].metric_type

The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

metrics[].risk_counts

A map from risk names to the count of how many questions have that rating.

metrics[].updated_at

The date and time recorded.

metrics[].workload_arn

The ARN for the workload.

metrics[].workload_id

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

metrics[].workload_name

The name of the workload.

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.