TrustedAdvisorPublicAPI / Client / list_recommendations_for_resource

list_recommendations_for_resource

TrustedAdvisorPublicAPI.Client.list_recommendations_for_resource(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = 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'
)
Parameters:

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

  • maxResults (integer) – The maximum number of results to return per page

  • awsResourceArn (string) –

    [REQUIRED]

    The ARN of the AWS resource to query recommendations for

  • pillar (string) – The pillar that the recommendation belongs to

  • status (string) – The current status of the Recommendation Resource

  • checkArn (string) – The AWS Trusted Advisor Check ARN that relates to the Recommendation

  • language (string) – The ISO 639-1 code for the language that you want your recommendations to appear in.

Return type:

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) –

Exceptions

  • TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException

  • TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException

  • TrustedAdvisorPublicAPI.Client.exceptions.ValidationException

  • TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException