TrustedAdvisorCategorySpecificSummary
The container for summary information that relates to the category of the Trusted Advisor check.
Contents
costOptimizing
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
Type: TrustedAdvisorCostOptimizingSummary (p. 55) object
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorCheckDescription
TrustedAdvisorCheckDescription
The description and metadata for a Trusted Advisor check.
Contents
category
The category of the Trusted Advisor check.
Type: String description
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
Type: String id
The unique identifier for the Trusted Advisor check.
Type: String metadata
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 (p. 56) 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.
Type: Array of strings name
The display name for the Trusted Advisor check.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorCheckRefreshStatus
TrustedAdvisorCheckRefreshStatus
The refresh status of a Trusted Advisor check.
Contents
checkId
The unique identifier for the Trusted Advisor check.
Type: String
millisUntilNextRefreshable
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
Type: Long status
The status of the Trusted Advisor check for which a refresh has been requested:
• none - The check is not refreshed or the non-success status exceeds the timeout
• enqueued - The check refresh requests has entered the refresh queue
• processing - The check refresh request is picked up by the rule processing engine
• success - The check is successfully refreshed
• abandoned - The check refresh has failed Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorCheckResult
TrustedAdvisorCheckResult
The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult (p. 28).
Contents
categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
Type: TrustedAdvisorCategorySpecificSummary (p. 50) object checkId
The unique identifier for the Trusted Advisor check.
Type: String flaggedResources
The details about each resource listed in the check result.
Type: Array of TrustedAdvisorResourceDetail (p. 56) objects resourcesSummary
Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries (p. 33).
Type: TrustedAdvisorResourcesSummary (p. 57) object status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
Type: String timestamp
The time of the last refresh of the check.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorCheckSummary
TrustedAdvisorCheckSummary
A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
Contents
categorySpecificSummary
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
Type: TrustedAdvisorCategorySpecificSummary (p. 50) object checkId
The unique identifier for the Trusted Advisor check.
Type: String hasFlaggedResources
Specifies whether the Trusted Advisor check has flagged resources.
Type: Boolean resourcesSummary
Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries (p. 33).
Type: TrustedAdvisorResourcesSummary (p. 57) object status
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
Type: String timestamp
The time of the last refresh of the check.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorCostOptimizingSummary
TrustedAdvisorCostOptimizingSummary
The estimated cost savings that might be realized if the recommended operations are taken.
Contents
estimatedMonthlySavings
The estimated monthly savings that might be realized if the recommended operations are taken.
Type: Double
estimatedPercentMonthlySavings
The estimated percentage of savings that might be realized if the recommended operations are taken.
Type: Double
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorResourceDetail
TrustedAdvisorResourceDetail
Contains information about a resource identified by a Trusted Advisor check.
Contents
isSuppressed
Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
Type: Boolean metadata
Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription (p. 51) object returned by the call to DescribeTrustedAdvisorChecks (p. 31). Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
Type: Array of strings region
The AWS Region in which the identified resource is located.
Type: String resourceId
The unique identifier for the identified resource.
Type: String status
The status code for the resource identified in the Trusted Advisor check.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TrustedAdvisorResourcesSummary
TrustedAdvisorResourcesSummary
Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries (p. 33).
Contents
resourcesFlagged
The number of AWS resources that were flagged (listed) by the Trusted Advisor check.
Type: Long resourcesIgnored
The number of AWS resources ignored by Trusted Advisor because information was unavailable.
Type: Long resourcesProcessed
The number of AWS resources that were analyzed by the Trusted Advisor check.
Type: Long resourcesSuppressed
The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.
Type: Long
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3