libZSservicesZSamazonka-codedeployZSamazonka-codedeploy
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.CodeDeploy.StopDeployment

Description

Attempts to stop an ongoing deployment.

Synopsis

Creating a Request

data StopDeployment Source #

Represents the input of a StopDeployment operation.

See: newStopDeployment smart constructor.

Constructors

StopDeployment' 

Fields

  • autoRollbackEnabled :: Maybe Bool

    Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

  • deploymentId :: Text

    The unique ID of a deployment.

Instances

Instances details
Eq StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Read StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Show StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Generic StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Associated Types

type Rep StopDeployment :: Type -> Type #

NFData StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Methods

rnf :: StopDeployment -> () #

Hashable StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

ToJSON StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

AWSRequest StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Associated Types

type AWSResponse StopDeployment #

ToHeaders StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

ToPath StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

ToQuery StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

type Rep StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

type Rep StopDeployment = D1 ('MetaData "StopDeployment" "Amazonka.CodeDeploy.StopDeployment" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "StopDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "autoRollbackEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopDeployment Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

newStopDeployment Source #

Create a value of StopDeployment 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:autoRollbackEnabled:StopDeployment', stopDeployment_autoRollbackEnabled - Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

$sel:deploymentId:StopDeployment', stopDeployment_deploymentId - The unique ID of a deployment.

Request Lenses

stopDeployment_autoRollbackEnabled :: Lens' StopDeployment (Maybe Bool) Source #

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

stopDeployment_deploymentId :: Lens' StopDeployment Text Source #

The unique ID of a deployment.

Destructuring the Response

data StopDeploymentResponse Source #

Represents the output of a StopDeployment operation.

See: newStopDeploymentResponse smart constructor.

Constructors

StopDeploymentResponse' 

Fields

Instances

Instances details
Eq StopDeploymentResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Read StopDeploymentResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Show StopDeploymentResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Generic StopDeploymentResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Associated Types

type Rep StopDeploymentResponse :: Type -> Type #

NFData StopDeploymentResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

Methods

rnf :: StopDeploymentResponse -> () #

type Rep StopDeploymentResponse Source # 
Instance details

Defined in Amazonka.CodeDeploy.StopDeployment

type Rep StopDeploymentResponse = D1 ('MetaData "StopDeploymentResponse" "Amazonka.CodeDeploy.StopDeployment" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "StopDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StopStatus)) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStopDeploymentResponse Source #

Create a value of StopDeploymentResponse 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:status:StopDeploymentResponse', stopDeploymentResponse_status - The status of the stop deployment operation:

  • Pending: The stop operation is pending.
  • Succeeded: The stop operation was successful.

$sel:statusMessage:StopDeploymentResponse', stopDeploymentResponse_statusMessage - An accompanying status message.

$sel:httpStatus:StopDeploymentResponse', stopDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

stopDeploymentResponse_status :: Lens' StopDeploymentResponse (Maybe StopStatus) Source #

The status of the stop deployment operation:

  • Pending: The stop operation is pending.
  • Succeeded: The stop operation was successful.