Support / Client / describe_trusted_advisor_check_result

describe_trusted_advisor_check_result#

Support.Client.describe_trusted_advisor_check_result(**kwargs)#

Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

TrustedAdvisorCategorySpecificSummary
TrustedAdvisorResourceDetail
TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.

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.

Request Syntax

response = client.describe_trusted_advisor_check_result(
    checkId='string',
    language='string'
)

Parameters:

checkId (string) –
[REQUIRED]

The unique identifier for the Trusted Advisor check.
language (string) –
The ISO 639-1 code for the language that you want your check results to appear in.

The 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

Return type:

dict

Returns:

Response Syntax

{
    'result': {
        'checkId': 'string',
        'timestamp': 'string',
        'status': 'string',
        'resourcesSummary': {
            'resourcesProcessed': 123,
            'resourcesFlagged': 123,
            'resourcesIgnored': 123,
            'resourcesSuppressed': 123
        },
        'categorySpecificSummary': {
            'costOptimizing': {
                'estimatedMonthlySavings': 123.0,
                'estimatedPercentMonthlySavings': 123.0
            }
        },
        'flaggedResources': [
            {
                'status': 'string',
                'region': 'string',
                'resourceId': 'string',
                'isSuppressed': True|False,
                'metadata': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

(dict) –

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
- result (dict) –
  
  The detailed results of the Trusted Advisor check.
  - 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”.
  - 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.
  - flaggedResources (list) –
    
    The details about each resource listed in the check result.
    - (dict) –
      
      Contains information about a resource identified by a Trusted Advisor check.
      - status (string) –
        
        The status code for the resource identified in the Trusted Advisor check.
      - region (string) –
        
        The Amazon Web Services Region in which the identified resource is located.
      - resourceId (string) –
        
        The unique identifier for the identified resource.
      - isSuppressed (boolean) –
        
        Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
      - metadata (list) –
        
        Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
        
        (string) –