describe-trusted-advisor-check-result¶
Description¶
Returns the results of the 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:
TrustedAdvisorCategorySpecificSummary
TrustedAdvisorResourceDetail
TrustedAdvisorResourcesSummary
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 Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-trusted-advisor-check-result
--check-id <value>
[--language <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--check-id (string)
The unique identifier for the Trusted Advisor check.
--language (string)
The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support currently supports English (“en”) and Japanese (“ja”). Language parameters must be passed explicitly for operations that take them.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To list the results of an AWS Trusted Advisor check
The following describe-trusted-advisor-check-result example lists the results of the IAM Use check.
aws support describe-trusted-advisor-check-result \
--check-id "zXCkfM1nI3"
Output:
{
"result": {
"checkId": "zXCkfM1nI3",
"timestamp": "2020-05-13T21:38:05Z",
"status": "ok",
"resourcesSummary": {
"resourcesProcessed": 1,
"resourcesFlagged": 0,
"resourcesIgnored": 0,
"resourcesSuppressed": 0
},
"categorySpecificSummary": {
"costOptimizing": {
"estimatedMonthlySavings": 0.0,
"estimatedPercentMonthlySavings": 0.0
}
},
"flaggedResources": [
{
"status": "ok",
"resourceId": "47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZEXAMPLE",
"isSuppressed": false
}
]
}
}
For more information, see AWS Trusted Advisor in the AWS Support User Guide.
Output¶
result -> (structure)
The detailed results of the Trusted Advisor check.
checkId -> (string)
The unique identifier for the Trusted Advisor check.
timestamp -> (string)
The time of the last refresh of the check.
status -> (string)
The alert status of the check: “ok” (green), “warning” (yellow), “error” (red), or “not_available”.
resourcesSummary -> (structure)
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries .
resourcesProcessed -> (long)
The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
resourcesFlagged -> (long)
The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
resourcesIgnored -> (long)
The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
resourcesSuppressed -> (long)
The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
categorySpecificSummary -> (structure)
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
costOptimizing -> (structure)
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
estimatedMonthlySavings -> (double)
The estimated monthly savings that might be realized if the recommended operations are taken.
estimatedPercentMonthlySavings -> (double)
The estimated percentage of savings that might be realized if the recommended operations are taken.
flaggedResources -> (list)
The details about each resource listed in the check result.
(structure)
Contains information about a resource identified by a Trusted Advisor check.
status -> (string)
The status code for the resource identified in the Trusted Advisor check.
region -> (string)
The Amazon Web Services Region in which the identified resource is located.
resourceId -> (string)
The unique identifier for the identified resource.
isSuppressed -> (boolean)
Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
metadata -> (list)
Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks . Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
(string)