CancelServicePipelineDeployment - AWS Proton


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.

Request Syntax

{ "serviceName": "string" }

Request Parameters


The request accepts the following data in JSON format.


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

Type: String


Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

Response Syntax

{ "pipeline": { "arn": "string", "createdAt": number, "deploymentStatus": "string", "deploymentStatusMessage": "string", "lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "spec": "string", "templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string" } }

Response Elements


The following data is returned in JSON format by the service.


The service pipeline detail data that's returned by AWS Proton.

Type: ServicePipeline object




There isn't sufficient access for performing this action.

HTTP Status Code: 400


The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400


The request failed to register with the service.

HTTP Status Code: 500


The requested resource wasn't found.

HTTP Status Code: 400


The request was denied due to request throttling.

HTTP Status Code: 400


The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also
