Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Support.DescribeTrustedAdvisorCheckResult

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the results of the AWS 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), 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 or Enterprise Support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Synopsis

Creating a Request

data DescribeTrustedAdvisorCheckResult Source #

See: newDescribeTrustedAdvisorCheckResult smart constructor.

Constructors

DescribeTrustedAdvisorCheckResult'
Fields language :: Maybe Text The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. checkId :: Text The unique identifier for the Trusted Advisor check.

Instances

Instances details

Eq DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods (==) :: DescribeTrustedAdvisorCheckResult -> DescribeTrustedAdvisorCheckResult -> Bool # (/=) :: DescribeTrustedAdvisorCheckResult -> DescribeTrustedAdvisorCheckResult -> Bool #
Read DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods readsPrec :: Int -> ReadS DescribeTrustedAdvisorCheckResult # readList :: ReadS [DescribeTrustedAdvisorCheckResult] # readPrec :: ReadPrec DescribeTrustedAdvisorCheckResult # readListPrec :: ReadPrec [DescribeTrustedAdvisorCheckResult] #
Show DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods showsPrec :: Int -> DescribeTrustedAdvisorCheckResult -> ShowS # show :: DescribeTrustedAdvisorCheckResult -> String # showList :: [DescribeTrustedAdvisorCheckResult] -> ShowS #
Generic DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Associated Types type Rep DescribeTrustedAdvisorCheckResult :: Type -> Type # Methods from :: DescribeTrustedAdvisorCheckResult -> Rep DescribeTrustedAdvisorCheckResult x # to :: Rep DescribeTrustedAdvisorCheckResult x -> DescribeTrustedAdvisorCheckResult #
NFData DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods rnf :: DescribeTrustedAdvisorCheckResult -> () #
Hashable DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods hashWithSalt :: Int -> DescribeTrustedAdvisorCheckResult -> Int # hash :: DescribeTrustedAdvisorCheckResult -> Int #
ToJSON DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods toJSON :: DescribeTrustedAdvisorCheckResult -> Value # toEncoding :: DescribeTrustedAdvisorCheckResult -> Encoding # toJSONList :: [DescribeTrustedAdvisorCheckResult] -> Value # toEncodingList :: [DescribeTrustedAdvisorCheckResult] -> Encoding #
AWSRequest DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Associated Types type AWSResponse DescribeTrustedAdvisorCheckResult # Methods request :: DescribeTrustedAdvisorCheckResult -> Request DescribeTrustedAdvisorCheckResult # response :: MonadResource m => Logger -> Service -> Proxy DescribeTrustedAdvisorCheckResult -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTrustedAdvisorCheckResult))) #
ToHeaders DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods toHeaders :: DescribeTrustedAdvisorCheckResult -> [Header] #
ToPath DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods toPath :: DescribeTrustedAdvisorCheckResult -> ByteString #
ToQuery DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods toQuery :: DescribeTrustedAdvisorCheckResult -> QueryString #
type Rep DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult type Rep DescribeTrustedAdvisorCheckResult = D1 ('MetaData "DescribeTrustedAdvisorCheckResult" "Amazonka.Support.DescribeTrustedAdvisorCheckResult" "libZSservicesZSamazonka-supportZSamazonka-support" 'False) (C1 ('MetaCons "DescribeTrustedAdvisorCheckResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "checkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeTrustedAdvisorCheckResult Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult type AWSResponse DescribeTrustedAdvisorCheckResult = DescribeTrustedAdvisorCheckResultResponse

newDescribeTrustedAdvisorCheckResult Source #

Arguments

:: Text	`$sel:checkId:DescribeTrustedAdvisorCheckResult'`
-> DescribeTrustedAdvisorCheckResult

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:

$sel:language:DescribeTrustedAdvisorCheckResult', describeTrustedAdvisorCheckResult_language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

$sel:checkId: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 in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

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 result :: Maybe TrustedAdvisorCheckResult The detailed results of the Trusted Advisor check. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeTrustedAdvisorCheckResultResponse Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods (==) :: DescribeTrustedAdvisorCheckResultResponse -> DescribeTrustedAdvisorCheckResultResponse -> Bool # (/=) :: DescribeTrustedAdvisorCheckResultResponse -> DescribeTrustedAdvisorCheckResultResponse -> Bool #
Read DescribeTrustedAdvisorCheckResultResponse Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods readsPrec :: Int -> ReadS DescribeTrustedAdvisorCheckResultResponse # readList :: ReadS [DescribeTrustedAdvisorCheckResultResponse] # readPrec :: ReadPrec DescribeTrustedAdvisorCheckResultResponse # readListPrec :: ReadPrec [DescribeTrustedAdvisorCheckResultResponse] #
Show DescribeTrustedAdvisorCheckResultResponse Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods showsPrec :: Int -> DescribeTrustedAdvisorCheckResultResponse -> ShowS # show :: DescribeTrustedAdvisorCheckResultResponse -> String # showList :: [DescribeTrustedAdvisorCheckResultResponse] -> ShowS #
Generic DescribeTrustedAdvisorCheckResultResponse Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Associated Types type Rep DescribeTrustedAdvisorCheckResultResponse :: Type -> Type # Methods from :: DescribeTrustedAdvisorCheckResultResponse -> Rep DescribeTrustedAdvisorCheckResultResponse x # to :: Rep DescribeTrustedAdvisorCheckResultResponse x -> DescribeTrustedAdvisorCheckResultResponse #
NFData DescribeTrustedAdvisorCheckResultResponse Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult Methods rnf :: DescribeTrustedAdvisorCheckResultResponse -> () #
type Rep DescribeTrustedAdvisorCheckResultResponse Source #
Instance details Defined in Amazonka.Support.DescribeTrustedAdvisorCheckResult type Rep DescribeTrustedAdvisorCheckResultResponse = D1 ('MetaData "DescribeTrustedAdvisorCheckResultResponse" "Amazonka.Support.DescribeTrustedAdvisorCheckResult" "libZSservicesZSamazonka-supportZSamazonka-support" 'False) (C1 ('MetaCons "DescribeTrustedAdvisorCheckResultResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrustedAdvisorCheckResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeTrustedAdvisorCheckResultResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTrustedAdvisorCheckResultResponse'`
-> 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.