TrustedAdvisorPublicAPI / Client / list_recommendations

list_recommendations

TrustedAdvisorPublicAPI.Client.list_recommendations(**kwargs)

List a filterable set of Recommendations

See also: AWS API Documentation

Request Syntax

response = client.list_recommendations(
    afterLastUpdatedAt=datetime(2015, 1, 1),
    awsService='string',
    beforeLastUpdatedAt=datetime(2015, 1, 1),
    checkIdentifier='string',
    maxResults=123,
    nextToken='string',
    pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
    source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected',
    status='ok'|'warning'|'error',
    type='standard'|'priority'
)

Parameters:

• afterLastUpdatedAt (datetime) – After the last update of the Recommendation

• awsService (string) – The aws service associated with the Recommendation

• beforeLastUpdatedAt (datetime) – Before the last update of the Recommendation

• checkIdentifier (string) – The check identifier of the Recommendation

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

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

• pillar (string) – The pillar of the Recommendation

• source (string) – The source of the Recommendation

• status (string) – The status of the Recommendation

• type (string) – The type of the Recommendation

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'recommendationSummaries': [
        {
            'arn': 'string',
            'awsServices': [
                'string',
            ],
            'checkArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved',
            'name': 'string',
            'pillarSpecificAggregates': {
                'costOptimizing': {
                    'estimatedMonthlySavings': 123.0,
                    'estimatedPercentMonthlySavings': 123.0
                }
            },
            'pillars': [
                'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
            ],
            'resourcesAggregates': {
                'errorCount': 123,
                'okCount': 123,
                'warningCount': 123
            },
            'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected',
            'status': 'ok'|'warning'|'error',
            'type': 'standard'|'priority'
        },
    ]
}

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.

  • recommendationSummaries (list) –

    The list of Recommendations

    • (dict) –

      Summary of Recommendation for an Account

      • arn (string) –

        The ARN of the Recommendation

      • awsServices (list) –

        The AWS Services that the Recommendation applies to

        • (string) –

      • checkArn (string) –

        The AWS Trusted Advisor Check ARN that relates to the Recommendation

      • createdAt (datetime) –

        When the Recommendation was created, if created by AWS Trusted Advisor Priority

      • id (string) –

        The ID which identifies where the Recommendation was produced

      • lastUpdatedAt (datetime) –

        When the Recommendation was last updated

      • lifecycleStage (string) –

        The lifecycle stage from AWS Trusted Advisor Priority

      • name (string) –

        The name of the AWS Trusted Advisor Recommendation

      • pillarSpecificAggregates (dict) –

        The pillar aggregations for cost savings

        • costOptimizing (dict) –

          Cost optimizing aggregates

          • estimatedMonthlySavings (float) –

            The estimated monthly savings

          • estimatedPercentMonthlySavings (float) –

            The estimated percently monthly savings

      • pillars (list) –

        The Pillars that the Recommendation is optimizing

        • (string) –

      • resourcesAggregates (dict) –

        An aggregation of all resources

        • errorCount (integer) –

          The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

        • okCount (integer) –

          The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

        • warningCount (integer) –

          The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

      • source (string) –

        The source of the Recommendation

      • status (string) –

        The status of the Recommendation

      • type (string) –

        Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

Exceptions

• TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException

• TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException

• TrustedAdvisorPublicAPI.Client.exceptions.ValidationException

• TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException