StopDeployment - Amazon CodeDeploy
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Attempts to stop an ongoing deployment.

Request Syntax

{ "autoRollbackEnabled": boolean, "deploymentId": "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.


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

Type: Boolean

Required: No


The unique ID of a deployment.

Type: String

Required: Yes

Response Syntax

{ "status": "string", "statusMessage": "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 status of the stop deployment operation:

  • Pending: The stop operation is pending.

  • Succeeded: The stop operation was successful.

Type: String

Valid Values: Pending | Succeeded


An accompanying status message.

Type: String


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


The deployment is already complete.

HTTP Status Code: 400


The deployment with the user or Amazon Web Services account does not exist.

HTTP Status Code: 400


The named deployment group with the user or Amazon Web Services account does not exist.

HTTP Status Code: 400


At least one deployment ID must be specified.

HTTP Status Code: 400


At least one of the deployment IDs was specified in an invalid format.

HTTP Status Code: 400


A call was submitted that is not supported for the specified deployment type.

HTTP Status Code: 400



This example illustrates one usage of StopDeployment.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 31 X-Amz-Target: CodeDeploy_20141006.StopDeployment X-Amz-Date: 20160707T025157Z User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "deploymentId": "d-LGUMS25CC" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 57a24279-88e8-11e5-a087-ab26ee53e16e Content-Type: application/x-amz-json-1.1 Content-Length: 114 { "status": "Pending", "statusMessage": "Stopping Pending. Stopping to schedule commands in the deployment instances" }

See Also

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