libZSservicesZSamazonka-opsworks-cmZSamazonka-opsworks-cm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpsWorksCM.StartMaintenance

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.

Synopsis

Creating a Request

data StartMaintenance Source #

See: newStartMaintenance smart constructor.

Constructors

StartMaintenance' 

Fields

Instances

Instances details
Eq StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Show StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Generic StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Associated Types

type Rep StartMaintenance :: Type -> Type #

NFData StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Methods

rnf :: StartMaintenance -> () #

Hashable StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

ToJSON StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

AWSRequest StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Associated Types

type AWSResponse StartMaintenance #

ToHeaders StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

ToPath StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

ToQuery StartMaintenance Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

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

newStartMaintenance Source #

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

$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

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

Instances

Instances details
Eq StartMaintenanceResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Show StartMaintenanceResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Generic StartMaintenanceResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

Associated Types

type Rep StartMaintenanceResponse :: Type -> Type #

NFData StartMaintenanceResponse Source # 
Instance details

Defined in Amazonka.OpsWorksCM.StartMaintenance

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 #

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.