Skip to content

Describe Trusted Advisor Check Result

support_describe_trusted_advisor_check_result R Documentation

Returns the results of the Trusted Advisor check that has the specified check ID

Description

Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the describe_trusted_advisor_checks operation.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

  • TrustedAdvisorCategorySpecificSummary

  • TrustedAdvisorResourceDetail

  • TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

  • status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.

  • timestamp - The time of the last refresh of the check.

  • checkId - The unique identifier for the check.

  • 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

support_describe_trusted_advisor_check_result(checkId, language)

Arguments

checkId

[required] The unique identifier for the Trusted Advisor check.

language

The ISO 639-1 code for the language that you want your check results 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

Value

A list with the following syntax: 

list(
  result = list(
    checkId = "string",
    timestamp = "string",
    status = "string",
    resourcesSummary = list(
      resourcesProcessed = 123,
      resourcesFlagged = 123,
      resourcesIgnored = 123,
      resourcesSuppressed = 123
    ),
    categorySpecificSummary = list(
      costOptimizing = list(
        estimatedMonthlySavings = 123.0,
        estimatedPercentMonthlySavings = 123.0
      )
    ),
    flaggedResources = list(
      list(
        status = "string",
        region = "string",
        resourceId = "string",
        isSuppressed = TRUE|FALSE,
        metadata = list(
          "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_trusted_advisor_check_result(
  checkId = "string",
  language = "string"
)