steampipe plugin install aws

Table: aws_trusted_advisor_check_summary - Query AWS Trusted Advisor Check Summaries using SQL

A Trusted Advisor check is a specific evaluation or assessment performed by Trusted Advisor in different categories. These checks cover various areas, including cost optimization, security, performance, and fault tolerance. Each check examines a specific aspect of your AWS resources and provides recommendations for improvement.

Table Usage Guide

The aws_trusted_advisor_check_summary table in Steampipe allows users to query information about AWS Trusted Advisor Check Summaries. These summaries provide insights into the status and details of Trusted Advisor checks, including the check name, check ID, category, description, status, timestamp, and the number of resources flagged, ignored, processed, and suppressed.

Important Notes

  • You must specify language in a where clause in order to use this table.
  • Amazon Web Services Support API currently supports the following languages for Trusted Advisor:
    • Chinese, Simplified - zh
    • Chinese, Traditional - zh_TW
    • English - en
    • French - fr
    • German - de
    • Indonesian - id
    • Italian - it
    • Japanese - ja
    • Korean - ko
    • Portuguese, Brazilian - pt_BR
    • Spanish - es

Examples

Basic info

Retrieve basic information about AWS Trusted Advisor Check Summaries, including the check name, check ID, category, description, status, timestamp, and the number of resources flagged.

select
name,
check_id,
category,
description,
status,
timestamp,
resources_flagged
from
aws_trusted_advisor_check_summary
where
language = 'en';
select
name,
check_id,
category,
description,
status,
timestamp,
resources_flagged
from
aws_trusted_advisor_check_summary
where
language = 'en';

Get error check summaries

Retrieve AWS Trusted Advisor Check Summaries with an "error" status. This query helps you identify checks that require attention due to errors.

select
name,
check_id,
category,
status
from
aws_trusted_advisor_check_summary
where
language = 'en'
and status = 'error';
select
name,
check_id,
category,
status
from
aws_trusted_advisor_check_summary
where
language = 'en'
and status = 'error';

Get check summaries for the last 5 days

Retrieve AWS Trusted Advisor Check Summaries from the last 5 days. This query allows you to review recent check summaries and their details.

select
name,
check_id,
description,
status,
timestamp
from
aws_trusted_advisor_check_summary
where
language = 'en'
and timestamp >= now() - interval '5 day';
select
name,
check_id,
description,
status,
timestamp
from
aws_trusted_advisor_check_summary
where
language = 'en'
and timestamp >= datetime('now', '-5 day');

Get resource summaries of each check

Retrieve resource summaries for each AWS Trusted Advisor Check. This includes the number of resources flagged, ignored, processed, and suppressed for each check.

select
name,
check_id,
resources_flagged,
resources_ignored,
resources_processed,
resources_suppressed
from
aws_trusted_advisor_check_summary
where
language = 'en';
select
name,
check_id,
resources_flagged,
resources_ignored,
resources_processed,
resources_suppressed
from
aws_trusted_advisor_check_summary
where
language = 'en';

Schema for aws_trusted_advisor_check_summary

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
account_idtext=, !=, ~~, ~~*, !~~, !~~*The AWS Account ID in which the resource is located.
categorytextThe category of the Trusted Advisor check.
category_specific_summaryjsonbSummary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
check_idtext=The unique identifier for the Trusted Advisor check.
descriptiontextThe description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
languagetext=The ISO 639-1 code for the language that you want your checks to appear in.
metadatajsonbThe column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
nametextThe display name for the Trusted Advisor check.
partitiontextThe AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
resources_flaggedbigintThe number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
resources_ignoredbigintThe number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
resources_processedbigintThe number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
resources_suppressedbigintThe number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
statustextThe alert status of the check: 'ok' (green), 'warning' (yellow), 'error' (red), or 'not_available'.
timestamptimestamp with time zoneThe time of the last refresh of the check.
titletextTitle of the resource.

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_trusted_advisor_check_summary