CancelImageCreation - EC2 Image Builder

CancelImageCreation

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

Request Syntax

PUT /CancelImageCreation HTTP/1.1 Content-type: application/json { "clientToken": "string", "imageBuildVersionArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The idempotency token used to make this request idempotent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: Yes

imageBuildVersionArn

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

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):image/[a-z0-9-_]+/\d+\.\d+\.\d+/\d+$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "clientToken": "string", "imageBuildVersionArn": "string", "requestId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken

The idempotency token used to make this request idempotent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

imageBuildVersionArn

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

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):image/[a-z0-9-_]+/\d+\.\d+\.\d+/\d+$

requestId

The request ID that uniquely identifies this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

IdempotentParameterMismatchException

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

HTTP Status Code: 400

InvalidRequestException

You have made a request for an action that is not supported by the service.

HTTP Status Code: 400

ResourceInUseException

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

HTTP Status Code: 400

ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: