TrustedAdvisor Public API

List all Trusted Advisor recommendations for a given AWS resource ARN.

See also: AWS API Documentation

Request Syntax

client.list_recommendations_for_resource(
    nextToken='string',
    maxResults=123,
    awsResourceArn='string',
    pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
    status='ok'|'warning'|'error',
    checkArn='string',
    language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)

type nextToken:

string

param nextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of results to return per page

type awsResourceArn:

string

param awsResourceArn:

[REQUIRED]

The ARN of the AWS resource to query recommendations for

type pillar:

string

param pillar:

The pillar that the recommendation belongs to

type status:

string

param status:

The current status of the Recommendation Resource

type checkArn:

string

param checkArn:

The AWS Trusted Advisor Check ARN that relates to the Recommendation

type language:

string

param language:

The ISO 639-1 code for the language that you want your recommendations to appear in.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'recommendationForResourceSummaries': [
        {
            'checkArn': 'string',
            'recommendationArn': 'string',
            'awsResourceArn': 'string',
            'status': 'ok'|'warning'|'error',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'exclusionStatus': 'excluded'|'included',
            'metadata': {
                'string': 'string'
            },
            'pillars': [
                'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
            ]
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • recommendationForResourceSummaries (list) --

    List of Trusted Advisor recommendations associated with the given AWS resource

    • (dict) --

      Summary of a Recommendation for a specific AWS Resource

      • checkArn (string) --

        The Check ARN

      • recommendationArn (string) --

        The Recommendation ARN

      • awsResourceArn (string) --

        The AWS Resource ARN

      • status (string) --

        The current status of the recommendation

      • lastUpdatedAt (datetime) --

        When the recommendation was last updated

      • exclusionStatus (string) --

        The exclusion status of the recommendation

      • metadata (dict) --

        Metadata associated with the recommendation

        • (string) --

          • (string) --

      • pillars (list) --

        The Pillars that the Recommendation is optimizing

        • (string) --

{'checkSummaries': {'awsResourceTypes': ['string'],
                    'checkGranularity': 'string',
                    'recommendationId': 'string',
                    'resourceArnQueryable': 'boolean'}}

List a filterable set of Checks. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

See also: AWS API Documentation

Request Syntax

client.list_checks(
    nextToken='string',
    maxResults=123,
    pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
    awsService='string',
    source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
    language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)

type nextToken:

string

param nextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type pillar:

string

param pillar:

The pillar of the check

type awsService:

string

param awsService:

The aws service associated with the check

type source:

string

param source:

The source of the check

type language:

string

param language:

The ISO 639-1 code for the language that you want your checks to appear in.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'checkSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'pillars': [
                'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
            ],
            'awsServices': [
                'string',
            ],
            'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
            'metadata': {
                'string': 'string'
            },
            'resourceArnQueryable': True|False,
            'awsResourceTypes': [
                'string',
            ],
            'checkGranularity': 'string',
            'recommendationId': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • nextToken (string) --

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • checkSummaries (list) --

    The list of Checks

    • (dict) --

      A summary of an AWS Trusted Advisor Check

      • id (string) --

        The unique identifier of the AWS Trusted Advisor Check

      • arn (string) --

        The ARN of the AWS Trusted Advisor Check

      • name (string) --

        The name of the AWS Trusted Advisor Check

      • description (string) --

        A description of what the AWS Trusted Advisor Check is monitoring

      • pillars (list) --

        The Recommendation pillars that the AWS Trusted Advisor Check falls under

        • (string) --

      • awsServices (list) --

        The AWS Services that the Check applies to

        • (string) --

      • source (string) --

        The source of the Recommendation

      • metadata (dict) --

        The column headings for the metadata returned in the resource

        • (string) --

          • (string) --

      • resourceArnQueryable (boolean) --

        Indicates whether this check is supported by the ListRecommendationsForResource API.

      • awsResourceTypes (list) --

        The AWS resource types that this check evaluates (for example, AWS::EC2::Instance).

        • (string) --

      • checkGranularity (string) --

        The granularity level at which the check operates: resource, account, or account_region.

      • recommendationId (string) --

        The recommendation identifier associated with the check.