Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeTrustedAdvisorChecks

Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.

The response contains a TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to us-east-1.

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 SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.

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


{
   "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.

language

The ISO 639-1 code for the language that you want your checks to appear in.

The AWS 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


{
   "checks": [ 
      { 
         "category": "string",
         "description": "string",
         "id": "string",
         "metadata": [ "string" ],
         "name": "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.

checks

Information about all available Trusted Advisor checks.

Type: Array of TrustedAdvisorCheckDescription 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

ThrottlingException

You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.

HTTP Status Code: 400