Skip to content

Cancels the creation of an image

Description

Cancels the creation of an image. This operation can only be used on images in a non-terminal state. Cancellation is asynchronous: the request returns immediately, then Image Builder stops the running build and moves the image to the CANCELLED state. Output resources that the build already created, such as AMIs and snapshots, aren't removed.

Usage

imagebuilder_cancel_image_creation(imageBuildVersionArn, clientToken)

Arguments

  • imageBuildVersionArn

    [required] The Amazon Resource Name (ARN) of the image that you want to cancel creation for.

  • clientToken

    [required] A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Value

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  imageBuildVersionArn = "string"
)

Request syntax

svc$cancel_image_creation(
  imageBuildVersionArn = "string",
  clientToken = "string"
)