| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Support.DescribeTrustedAdvisorCheckResult
Description
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks 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), ornot_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
SubscriptionRequiredExceptionerror 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.
Synopsis
- data DescribeTrustedAdvisorCheckResult = DescribeTrustedAdvisorCheckResult' {}
- newDescribeTrustedAdvisorCheckResult :: Text -> DescribeTrustedAdvisorCheckResult
- describeTrustedAdvisorCheckResult_language :: Lens' DescribeTrustedAdvisorCheckResult (Maybe Text)
- describeTrustedAdvisorCheckResult_checkId :: Lens' DescribeTrustedAdvisorCheckResult Text
- data DescribeTrustedAdvisorCheckResultResponse = DescribeTrustedAdvisorCheckResultResponse' {}
- newDescribeTrustedAdvisorCheckResultResponse :: Int -> DescribeTrustedAdvisorCheckResultResponse
- describeTrustedAdvisorCheckResultResponse_result :: Lens' DescribeTrustedAdvisorCheckResultResponse (Maybe TrustedAdvisorCheckResult)
- describeTrustedAdvisorCheckResultResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckResultResponse Int
Creating a Request
data DescribeTrustedAdvisorCheckResult Source #
See: newDescribeTrustedAdvisorCheckResult smart constructor.
Constructors
| DescribeTrustedAdvisorCheckResult' | |
Fields
| |
Instances
newDescribeTrustedAdvisorCheckResult Source #
Create a value of DescribeTrustedAdvisorCheckResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTrustedAdvisorCheckResult, describeTrustedAdvisorCheckResult_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
DescribeTrustedAdvisorCheckResult, describeTrustedAdvisorCheckResult_checkId - The unique identifier for the Trusted Advisor check.
Request Lenses
describeTrustedAdvisorCheckResult_language :: Lens' DescribeTrustedAdvisorCheckResult (Maybe Text) Source #
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
describeTrustedAdvisorCheckResult_checkId :: Lens' DescribeTrustedAdvisorCheckResult Text Source #
The unique identifier for the Trusted Advisor check.
Destructuring the Response
data DescribeTrustedAdvisorCheckResultResponse Source #
The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
See: newDescribeTrustedAdvisorCheckResultResponse smart constructor.
Constructors
| DescribeTrustedAdvisorCheckResultResponse' | |
Fields
| |
Instances
newDescribeTrustedAdvisorCheckResultResponse Source #
Arguments
| :: Int | |
| -> DescribeTrustedAdvisorCheckResultResponse |
Create a value of DescribeTrustedAdvisorCheckResultResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:result:DescribeTrustedAdvisorCheckResultResponse', describeTrustedAdvisorCheckResultResponse_result - The detailed results of the Trusted Advisor check.
$sel:httpStatus:DescribeTrustedAdvisorCheckResultResponse', describeTrustedAdvisorCheckResultResponse_httpStatus - The response's http status code.
Response Lenses
describeTrustedAdvisorCheckResultResponse_result :: Lens' DescribeTrustedAdvisorCheckResultResponse (Maybe TrustedAdvisorCheckResult) Source #
The detailed results of the Trusted Advisor check.
describeTrustedAdvisorCheckResultResponse_httpStatus :: Lens' DescribeTrustedAdvisorCheckResultResponse Int Source #
The response's http status code.