Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . deploy ]

stop-deployment

Description

Attempts to stop an ongoing deployment.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  stop-deployment
--deployment-id <value>
[--auto-rollback-enabled | --no-auto-rollback-enabled]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--deployment-id (string)

The unique ID of a deployment.

--auto-rollback-enabled | --no-auto-rollback-enabled (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To attempt to stop a deployment

The following stop-deployment example attempts to stop an in-progress deployment that is associated with the user's AWS account.

aws deploy stop-deployment --deployment-id d-A1B2C3111

Output:

{
    "status": "Succeeded",
    "statusMessage": "No more commands will be scheduled for execution in the deployment instances"
}

Output

status -> (string)

The status of the stop deployment operation:

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

statusMessage -> (string)

An accompanying status message.