[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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.