CancelEnvironmentDeployment - AWS Proton


Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in 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 UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Request Syntax

{ "environmentName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The name of the environment with the deployment to cancel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

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

Required: Yes

Response Syntax

{ "environment": { "arn": "string", "codebuildRoleArn": "string", "componentRoleArn": "string", "createdAt": number, "deploymentStatus": "string", "deploymentStatusMessage": "string", "description": "string", "environmentAccountConnectionId": "string", "environmentAccountId": "string", "lastAttemptedDeploymentId": "string", "lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "lastSucceededDeploymentId": "string", "name": "string", "protonServiceRoleArn": "string", "provisioning": "string", "provisioningRepository": { "arn": "string", "branch": "string", "name": "string", "provider": "string" }, "spec": "string", "templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

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


The environment summary data that's returned by AWS Proton.

Type: Environment object


For information about the errors that are common to all actions, see Common Errors.


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

For more information about using this API in one of the language-specific AWS SDKs, see the following: