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.RefreshTrustedAdvisorCheck

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.

Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object.

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.

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.

Creating a Request

data RefreshTrustedAdvisorCheck Source #

See: newRefreshTrustedAdvisorCheck smart constructor.

Constructors

RefreshTrustedAdvisorCheck'
Fields checkId :: Text The unique identifier for the Trusted Advisor check to refresh. Specifying the check ID of a check that is automatically refreshed causes an `InvalidParameterValue` error.

Instances

Instances details

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

newRefreshTrustedAdvisorCheck Source #

Arguments

:: Text	`RefreshTrustedAdvisorCheck`
-> RefreshTrustedAdvisorCheck

Create a value of RefreshTrustedAdvisorCheck 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:

RefreshTrustedAdvisorCheck, refreshTrustedAdvisorCheck_checkId - The unique identifier for the Trusted Advisor check to refresh.

Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Request Lenses

refreshTrustedAdvisorCheck_checkId :: Lens' RefreshTrustedAdvisorCheck Text Source #

The unique identifier for the Trusted Advisor check to refresh.

Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Destructuring the Response

data RefreshTrustedAdvisorCheckResponse Source #

The current refresh status of a Trusted Advisor check.

See: newRefreshTrustedAdvisorCheckResponse smart constructor.

Constructors

RefreshTrustedAdvisorCheckResponse'
Fields httpStatus :: Int The response's http status code. status :: TrustedAdvisorCheckRefreshStatus The current refresh status for a check, including the amount of time until the check is eligible for refresh.

Instances

Instances details

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

newRefreshTrustedAdvisorCheckResponse Source #

Arguments

:: Int	`$sel:httpStatus:RefreshTrustedAdvisorCheckResponse'`
-> TrustedAdvisorCheckRefreshStatus	`RefreshTrustedAdvisorCheckResponse`
-> RefreshTrustedAdvisorCheckResponse

Create a value of RefreshTrustedAdvisorCheckResponse 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:RefreshTrustedAdvisorCheckResponse', refreshTrustedAdvisorCheckResponse_httpStatus - The response's http status code.

RefreshTrustedAdvisorCheckResponse, refreshTrustedAdvisorCheckResponse_status - The current refresh status for a check, including the amount of time until the check is eligible for refresh.

Response Lenses

refreshTrustedAdvisorCheckResponse_httpStatus :: Lens' RefreshTrustedAdvisorCheckResponse Int Source #

The response's http status code.

refreshTrustedAdvisorCheckResponse_status :: Lens' RefreshTrustedAdvisorCheckResponse TrustedAdvisorCheckRefreshStatus Source #

The current refresh status for a check, including the amount of time until the check is eligible for refresh.