amazonka-support-1.4.4: Amazon Support SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Support.RefreshTrustedAdvisorCheck

Contents

Description

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

  • status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
  • millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
  • checkId. The unique identifier for the check.

Synopsis

Creating a Request

refreshTrustedAdvisorCheck Source #

Creates a value of RefreshTrustedAdvisorCheck with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data RefreshTrustedAdvisorCheck Source #

See: refreshTrustedAdvisorCheck smart constructor.

Instances

Eq RefreshTrustedAdvisorCheck Source # 
Data RefreshTrustedAdvisorCheck Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RefreshTrustedAdvisorCheck -> c RefreshTrustedAdvisorCheck #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RefreshTrustedAdvisorCheck #

toConstr :: RefreshTrustedAdvisorCheck -> Constr #

dataTypeOf :: RefreshTrustedAdvisorCheck -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RefreshTrustedAdvisorCheck) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RefreshTrustedAdvisorCheck) #

gmapT :: (forall b. Data b => b -> b) -> RefreshTrustedAdvisorCheck -> RefreshTrustedAdvisorCheck #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RefreshTrustedAdvisorCheck -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RefreshTrustedAdvisorCheck -> r #

gmapQ :: (forall d. Data d => d -> u) -> RefreshTrustedAdvisorCheck -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RefreshTrustedAdvisorCheck -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RefreshTrustedAdvisorCheck -> m RefreshTrustedAdvisorCheck #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RefreshTrustedAdvisorCheck -> m RefreshTrustedAdvisorCheck #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RefreshTrustedAdvisorCheck -> m RefreshTrustedAdvisorCheck #

Read RefreshTrustedAdvisorCheck Source # 
Show RefreshTrustedAdvisorCheck Source # 
Generic RefreshTrustedAdvisorCheck Source # 
Hashable RefreshTrustedAdvisorCheck Source # 
NFData RefreshTrustedAdvisorCheck Source # 
AWSRequest RefreshTrustedAdvisorCheck Source # 
ToPath RefreshTrustedAdvisorCheck Source # 
ToHeaders RefreshTrustedAdvisorCheck Source # 
ToQuery RefreshTrustedAdvisorCheck Source # 
ToJSON RefreshTrustedAdvisorCheck Source # 
type Rep RefreshTrustedAdvisorCheck Source # 
type Rep RefreshTrustedAdvisorCheck = D1 (MetaData "RefreshTrustedAdvisorCheck" "Network.AWS.Support.RefreshTrustedAdvisorCheck" "amazonka-support-1.4.4-JEM9W1YDe7G2rp2qbVhRRN" True) (C1 (MetaCons "RefreshTrustedAdvisorCheck'" PrefixI True) (S1 (MetaSel (Just Symbol "_rtacCheckId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs RefreshTrustedAdvisorCheck Source # 

Request Lenses

rtacCheckId :: Lens' RefreshTrustedAdvisorCheck Text Source #

The unique identifier for the Trusted Advisor check to refresh. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Destructuring the Response

refreshTrustedAdvisorCheckResponse Source #

Creates a value of RefreshTrustedAdvisorCheckResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data RefreshTrustedAdvisorCheckResponse Source #

The current refresh status of a Trusted Advisor check.

See: refreshTrustedAdvisorCheckResponse smart constructor.

Instances

Eq RefreshTrustedAdvisorCheckResponse Source # 
Data RefreshTrustedAdvisorCheckResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RefreshTrustedAdvisorCheckResponse -> c RefreshTrustedAdvisorCheckResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RefreshTrustedAdvisorCheckResponse #

toConstr :: RefreshTrustedAdvisorCheckResponse -> Constr #

dataTypeOf :: RefreshTrustedAdvisorCheckResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RefreshTrustedAdvisorCheckResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RefreshTrustedAdvisorCheckResponse) #

gmapT :: (forall b. Data b => b -> b) -> RefreshTrustedAdvisorCheckResponse -> RefreshTrustedAdvisorCheckResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RefreshTrustedAdvisorCheckResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RefreshTrustedAdvisorCheckResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> RefreshTrustedAdvisorCheckResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RefreshTrustedAdvisorCheckResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RefreshTrustedAdvisorCheckResponse -> m RefreshTrustedAdvisorCheckResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RefreshTrustedAdvisorCheckResponse -> m RefreshTrustedAdvisorCheckResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RefreshTrustedAdvisorCheckResponse -> m RefreshTrustedAdvisorCheckResponse #

Read RefreshTrustedAdvisorCheckResponse Source # 
Show RefreshTrustedAdvisorCheckResponse Source # 
Generic RefreshTrustedAdvisorCheckResponse Source # 
NFData RefreshTrustedAdvisorCheckResponse Source # 
type Rep RefreshTrustedAdvisorCheckResponse Source # 
type Rep RefreshTrustedAdvisorCheckResponse = D1 (MetaData "RefreshTrustedAdvisorCheckResponse" "Network.AWS.Support.RefreshTrustedAdvisorCheck" "amazonka-support-1.4.4-JEM9W1YDe7G2rp2qbVhRRN" False) (C1 (MetaCons "RefreshTrustedAdvisorCheckResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtacrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_rtacrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TrustedAdvisorCheckRefreshStatus))))

Response Lenses

rtacrsStatus :: Lens' RefreshTrustedAdvisorCheckResponse TrustedAdvisorCheckRefreshStatus Source #

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