steampipe plugin install aws

Table: aws_wellarchitected_workload - Query AWS Well-Architected Tool Workloads using SQL

The AWS Well-Architected Tool is a service that helps you review the state of your workloads and compares them to the latest AWS architectural best practices. The tool measures your workloads across five pillars of a well-architected framework: operational excellence, security, reliability, performance efficiency, and cost optimization. It provides a consistent approach for customers and partners to evaluate architectures, and implement designs that can scale over time.

Table Usage Guide

The aws_wellarchitected_workload table in Steampipe provides you with information about workloads within AWS Well-Architected Tool. This table allows you, as a DevOps engineer, to query workload-specific details, including workload name, ARN, risk count, and improvement status. You can utilize this table to gather insights on workloads, such as identifying workloads with high risk counts, tracking improvement status, and more. The schema outlines the various attributes of the workload for you, including the workload ARN, creation date, risk count, improvement status, and associated tags.

Examples

Basic info

select
workload_name,
workload_id,
environment,
industry,
owner
from
aws_wellarchitected_workload;
select
workload_name,
workload_id,
environment,
industry,
owner
from
aws_wellarchitected_workload;

List production workloads

select
workload_name,
workload_id,
environment
from
aws_wellarchitected_workload
where
environment = 'PRODUCTION';
select
workload_name,
workload_id,
environment
from
aws_wellarchitected_workload
where
environment = 'PRODUCTION';

Get high risk issue counts for each workload

select
workload_name,
workload_id,
risk_counts -> 'HIGH' as high_risk_counts
from
aws_wellarchitected_workload;
select
workload_name,
workload_id,
json_extract(risk_counts, '$.HIGH') as high_risk_counts
from
aws_wellarchitected_workload;

List workloads that do not require a review owner

select
workload_name,
workload_id,
is_review_owner_update_acknowledged
from
aws_wellarchitected_workload
where
not is_review_owner_update_acknowledged;
select
workload_name,
workload_id,
is_review_owner_update_acknowledged
from
aws_wellarchitected_workload
where
is_review_owner_update_acknowledged is not 1;

Schema for aws_wellarchitected_workload

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
account_idtext=, !=, ~~, ~~*, !~~, !~~*The AWS Account ID in which the resource is located.
account_idsjsonbThe list of AWS account IDs associated with the workload.
akasjsonbArray of globally unique identifier strings (also known as) for the resource.
architectural_designtextThe URL of the architectural design for the workload.
aws_regionsjsonbThe list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
descriptiontextThe description for the workload.
environmenttextThe environment for the workload.
improvement_statustextThe improvement status for a workload.
industrytextThe industry for the workload.
industry_typetextThe industry type for the workload.
is_review_owner_update_acknowledgedbooleanFlag indicating whether the workload owner has acknowledged that the review owner field is required.
lensesjsonbThe list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
non_aws_regionsjsonbThe list of non-AWS Regions associated with the workload.
notestextThe notes associated with the workload.
ownertextAn AWS account ID.
partitiontextThe AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
pillar_prioritiesjsonbThe priorities of the pillars, which are used to order items in the improvement plan.
regiontextThe AWS Region in which the resource is located.
review_ownertextThe review owner of the workload.
review_restriction_datetimestamp with time zoneThe date and time recorded.
risk_countsjsonbA map from risk names to the count of how questions have that rating.
share_invitation_idtextThe ID assigned to the share invitation.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
tagsjsonbA map of tags for the resource.
titletextTitle of the resource.
updated_attimestamp with time zoneThe date and time recorded.
workload_arntextThe ARN for the workload.
workload_idtext=The ID assigned to the workload.
workload_nametext=The name of the workload.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- aws

You can pass the configuration to the command with the --config argument:

steampipe_export_aws --config '<your_config>' aws_wellarchitected_workload