Support / Client / describe_trusted_advisor_checks

describe_trusted_advisor_checks#

Support.Client.describe_trusted_advisor_checks(**kwargs)#

Returns information about all available 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 Amazon Web Services Region to us-east-1.

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

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

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_advisor_checks(
    language='string'
)
Parameters:

language (string) –

[REQUIRED]

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

The Amazon Web Services 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

Return type:

dict

Returns:

Response Syntax

{
    'checks': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'category': 'string',
            'metadata': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) –

    Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

    • checks (list) –

      Information about all available Trusted Advisor checks.

      • (dict) –

        The description and metadata for a Trusted Advisor check.

        • id (string) –

          The unique identifier for the Trusted Advisor check.

        • name (string) –

          The display name for the Trusted Advisor check.

        • description (string) –

          The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).

        • category (string) –

          The category of the Trusted Advisor check.

        • metadata (list) –

          The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

          • (string) –

Exceptions

  • Support.Client.exceptions.InternalServerError

  • Support.Client.exceptions.ThrottlingException