amazonka-opsworks-cm-1.4.5: Amazon OpsWorks for Chef Automate 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.OpsWorksCM.StartMaintenance

Contents

Description

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server will switch to UNDER_MAINTENANCE state, while maintenace is in progress.

Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

Synopsis

Creating a Request

startMaintenance #

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

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

  • smServerName - The name of the server on which to run maintenance.

data StartMaintenance #

See: startMaintenance smart constructor.

Instances

Eq StartMaintenance # 
Data StartMaintenance # 

Methods

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

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

toConstr :: StartMaintenance -> Constr #

dataTypeOf :: StartMaintenance -> DataType #

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

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

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

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

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

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

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

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

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

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

Read StartMaintenance # 
Show StartMaintenance # 
Generic StartMaintenance # 
Hashable StartMaintenance # 
ToJSON StartMaintenance # 
NFData StartMaintenance # 

Methods

rnf :: StartMaintenance -> () #

AWSRequest StartMaintenance # 
ToQuery StartMaintenance # 
ToPath StartMaintenance # 
ToHeaders StartMaintenance # 
type Rep StartMaintenance # 
type Rep StartMaintenance = D1 (MetaData "StartMaintenance" "Network.AWS.OpsWorksCM.StartMaintenance" "amazonka-opsworks-cm-1.4.5-AhfVC6jsAX0FFNzDXhBrcp" True) (C1 (MetaCons "StartMaintenance'" PrefixI True) (S1 (MetaSel (Just Symbol "_smServerName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs StartMaintenance # 

Request Lenses

smServerName :: Lens' StartMaintenance Text #

The name of the server on which to run maintenance.

Destructuring the Response

startMaintenanceResponse #

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

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

data StartMaintenanceResponse #

See: startMaintenanceResponse smart constructor.

Instances

Eq StartMaintenanceResponse # 
Data StartMaintenanceResponse # 

Methods

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

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

toConstr :: StartMaintenanceResponse -> Constr #

dataTypeOf :: StartMaintenanceResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read StartMaintenanceResponse # 
Show StartMaintenanceResponse # 
Generic StartMaintenanceResponse # 
NFData StartMaintenanceResponse # 
type Rep StartMaintenanceResponse # 
type Rep StartMaintenanceResponse = D1 (MetaData "StartMaintenanceResponse" "Network.AWS.OpsWorksCM.StartMaintenance" "amazonka-opsworks-cm-1.4.5-AhfVC6jsAX0FFNzDXhBrcp" False) (C1 (MetaCons "StartMaintenanceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_smrsServer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Server))) (S1 (MetaSel (Just Symbol "_smrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

smrsServer :: Lens' StartMaintenanceResponse (Maybe Server) #

Contains the response to a StartMaintenance request.

smrsResponseStatus :: Lens' StartMaintenanceResponse Int #

  • - | The response status code.