DescribeTrustedAdvisorCheckSummaries - AWS Support

DescribeTrustedAdvisorCheckSummaries

Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

The response contains an array of TrustedAdvisorCheckSummary objects.

Note
  • You must have a Business or Enterprise support plan to use the AWS Support API.

  • If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Request Syntax

{ "checkIds": [ "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.

checkIds

The IDs of the Trusted Advisor checks.

Type: Array of strings

Response Syntax

{ "summaries": [ { "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "checkId": "string", "hasFlaggedResources": boolean, "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.

summaries

The summary information for the requested Trusted Advisor checks.

Type: Array of TrustedAdvisorCheckSummary objects

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: