PUT

/CancelImageCreation

http://imagebuilder.{region}.amazonaws.com/CancelImageCreation

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

Access Token Required: API Key

Body Params

clientTokenstringrequired

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.

imageBuildVersionArnstringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://imagebuilder.{region}.amazonaws.com/CancelImageCreation' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}