libZSservicesZSamazonka-protonZSamazonka-proton
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.Proton.CancelServicePipelineDeployment

Description

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administrator guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

  • If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
  • If the cancellation attempt fails, the resulting deployment state is FAILED.
  • If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
Synopsis

Creating a Request

data CancelServicePipelineDeployment Source #

See: newCancelServicePipelineDeployment smart constructor.

Constructors

CancelServicePipelineDeployment' 

Fields

  • serviceName :: Text

    The name of the service with the service pipeline deployment to cancel.

Instances

Instances details
Eq CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Read CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Show CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Generic CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Associated Types

type Rep CancelServicePipelineDeployment :: Type -> Type #

NFData CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Hashable CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

ToJSON CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

AWSRequest CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

ToHeaders CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

ToPath CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

ToQuery CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

type Rep CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

type Rep CancelServicePipelineDeployment = D1 ('MetaData "CancelServicePipelineDeployment" "Amazonka.Proton.CancelServicePipelineDeployment" "libZSservicesZSamazonka-protonZSamazonka-proton" 'False) (C1 ('MetaCons "CancelServicePipelineDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelServicePipelineDeployment Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

newCancelServicePipelineDeployment Source #

Create a value of CancelServicePipelineDeployment 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:serviceName:CancelServicePipelineDeployment', cancelServicePipelineDeployment_serviceName - The name of the service with the service pipeline deployment to cancel.

Request Lenses

cancelServicePipelineDeployment_serviceName :: Lens' CancelServicePipelineDeployment Text Source #

The name of the service with the service pipeline deployment to cancel.

Destructuring the Response

data CancelServicePipelineDeploymentResponse Source #

Constructors

CancelServicePipelineDeploymentResponse' 

Fields

Instances

Instances details
Eq CancelServicePipelineDeploymentResponse Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Show CancelServicePipelineDeploymentResponse Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

Generic CancelServicePipelineDeploymentResponse Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

NFData CancelServicePipelineDeploymentResponse Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

type Rep CancelServicePipelineDeploymentResponse Source # 
Instance details

Defined in Amazonka.Proton.CancelServicePipelineDeployment

type Rep CancelServicePipelineDeploymentResponse = D1 ('MetaData "CancelServicePipelineDeploymentResponse" "Amazonka.Proton.CancelServicePipelineDeployment" "libZSservicesZSamazonka-protonZSamazonka-proton" 'False) (C1 ('MetaCons "CancelServicePipelineDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "pipeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServicePipeline)))

newCancelServicePipelineDeploymentResponse Source #

Create a value of CancelServicePipelineDeploymentResponse 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:httpStatus:CancelServicePipelineDeploymentResponse', cancelServicePipelineDeploymentResponse_httpStatus - The response's http status code.

$sel:pipeline:CancelServicePipelineDeploymentResponse', cancelServicePipelineDeploymentResponse_pipeline - The service pipeline detail data that's returned by AWS Proton.

Response Lenses