TrustedAdvisorPublicAPI / Client / get_recommendation

get_recommendation

TrustedAdvisorPublicAPI.Client.get_recommendation(**kwargs)

Get a specific Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

See also: AWS API Documentation

Request Syntax

response = client.get_recommendation(
    recommendationIdentifier='string',
    language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)
Parameters:

  • recommendationIdentifier (string) –

    [REQUIRED]

    The Recommendation identifier

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

Return type:

dict

Returns:

Response Syntax

{
    'recommendation': {
        'id': 'string',
        'type': 'standard'|'priority',
        'checkArn': 'string',
        'status': 'ok'|'warning'|'error',
        'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved',
        'pillars': [
            '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'|'cost_optimization_hub',
        'awsServices': [
            'string',
        ],
        'name': 'string',
        'resourcesAggregates': {
            'okCount': 123,
            'warningCount': 123,
            'errorCount': 123,
            'excludedCount': 123
        },
        'pillarSpecificAggregates': {
            'costOptimizing': {
                'estimatedMonthlySavings': 123.0,
                'estimatedPercentMonthlySavings': 123.0
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1),
        'arn': 'string',
        'statusReason': 'no_data_ok',
        'description': 'string',
        'createdBy': 'string',
        'updatedOnBehalfOf': 'string',
        'updatedOnBehalfOfJobTitle': 'string',
        'updateReason': 'string',
        'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other',
        'resolvedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • recommendation (dict) –

      The Recommendation

      • id (string) –

        The ID which identifies where the Recommendation was produced

      • type (string) –

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

      • checkArn (string) –

        The AWS Trusted Advisor Check ARN that relates to the Recommendation

      • status (string) –

        The status of the Recommendation

      • lifecycleStage (string) –

        The lifecycle stage from AWS Trusted Advisor Priority

      • pillars (list) –

        The Pillars that the Recommendation is optimizing

        • (string) –

      • source (string) –

        The source of the Recommendation

      • awsServices (list) –

        The AWS Services that the Recommendation applies to

        • (string) –

      • name (string) –

        The name of the AWS Trusted Advisor Recommendation

      • resourcesAggregates (dict) –

        An aggregation of all resources

        • 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

        • errorCount (integer) –

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

        • excludedCount (integer) –

          The number of AWS resources belonging to this Trusted Advisor check that were excluded by the customer

      • 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

      • createdAt (datetime) –

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

      • lastUpdatedAt (datetime) –

        When the Recommendation was last updated

      • arn (string) –

        The ARN of the Recommendation

      • statusReason (string) –

        This attribute provides additional details about potential discrepancies in check status determination.

      • description (string) –

        A description for AWS Trusted Advisor recommendations

      • createdBy (string) –

        The creator, if created by AWS Trusted Advisor Priority

      • updatedOnBehalfOf (string) –

        The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

      • updatedOnBehalfOfJobTitle (string) –

        The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

      • updateReason (string) –

        Reason for the lifecycle stage change

      • updateReasonCode (string) –

        Reason code for the lifecycle state change

      • resolvedAt (datetime) –

        When the Recommendation was resolved

Exceptions