Skip to content
AWS for Query.Farm

aws.support.describe_trusted_advisor_check_summaries

Example SQL Queries

SELECT * FROM
aws.support.describe_trusted_advisor_check_summaries
WHERE
"check_ids" = 'VALUE';

Description

Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains an array of TrustedAdvisorCheckSummary objects.

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Table Definition

Column NameColumn Data Type
check_ids Required Input Column

The IDs of the Trusted Advisor checks.

VARCHAR[]
Show child fields
check_ids[]
_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.

summaries

The summary information for the requested Trusted Advisor checks.

STRUCT(
    "check_id" VARCHAR,
    "timestamp" VARCHAR,
    "status" VARCHAR,
    "has_flagged_resources" BOOLEAN,
    "resources_summary" STRUCT(
        "resources_processed" BIGINT,
        "resources_flagged" BIGINT,
        "resources_ignored" BIGINT,
        "resources_suppressed" BIGINT
    ),
    "category_specific_summary" STRUCT(
        "cost_optimizing" STRUCT(
            "estimated_monthly_savings" DOUBLE,
            "estimated_percent_monthly_savings" DOUBLE
        )
    )
)[]
Show child fields
summaries[]
Show child fields
summaries[].category_specific_summary

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

Show child fields
summaries[].category_specific_summary.cost_optimizing

The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

Show child fields
summaries[].category_specific_summary.cost_optimizing.estimated_monthly_savings

The estimated monthly savings that might be realized if the recommended operations are taken.

summaries[].category_specific_summary.cost_optimizing.estimated_percent_monthly_savings

The estimated percentage of savings that might be realized if the recommended operations are taken.

summaries[].check_id

The unique identifier for the Trusted Advisor check.

summaries[].has_flagged_resources

Specifies whether the Trusted Advisor check has flagged resources.

summaries[].resources_summary

Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

Show child fields
summaries[].resources_summary.resources_flagged

The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.

summaries[].resources_summary.resources_ignored

The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.

summaries[].resources_summary.resources_processed

The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

summaries[].resources_summary.resources_suppressed

The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.

summaries[].status

The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

summaries[].timestamp

The time of the last refresh of the check.