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 . greengrassv2 ]

cancel-deployment

Description

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  cancel-deployment
--deployment-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--deployment-id (string)

The ID of the deployment.

--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 cancel a deployment

The following cancel-deployment example stops a continuous deployment to a thing group.

aws greengrassv2 cancel-deployment \
    --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output:

{
    "message": "SUCCESS"
}

For more information, see Cancel deployments in the AWS IoT Greengrass V2 Developer Guide.

Output

message -> (string)

A message that communicates if the cancel was successful.