[ aws . imagebuilder ]

cancel-image-creation

Description

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  cancel-image-creation
--image-build-version-arn <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--image-build-version-arn (string)

The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

--client-token (string)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference .

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

See ‘aws help’ for descriptions of global parameters.

Output

requestId -> (string)

The request ID that uniquely identifies this request.

clientToken -> (string)

The idempotency token that was used for this request.

imageBuildVersionArn -> (string)

The Amazon Resource Name (ARN) of the image whose creation has been cancelled.