TrustedAdvisorPublicAPI / Client / get_recommendation

get_recommendation

TrustedAdvisorPublicAPI.Client.get_recommendation(**kwargs)

Get a specific Recommendation

See also: AWS API Documentation

Request Syntax

response = client.get_recommendation(
    recommendationIdentifier='string'
)

Parameters:

recommendationIdentifier (string) –

[REQUIRED]

The Recommendation identifier

Return type:

dict

Returns:

Response Syntax

{
    'recommendation': {
        'arn': 'string',
        'awsServices': [
            'string',
        ],
        'checkArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        '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',
        ],
        'resolvedAt': datetime(2015, 1, 1),
        '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',
        'updateReason': 'string',
        'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other',
        'updatedOnBehalfOf': 'string',
        'updatedOnBehalfOfJobTitle': 'string'
    }
}

Response Structure

• (dict) –

  • recommendation (dict) –

    The Recommendation

    • 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

    • createdBy (string) –

      The creator, if created by AWS Trusted Advisor Priority

    • description (string) –

      A description for AWS Trusted Advisor recommendations

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

    • resolvedAt (datetime) –

      When the Recommendation was resolved

    • 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

    • updateReason (string) –

      Reason for the lifecycle stage change

    • updateReasonCode (string) –

      Reason code for the lifecycle state change

    • 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

Exceptions

• TrustedAdvisorPublicAPI.Client.exceptions.AccessDeniedException

• TrustedAdvisorPublicAPI.Client.exceptions.InternalServerException

• TrustedAdvisorPublicAPI.Client.exceptions.ValidationException

• TrustedAdvisorPublicAPI.Client.exceptions.ResourceNotFoundException

• TrustedAdvisorPublicAPI.Client.exceptions.ThrottlingException