DescribeTrustedAdvisorCheckResult
Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
-
status - The alert status of the check can be
ok(green),warning(yellow),error(red), ornot_available. -
timestamp - The time of the last refresh of the check.
-
checkId - The unique identifier for the check.
Note
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API.
-
If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see AWS Support.
To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the AWS Support API in the AWS Support User Guide.
Request Syntax
{
"checkId": "string",
"language": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- checkId
-
The unique identifier for the Trusted Advisor check.
Type: String
- language
-
The ISO 639-1 code for the language that you want your check results to appear in.
The Support API currently supports the following languages for Trusted Advisor:
-
Chinese, Simplified -
zh -
Chinese, Traditional -
zh_TW -
English -
en -
French -
fr -
German -
de -
Indonesian -
id -
Italian -
it -
Japanese -
ja -
Korean -
ko -
Portuguese, Brazilian -
pt_BR -
Spanish -
es
Type: String
-
Response Syntax
{
"result": {
"categorySpecificSummary": {
"costOptimizing": {
"estimatedMonthlySavings": number,
"estimatedPercentMonthlySavings": number
}
},
"checkId": "string",
"flaggedResources": [
{
"isSuppressed": boolean,
"metadata": [ "string" ],
"region": "string",
"resourceId": "string",
"status": "string"
}
],
"resourcesSummary": {
"resourcesFlagged": number,
"resourcesIgnored": number,
"resourcesProcessed": number,
"resourcesSuppressed": number
},
"status": "string",
"timestamp": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- result
-
The detailed results of the Trusted Advisor check.
Type: TrustedAdvisorCheckResult object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error occurred.
HTTP Status Code: 500
- ThrottlingException
-
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
