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.OpsWorksCM.StartMaintenance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data StartMaintenance Source #

See: newStartMaintenance smart constructor.

Constructors

StartMaintenance'

Fields

engineAttributes :: Maybe [EngineAttribute]
Engine attributes that are specific to the server on which you want to run maintenance.
Attributes accepted in a StartMaintenance request for Chef
- CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.
serverName :: Text
The name of the server on which to run maintenance.

Instances

Instances details

Eq StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods (==) :: StartMaintenance -> StartMaintenance -> Bool # (/=) :: StartMaintenance -> StartMaintenance -> Bool #
Show StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods showsPrec :: Int -> StartMaintenance -> ShowS # show :: StartMaintenance -> String # showList :: [StartMaintenance] -> ShowS #
Generic StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Associated Types type Rep StartMaintenance :: Type -> Type # Methods from :: StartMaintenance -> Rep StartMaintenance x # to :: Rep StartMaintenance x -> StartMaintenance #
NFData StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods rnf :: StartMaintenance -> () #
Hashable StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods hashWithSalt :: Int -> StartMaintenance -> Int # hash :: StartMaintenance -> Int #
ToJSON StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods toJSON :: StartMaintenance -> Value # toEncoding :: StartMaintenance -> Encoding # toJSONList :: [StartMaintenance] -> Value # toEncodingList :: [StartMaintenance] -> Encoding #
AWSRequest StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Associated Types type AWSResponse StartMaintenance # Methods request :: StartMaintenance -> Request StartMaintenance # response :: MonadResource m => Logger -> Service -> Proxy StartMaintenance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartMaintenance))) #
ToHeaders StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods toHeaders :: StartMaintenance -> [Header] #
ToPath StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods toPath :: StartMaintenance -> ByteString #
ToQuery StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods toQuery :: StartMaintenance -> QueryString #
type Rep StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance type Rep StartMaintenance = D1 ('MetaData "StartMaintenance" "Amazonka.OpsWorksCM.StartMaintenance" "libZSservicesZSamazonka-opsworks-cmZSamazonka-opsworks-cm" 'False) (C1 ('MetaCons "StartMaintenance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EngineAttribute])) :*: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StartMaintenance Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance type AWSResponse StartMaintenance = StartMaintenanceResponse

newStartMaintenance Source #

Arguments

:: Text	`$sel:serverName:StartMaintenance'`
-> StartMaintenance

Create a value of StartMaintenance 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:engineAttributes:StartMaintenance', startMaintenance_engineAttributes - Engine attributes that are specific to the server on which you want to run maintenance.

Attributes accepted in a StartMaintenance request for Chef

CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.

$sel:serverName:StartMaintenance', startMaintenance_serverName - The name of the server on which to run maintenance.

Request Lenses

startMaintenance_engineAttributes :: Lens' StartMaintenance (Maybe [EngineAttribute]) Source #

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

Attributes accepted in a StartMaintenance request for Chef

CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a StartMaintenance request and set the value to true to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.

startMaintenance_serverName :: Lens' StartMaintenance Text Source #

The name of the server on which to run maintenance.

Destructuring the Response

data StartMaintenanceResponse Source #

See: newStartMaintenanceResponse smart constructor.

Constructors

StartMaintenanceResponse'
Fields server :: Maybe Server Contains the response to a `StartMaintenance` request. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartMaintenanceResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods (==) :: StartMaintenanceResponse -> StartMaintenanceResponse -> Bool # (/=) :: StartMaintenanceResponse -> StartMaintenanceResponse -> Bool #
Show StartMaintenanceResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods showsPrec :: Int -> StartMaintenanceResponse -> ShowS # show :: StartMaintenanceResponse -> String # showList :: [StartMaintenanceResponse] -> ShowS #
Generic StartMaintenanceResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Associated Types type Rep StartMaintenanceResponse :: Type -> Type # Methods from :: StartMaintenanceResponse -> Rep StartMaintenanceResponse x # to :: Rep StartMaintenanceResponse x -> StartMaintenanceResponse #
NFData StartMaintenanceResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance Methods rnf :: StartMaintenanceResponse -> () #
type Rep StartMaintenanceResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.StartMaintenance type Rep StartMaintenanceResponse = D1 ('MetaData "StartMaintenanceResponse" "Amazonka.OpsWorksCM.StartMaintenance" "libZSservicesZSamazonka-opsworks-cmZSamazonka-opsworks-cm" 'False) (C1 ('MetaCons "StartMaintenanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "server") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Server)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartMaintenanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartMaintenanceResponse'`
-> StartMaintenanceResponse

Create a value of StartMaintenanceResponse 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:server:StartMaintenanceResponse', startMaintenanceResponse_server - Contains the response to a StartMaintenance request.

$sel:httpStatus:StartMaintenanceResponse', startMaintenanceResponse_httpStatus - The response's http status code.

Response Lenses

startMaintenanceResponse_server :: Lens' StartMaintenanceResponse (Maybe Server) Source #

Contains the response to a StartMaintenance request.

startMaintenanceResponse_httpStatus :: Lens' StartMaintenanceResponse Int Source #

The response's http status code.