2026/02/20 - TrustedAdvisor Public API - 6 updated api methods
Changes Adding a new enum attribute(statusReason) to TrustedAdvisorAPI response. This attribute explains reasoning behind check status for certain specific scenarios.
{'organizationRecommendation': {'resourcesAggregates': {'excludedCount': 'long'},
'source': {'cost_optimization_hub'}}}
Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.
See also: AWS API Documentation
Request Syntax
client.get_organization_recommendation(
organizationRecommendationIdentifier='string'
)
string
[REQUIRED]
The Recommendation identifier
dict
Response Syntax
{
'organizationRecommendation': {
'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',
'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) --
organizationRecommendation (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
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
{'language': 'en | ja | zh | fr | de | ko | zh_TW | it | es | pt_BR | id'}
Response {'recommendation': {'resourcesAggregates': {'excludedCount': 'long'},
'source': {'cost_optimization_hub'},
'statusReason': 'no_data_ok'}}
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
client.get_recommendation(
recommendationIdentifier='string',
language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)
string
[REQUIRED]
The Recommendation identifier
string
The ISO 639-1 code for the language that you want your recommendations to appear in.
dict
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
{'source': {'cost_optimization_hub'}}
Response {'checkSummaries': {'source': {'cost_optimization_hub'}}}
List a filterable set of Checks. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
See also: AWS API Documentation
Request Syntax
client.list_checks(
nextToken='string',
maxResults=123,
pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
awsService='string',
source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)
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.
integer
The maximum number of results to return per page.
string
The pillar of the check
string
The aws service associated with the check
string
The source of the check
string
The ISO 639-1 code for the language that you want your checks to appear in.
dict
Response Syntax
{
'nextToken': 'string',
'checkSummaries': [
{
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'pillars': [
'cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
],
'awsServices': [
'string',
],
'source': 'aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
'metadata': {
'string': 'string'
}
},
]
}
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.
checkSummaries (list) --
The list of Checks
(dict) --
A summary of an AWS Trusted Advisor Check
id (string) --
The unique identifier of the AWS Trusted Advisor Check
arn (string) --
The ARN of the AWS Trusted Advisor Check
name (string) --
The name of the AWS Trusted Advisor Check
description (string) --
A description of what the AWS Trusted Advisor Check is monitoring
pillars (list) --
The Recommendation pillars that the AWS Trusted Advisor Check falls under
(string) --
awsServices (list) --
The AWS Services that the Check applies to
(string) --
source (string) --
The source of the Recommendation
metadata (dict) --
The column headings for the metadata returned in the resource
(string) --
(string) --
{'source': {'cost_optimization_hub'}}
Response {'organizationRecommendationSummaries': {'resourcesAggregates': {'excludedCount': 'long'},
'source': {'cost_optimization_hub'}}}
List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.
See also: AWS API Documentation
Request Syntax
client.list_organization_recommendations(
nextToken='string',
maxResults=123,
type='standard'|'priority',
status='ok'|'warning'|'error',
pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
awsService='string',
source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
checkIdentifier='string',
afterLastUpdatedAt=datetime(2015, 1, 1),
beforeLastUpdatedAt=datetime(2015, 1, 1)
)
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.
integer
The maximum number of results to return per page.
string
The type of the Recommendation
string
The status of the Recommendation
string
The pillar of the Recommendation
string
The aws service associated with the Recommendation
string
The source of the Recommendation
string
The check identifier of the Recommendation
datetime
After the last update of the Recommendation
datetime
Before the last update of the Recommendation
dict
Response Syntax
{
'nextToken': 'string',
'organizationRecommendationSummaries': [
{
'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'
},
]
}
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
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
{'language': 'en | ja | zh | fr | de | ko | zh_TW | it | es | pt_BR | id'}
List Resources of a Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
See also: AWS API Documentation
Request Syntax
client.list_recommendation_resources(
nextToken='string',
maxResults=123,
status='ok'|'warning'|'error',
exclusionStatus='excluded'|'included',
regionCode='string',
recommendationIdentifier='string',
language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)
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.
integer
The maximum number of results to return per page.
string
The status of the resource
string
The exclusion status of the resource
string
The AWS Region code of the resource
string
[REQUIRED]
The Recommendation identifier
string
The ISO 639-1 code for the language that you want your recommendations to appear in.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationResourceSummaries': [
{
'id': 'string',
'arn': 'string',
'awsResourceId': 'string',
'regionCode': 'string',
'status': 'ok'|'warning'|'error',
'metadata': {
'string': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'exclusionStatus': 'excluded'|'included',
'recommendationArn': 'string'
},
]
}
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
id (string) --
The ID of the Recommendation Resource
arn (string) --
The ARN of the Recommendation Resource
awsResourceId (string) --
The AWS resource identifier. There are certain checks that generate recommendation resources without an awsResourceId.
regionCode (string) --
The AWS Region code that the Recommendation Resource is in
status (string) --
The current status of the Recommendation Resource
metadata (dict) --
Metadata associated with the Recommendation Resource
(string) --
(string) --
lastUpdatedAt (datetime) --
When the Recommendation Resource was last updated
exclusionStatus (string) --
The exclusion status of the Recommendation Resource
recommendationArn (string) --
The Recommendation ARN
{'language': 'en | ja | zh | fr | de | ko | zh_TW | it | es | pt_BR | id',
'source': {'cost_optimization_hub'}}
Response {'recommendationSummaries': {'resourcesAggregates': {'excludedCount': 'long'},
'source': {'cost_optimization_hub'},
'statusReason': 'no_data_ok'}}
List a filterable set of Recommendations. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
nextToken='string',
maxResults=123,
type='standard'|'priority',
status='ok'|'warning'|'error',
pillar='cost_optimizing'|'performance'|'security'|'service_limits'|'fault_tolerance'|'operational_excellence',
awsService='string',
source='aws_config'|'compute_optimizer'|'cost_explorer'|'lse'|'manual'|'pse'|'rds'|'resilience'|'resilience_hub'|'security_hub'|'stir'|'ta_check'|'well_architected'|'cost_optimization_hub',
checkIdentifier='string',
afterLastUpdatedAt=datetime(2015, 1, 1),
beforeLastUpdatedAt=datetime(2015, 1, 1),
language='en'|'ja'|'zh'|'fr'|'de'|'ko'|'zh_TW'|'it'|'es'|'pt_BR'|'id'
)
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.
integer
The maximum number of results to return per page.
string
The type of the Recommendation
string
The status of the Recommendation
string
The pillar of the Recommendation
string
The aws service associated with the Recommendation
string
The source of the Recommendation
string
The check identifier of the Recommendation
datetime
After the last update of the Recommendation
datetime
Before the last update of the Recommendation
string
The ISO 639-1 code for the language that you want your recommendations to appear in.
dict
Response Syntax
{
'nextToken': 'string',
'recommendationSummaries': [
{
'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'
},
]
}
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
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.