amazonka-support-2.0: Amazon Support SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Support.DescribeTrustedAdvisorChecks

Description

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

Creating a Request

data DescribeTrustedAdvisorChecks Source #

See: newDescribeTrustedAdvisorChecks smart constructor.

Constructors

DescribeTrustedAdvisorChecks' 

Fields

  • language :: Text

    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

Instances

Instances details
ToJSON DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

toJSON :: DescribeTrustedAdvisorChecks -> Value #

toEncoding :: DescribeTrustedAdvisorChecks -> Encoding #

toJSONList :: [DescribeTrustedAdvisorChecks] -> Value #

toEncodingList :: [DescribeTrustedAdvisorChecks] -> Encoding #

ToHeaders DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

toHeaders :: DescribeTrustedAdvisorChecks -> [Header] #

ToPath DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

toPath :: DescribeTrustedAdvisorChecks -> ByteString #

ToQuery DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

toQuery :: DescribeTrustedAdvisorChecks -> QueryString #

AWSRequest DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Associated Types

type AWSResponse DescribeTrustedAdvisorChecks #

Methods

request :: (Service -> Service) -> DescribeTrustedAdvisorChecks -> Request DescribeTrustedAdvisorChecks #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTrustedAdvisorChecks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTrustedAdvisorChecks))) #

Generic DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Associated Types

type Rep DescribeTrustedAdvisorChecks :: Type -> Type #

Methods

from :: DescribeTrustedAdvisorChecks -> Rep DescribeTrustedAdvisorChecks x #

to :: Rep DescribeTrustedAdvisorChecks x -> DescribeTrustedAdvisorChecks #

Read DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

readsPrec :: Int -> ReadS DescribeTrustedAdvisorChecks #

readList :: ReadS [DescribeTrustedAdvisorChecks] #

readPrec :: ReadPrec DescribeTrustedAdvisorChecks #

readListPrec :: ReadPrec [DescribeTrustedAdvisorChecks] #

Show DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

showsPrec :: Int -> DescribeTrustedAdvisorChecks -> ShowS #

show :: DescribeTrustedAdvisorChecks -> String #

showList :: [DescribeTrustedAdvisorChecks] -> ShowS #

NFData DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

rnf :: DescribeTrustedAdvisorChecks -> () #

Eq DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

(==) :: DescribeTrustedAdvisorChecks -> DescribeTrustedAdvisorChecks -> Bool #

(/=) :: DescribeTrustedAdvisorChecks -> DescribeTrustedAdvisorChecks -> Bool #

Hashable DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

hashWithSalt :: Int -> DescribeTrustedAdvisorChecks -> Int #

hash :: DescribeTrustedAdvisorChecks -> Int #

type AWSResponse DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

type AWSResponse DescribeTrustedAdvisorChecks = DescribeTrustedAdvisorChecksResponse
type Rep DescribeTrustedAdvisorChecks Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

type Rep DescribeTrustedAdvisorChecks = D1 ('MetaData "DescribeTrustedAdvisorChecks" "Amazonka.Support.DescribeTrustedAdvisorChecks" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "DescribeTrustedAdvisorChecks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeTrustedAdvisorChecks Source #

Arguments

:: Text

DescribeTrustedAdvisorChecks

-> DescribeTrustedAdvisorChecks 

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.

Constructors

DescribeTrustedAdvisorChecksResponse' 

Fields

Instances

Instances details
Generic DescribeTrustedAdvisorChecksResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Associated Types

type Rep DescribeTrustedAdvisorChecksResponse :: Type -> Type #

Methods

from :: DescribeTrustedAdvisorChecksResponse -> Rep DescribeTrustedAdvisorChecksResponse x #

to :: Rep DescribeTrustedAdvisorChecksResponse x -> DescribeTrustedAdvisorChecksResponse #

Read DescribeTrustedAdvisorChecksResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

readsPrec :: Int -> ReadS DescribeTrustedAdvisorChecksResponse #

readList :: ReadS [DescribeTrustedAdvisorChecksResponse] #

readPrec :: ReadPrec DescribeTrustedAdvisorChecksResponse #

readListPrec :: ReadPrec [DescribeTrustedAdvisorChecksResponse] #

Show DescribeTrustedAdvisorChecksResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

showsPrec :: Int -> DescribeTrustedAdvisorChecksResponse -> ShowS #

show :: DescribeTrustedAdvisorChecksResponse -> String #

showList :: [DescribeTrustedAdvisorChecksResponse] -> ShowS #

NFData DescribeTrustedAdvisorChecksResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

rnf :: DescribeTrustedAdvisorChecksResponse -> () #

Eq DescribeTrustedAdvisorChecksResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

Methods

(==) :: DescribeTrustedAdvisorChecksResponse -> DescribeTrustedAdvisorChecksResponse -> Bool #

(/=) :: DescribeTrustedAdvisorChecksResponse -> DescribeTrustedAdvisorChecksResponse -> Bool #

type Rep DescribeTrustedAdvisorChecksResponse Source # 
Instance details

Defined in Amazonka.Support.DescribeTrustedAdvisorChecks

type Rep DescribeTrustedAdvisorChecksResponse = D1 ('MetaData "DescribeTrustedAdvisorChecksResponse" "Amazonka.Support.DescribeTrustedAdvisorChecks" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "DescribeTrustedAdvisorChecksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "checks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TrustedAdvisorCheckDescription])))

newDescribeTrustedAdvisorChecksResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeTrustedAdvisorChecksResponse'

-> DescribeTrustedAdvisorChecksResponse 

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.