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 |
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.
- 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.
Synopsis
- data DescribeTrustedAdvisorChecks = DescribeTrustedAdvisorChecks' {}
- newDescribeTrustedAdvisorChecks :: Text -> DescribeTrustedAdvisorChecks
- describeTrustedAdvisorChecks_language :: Lens' DescribeTrustedAdvisorChecks Text
- data DescribeTrustedAdvisorChecksResponse = DescribeTrustedAdvisorChecksResponse' {}
- newDescribeTrustedAdvisorChecksResponse :: Int -> DescribeTrustedAdvisorChecksResponse
- describeTrustedAdvisorChecksResponse_httpStatus :: Lens' DescribeTrustedAdvisorChecksResponse Int
- describeTrustedAdvisorChecksResponse_checks :: Lens' DescribeTrustedAdvisorChecksResponse [TrustedAdvisorCheckDescription]
Creating a Request
data DescribeTrustedAdvisorChecks Source #
See: newDescribeTrustedAdvisorChecks
smart constructor.
DescribeTrustedAdvisorChecks' | |
|
Instances
newDescribeTrustedAdvisorChecks Source #
Create a value of DescribeTrustedAdvisorChecks
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:
DescribeTrustedAdvisorChecks
, describeTrustedAdvisorChecks_language
- 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
Request Lenses
describeTrustedAdvisorChecks_language :: Lens' DescribeTrustedAdvisorChecks Text Source #
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
Destructuring the Response
data DescribeTrustedAdvisorChecksResponse Source #
Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
See: newDescribeTrustedAdvisorChecksResponse
smart constructor.
DescribeTrustedAdvisorChecksResponse' | |
|
Instances
newDescribeTrustedAdvisorChecksResponse Source #
Create a value of DescribeTrustedAdvisorChecksResponse
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:httpStatus:DescribeTrustedAdvisorChecksResponse'
, describeTrustedAdvisorChecksResponse_httpStatus
- The response's http status code.
$sel:checks:DescribeTrustedAdvisorChecksResponse'
, describeTrustedAdvisorChecksResponse_checks
- Information about all available Trusted Advisor checks.
Response Lenses
describeTrustedAdvisorChecksResponse_httpStatus :: Lens' DescribeTrustedAdvisorChecksResponse Int Source #
The response's http status code.
describeTrustedAdvisorChecksResponse_checks :: Lens' DescribeTrustedAdvisorChecksResponse [TrustedAdvisorCheckDescription] Source #
Information about all available Trusted Advisor checks.