Support / Client / describe_trusted_advisor_check_summaries

describe_trusted_advisor_check_summaries#

Support.Client.describe_trusted_advisor_check_summaries(**kwargs)#

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.

Note

  • 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_advisor_check_summaries(
    checkIds=[
        'string',
    ]
)
Parameters:

checkIds (list) –

[REQUIRED]

The IDs of the Trusted Advisor checks.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'summaries': [
        {
            'checkId': 'string',
            'timestamp': 'string',
            'status': 'string',
            'hasFlaggedResources': True|False,
            'resourcesSummary': {
                'resourcesProcessed': 123,
                'resourcesFlagged': 123,
                'resourcesIgnored': 123,
                'resourcesSuppressed': 123
            },
            'categorySpecificSummary': {
                'costOptimizing': {
                    'estimatedMonthlySavings': 123.0,
                    'estimatedPercentMonthlySavings': 123.0
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

    • summaries (list) –

      The summary information for the requested Trusted Advisor checks.

      • (dict) –

        A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

        • checkId (string) –

          The unique identifier for the Trusted Advisor check.

        • timestamp (string) –

          The time of the last refresh of the check.

        • status (string) –

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

        • hasFlaggedResources (boolean) –

          Specifies whether the Trusted Advisor check has flagged resources.

        • resourcesSummary (dict) –

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

          • resourcesProcessed (integer) –

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

          • resourcesFlagged (integer) –

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

          • resourcesIgnored (integer) –

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

          • resourcesSuppressed (integer) –

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

        • categorySpecificSummary (dict) –

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

          • costOptimizing (dict) –

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

            • estimatedMonthlySavings (float) –

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

            • estimatedPercentMonthlySavings (float) –

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

Exceptions