Describe Trusted Advisor Check Summaries
support_describe_trusted_advisor_check_summaries | R Documentation |
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified¶
Description¶
Returns the results for the Trusted Advisor check summaries for the
check IDs that you specified. You can get the check IDs by calling the
describe_trusted_advisor_checks
operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
-
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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services 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 Amazon Web Services Support API in the Amazon Web Services Support User Guide.
Usage¶
Arguments¶
checkIds
[required] The IDs of the Trusted Advisor checks.
Value¶
A list with the following syntax:
list(
summaries = list(
list(
checkId = "string",
timestamp = "string",
status = "string",
hasFlaggedResources = TRUE|FALSE,
resourcesSummary = list(
resourcesProcessed = 123,
resourcesFlagged = 123,
resourcesIgnored = 123,
resourcesSuppressed = 123
),
categorySpecificSummary = list(
costOptimizing = list(
estimatedMonthlySavings = 123.0,
estimatedPercentMonthlySavings = 123.0
)
)
)
)
)