DescribeTrustedAdvisorChecks - AWS Support

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 AWS Support API currently supports English ("en") and Japanese ("ja"). 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 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.

  • 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.

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 in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

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

See Also

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