TrustedAdvisor Public API

2023/11/17 - TrustedAdvisor Public API - 10 new api methods

Changes  AWS Trusted Advisor introduces new APIs to enable you to programmatically access Trusted Advisor best practice checks, recommendations, and prioritized recommendations. Trusted Advisor APIs enable you to integrate Trusted Advisor with your operational tools to automate your workloads.

ListChecks (new) Link ¶

List a filterable set of Checks

See also: AWS API Documentation

Request Syntax

client.list_checks(
    awsService='string',
    language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id',
    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'
)
type awsService

string

param awsService

The aws service associated with the check

type language

string

param language

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

type maxResults

integer

param maxResults

The maximum number of results to return per page.

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 pillar

string

param pillar

The pillar of the check

type source

string

param source

The source of the check

rtype

dict

returns

Response Syntax

{
    'checkSummaries': [
        {
            'arn': 'string',
            'awsServices': [
                'string',
            ],
            'description': 'string',
            'id': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • checkSummaries (list) --

      The list of Checks

      • (dict) --

        A summary of an AWS Trusted Advisor Check

        • arn (string) --

          The ARN of the AWS Trusted Advisor Check

        • awsServices (list) --

          The AWS Services that the Check applies to

          • (string) --

        • description (string) --

          A description of what the AWS Trusted Advisor Check is monitoring

        • id (string) --

          The unique identifier of the AWS Trusted Advisor Check

        • metadata (dict) --

          The column headings for the metadata returned in the resource

          • (string) --

            • (string) --

        • name (string) --

          The name of the AWS Trusted Advisor Check

        • pillars (list) --

          The Recommendation pillars that the AWS Trusted Advisor Check falls under

          • (string) --

        • source (string) --

          The source of the Recommendation

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

ListRecommendations (new) Link ¶

List a filterable set of Recommendations

See also: AWS API Documentation

Request Syntax

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'
)
type afterLastUpdatedAt

datetime

param afterLastUpdatedAt

After the last update of the Recommendation

type awsService

string

param awsService

The aws service associated with the Recommendation

type beforeLastUpdatedAt

datetime

param beforeLastUpdatedAt

Before the last update of the Recommendation

type checkIdentifier

string

param checkIdentifier

The check identifier of the Recommendation

type maxResults

integer

param maxResults

The maximum number of results to return per page.

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 pillar

string

param pillar

The pillar of the Recommendation

type source

string

param source

The source of the Recommendation

type status

string

param status

The status of the Recommendation

type type

string

param type

The type of the Recommendation

rtype

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

UpdateOrganizationRecommendationLifecycle (new) Link ¶

Update the lifecyle of a Recommendation within an Organization. This API only supports prioritized recommendations.

See also: AWS API Documentation

Request Syntax

client.update_organization_recommendation_lifecycle(
    lifecycleStage='pending_response'|'in_progress'|'dismissed'|'resolved',
    organizationRecommendationIdentifier='string',
    updateReason='string',
    updateReasonCode='non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other'
)
type lifecycleStage

string

param lifecycleStage

[REQUIRED]

The new lifecycle stage

type organizationRecommendationIdentifier

string

param organizationRecommendationIdentifier

[REQUIRED]

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

type updateReason

string

param updateReason

Reason for the lifecycle stage change

type updateReasonCode

string

param updateReasonCode

Reason code for the lifecycle state change

returns

None

UpdateRecommendationLifecycle (new) Link ¶

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations.

See also: AWS API Documentation

Request Syntax

client.update_recommendation_lifecycle(
    lifecycleStage='pending_response'|'in_progress'|'dismissed'|'resolved',
    recommendationIdentifier='string',
    updateReason='string',
    updateReasonCode='non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other'
)
type lifecycleStage

string

param lifecycleStage

[REQUIRED]

The new lifecycle stage

type recommendationIdentifier

string

param recommendationIdentifier

[REQUIRED]

The Recommendation identifier for AWS Trusted Advisor Priority recommendations

type updateReason

string

param updateReason

Reason for the lifecycle stage change

type updateReasonCode

string

param updateReasonCode

Reason code for the lifecycle state change

returns

None

ListOrganizationRecommendationResources (new) Link ¶

List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations.

See also: AWS API Documentation

Request Syntax

client.list_organization_recommendation_resources(
    affectedAccountId='string',
    maxResults=123,
    nextToken='string',
    organizationRecommendationIdentifier='string',
    regionCode='string',
    status='ok'|'warning'|'error'
)
type affectedAccountId

string

param affectedAccountId

An account affected by this organization recommendation

type maxResults

integer

param maxResults

The maximum number of results to return per page.

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 organizationRecommendationIdentifier

string

param organizationRecommendationIdentifier

[REQUIRED]

The AWS Organization organization's Recommendation identifier

type regionCode

string

param regionCode

The AWS Region code of the resource

type status

string

param status

The status of the resource

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'organizationRecommendationResourceSummaries': [
        {
            'accountId': 'string',
            'arn': 'string',
            'awsResourceId': 'string',
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'metadata': {
                'string': 'string'
            },
            'recommendationArn': 'string',
            'regionCode': 'string',
            'status': 'ok'|'warning'|'error'
        },
    ]
}

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.

    • organizationRecommendationResourceSummaries (list) --

      A list of Recommendation Resources

      • (dict) --

        Organization Recommendation Resource Summary

        • accountId (string) --

          The AWS account ID

        • arn (string) --

          The ARN of the Recommendation Resource

        • awsResourceId (string) --

          The AWS resource identifier

        • id (string) --

          The ID of the Recommendation Resource

        • lastUpdatedAt (datetime) --

          When the Recommendation Resource was last updated

        • metadata (dict) --

          Metadata associated with the Recommendation Resource

          • (string) --

            • (string) --

        • recommendationArn (string) --

          The Recommendation ARN

        • regionCode (string) --

          The AWS Region code that the Recommendation Resource is in

        • status (string) --

          The current status of the Recommendation Resource

GetOrganizationRecommendation (new) Link ¶

Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations.

See also: AWS API Documentation

Request Syntax

client.get_organization_recommendation(
    organizationRecommendationIdentifier='string'
)
type organizationRecommendationIdentifier

string

param organizationRecommendationIdentifier

[REQUIRED]

The Recommendation identifier

rtype

dict

returns

Response Syntax

{
    'organizationRecommendation': {
        '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) --

    • organizationRecommendation (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

ListOrganizationRecommendations (new) Link ¶

List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations.

See also: AWS API Documentation

Request Syntax

client.list_organization_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'
)
type afterLastUpdatedAt

datetime

param afterLastUpdatedAt

After the last update of the Recommendation

type awsService

string

param awsService

The aws service associated with the Recommendation

type beforeLastUpdatedAt

datetime

param beforeLastUpdatedAt

Before the last update of the Recommendation

type checkIdentifier

string

param checkIdentifier

The check identifier of the Recommendation

type maxResults

integer

param maxResults

The maximum number of results to return per page.

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 pillar

string

param pillar

The pillar of the Recommendation

type source

string

param source

The source of the Recommendation

type status

string

param status

The status of the Recommendation

type type

string

param type

The type of the Recommendation

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'organizationRecommendationSummaries': [
        {
            '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.

    • organizationRecommendationSummaries (list) --

      The list of Recommendations

      • (dict) --

        Summary of recommendation for accounts within an Organization

        • 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

ListOrganizationRecommendationAccounts (new) Link ¶

Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.

See also: AWS API Documentation

Request Syntax

client.list_organization_recommendation_accounts(
    affectedAccountId='string',
    maxResults=123,
    nextToken='string',
    organizationRecommendationIdentifier='string'
)
type affectedAccountId

string

param affectedAccountId

An account affected by this organization recommendation

type maxResults

integer

param maxResults

The maximum number of results to return per page.

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 organizationRecommendationIdentifier

string

param organizationRecommendationIdentifier

[REQUIRED]

The Recommendation identifier

rtype

dict

returns

Response Syntax

{
    'accountRecommendationLifecycleSummaries': [
        {
            'accountId': 'string',
            'accountRecommendationArn': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'lifecycleStage': 'in_progress'|'pending_response'|'dismissed'|'resolved',
            'updateReason': 'string',
            'updateReasonCode': 'non_critical_account'|'temporary_account'|'valid_business_case'|'other_methods_available'|'low_priority'|'not_applicable'|'other',
            'updatedOnBehalfOf': 'string',
            'updatedOnBehalfOfJobTitle': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • accountRecommendationLifecycleSummaries (list) --

      The account recommendations lifecycles that are applicable to the Recommendation

      • (dict) --

        Summary of an AccountRecommendationLifecycle for an Organization Recommendation

        • accountId (string) --

          The AWS account ID

        • accountRecommendationArn (string) --

          The Recommendation ARN

        • lastUpdatedAt (datetime) --

          When the Recommendation was last updated

        • lifecycleStage (string) --

          The lifecycle stage from 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

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

ListRecommendationResources (new) Link ¶

List Resources of a Recommendation

See also: AWS API Documentation

Request Syntax

client.list_recommendation_resources(
    maxResults=123,
    nextToken='string',
    recommendationIdentifier='string',
    regionCode='string',
    status='ok'|'warning'|'error'
)
type maxResults

integer

param maxResults

The maximum number of results to return per page.

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 recommendationIdentifier

string

param recommendationIdentifier

[REQUIRED]

The Recommendation identifier

type regionCode

string

param regionCode

The AWS Region code of the resource

type status

string

param status

The status of the resource

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'recommendationResourceSummaries': [
        {
            'arn': 'string',
            'awsResourceId': 'string',
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'metadata': {
                'string': 'string'
            },
            'recommendationArn': 'string',
            'regionCode': 'string',
            'status': 'ok'|'warning'|'error'
        },
    ]
}

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.

    • recommendationResourceSummaries (list) --

      A list of Recommendation Resources

      • (dict) --

        Summary of a Recommendation Resource

        • arn (string) --

          The ARN of the Recommendation Resource

        • awsResourceId (string) --

          The AWS resource identifier

        • id (string) --

          The ID of the Recommendation Resource

        • lastUpdatedAt (datetime) --

          When the Recommendation Resource was last updated

        • metadata (dict) --

          Metadata associated with the Recommendation Resource

          • (string) --

            • (string) --

        • recommendationArn (string) --

          The Recommendation ARN

        • regionCode (string) --

          The AWS Region code that the Recommendation Resource is in

        • status (string) --

          The current status of the Recommendation Resource

GetRecommendation (new) Link ¶

Get a specific Recommendation

See also: AWS API Documentation

Request Syntax

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

string

param recommendationIdentifier

[REQUIRED]

The Recommendation identifier

rtype

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