Network.AWS.OpsWorksCM.StartMaintenance

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 is in an UNDER_MAINTENANCE state while maintenance is in progress.

Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Creating a Request

startMaintenance

Arguments

:: Text

smServerName

-> 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:

• smEngineAttributes - Engine attributes that are specific to the server on which you want to run maintenance.
• smServerName - The name of the server on which to run maintenance.

data StartMaintenance

See: startMaintenance smart constructor.

Instances

Eq StartMaintenance

Methods

(==) :: StartMaintenance -> StartMaintenance -> Bool

(/=) :: StartMaintenance -> StartMaintenance -> Bool

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

Show StartMaintenance

Methods

showsPrec :: Int -> StartMaintenance -> ShowS

show :: StartMaintenance -> String

showList :: [StartMaintenance] -> ShowS

Generic StartMaintenance

Associated Types

type Rep StartMaintenance :: * -> *

Methods

from :: StartMaintenance -> Rep StartMaintenance x

to :: Rep StartMaintenance x -> StartMaintenance

Hashable StartMaintenance

Methods

hashWithSalt :: Int -> StartMaintenance -> Int

hash :: StartMaintenance -> Int

ToJSON StartMaintenance

Methods

toJSON :: StartMaintenance -> Value

toEncoding :: StartMaintenance -> Encoding

toJSONList :: [StartMaintenance] -> Value

toEncodingList :: [StartMaintenance] -> Encoding

NFData StartMaintenance

Methods

rnf :: StartMaintenance -> ()

AWSRequest StartMaintenance

Associated Types

type Rs StartMaintenance :: *

Methods

request :: StartMaintenance -> Request StartMaintenance

response :: MonadResource m => Logger -> Service -> Proxy * StartMaintenance -> ClientResponse -> m (Response StartMaintenance)

ToQuery StartMaintenance

Methods

toQuery :: StartMaintenance -> QueryString

ToPath StartMaintenance

Methods

toPath :: StartMaintenance -> ByteString

ToHeaders StartMaintenance

Methods

toHeaders :: StartMaintenance -> [Header]

type Rep StartMaintenance

type Rep StartMaintenance = D1 (MetaData "StartMaintenance" "Network.AWS.OpsWorksCM.StartMaintenance" "amazonka-opsworks-cm-1.5.0-Hc1u21y7vMsK8PFWgko0CT" False) (C1 (MetaCons "StartMaintenance'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_smEngineAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EngineAttribute]))) (S1 (MetaSel (Just Symbol "_smServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs StartMaintenance

type Rs StartMaintenance = StartMaintenanceResponse

Request Lenses

smEngineAttributes :: Lens' StartMaintenance [EngineAttribute]

Engine attributes that are specific to the server on which you want to run maintenance.

smServerName :: Lens' StartMaintenance Text

The name of the server on which to run maintenance.

Destructuring the Response

startMaintenanceResponse

Arguments

:: Int

smrsResponseStatus

-> 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:

• smrsServer - Contains the response to a StartMaintenance request.
• smrsResponseStatus - -- | The response status code.

data StartMaintenanceResponse

See: startMaintenanceResponse smart constructor.

Instances

Eq StartMaintenanceResponse

Methods

(==) :: StartMaintenanceResponse -> StartMaintenanceResponse -> Bool

(/=) :: StartMaintenanceResponse -> StartMaintenanceResponse -> Bool

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

Show StartMaintenanceResponse

Methods

showsPrec :: Int -> StartMaintenanceResponse -> ShowS

show :: StartMaintenanceResponse -> String

showList :: [StartMaintenanceResponse] -> ShowS

Generic StartMaintenanceResponse

Associated Types

type Rep StartMaintenanceResponse :: * -> *

Methods

from :: StartMaintenanceResponse -> Rep StartMaintenanceResponse x

to :: Rep StartMaintenanceResponse x -> StartMaintenanceResponse

NFData StartMaintenanceResponse

Methods

rnf :: StartMaintenanceResponse -> ()

type Rep StartMaintenanceResponse

type Rep StartMaintenanceResponse = D1 (MetaData "StartMaintenanceResponse" "Network.AWS.OpsWorksCM.StartMaintenance" "amazonka-opsworks-cm-1.5.0-Hc1u21y7vMsK8PFWgko0CT" False) (C1 (MetaCons "StartMaintenanceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_smrsServer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Server))) (S1 (MetaSel (Just Symbol "_smrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

smrsServer :: Lens' StartMaintenanceResponse (Maybe Server)

Contains the response to a StartMaintenance request.

smrsResponseStatus :: Lens' StartMaintenanceResponse Int

• - | The response status code.