imagebuilder / Client / cancel_image_creation

cancel_image_creation¶

imagebuilder.Client.cancel_image_creation(**kwargs)¶

Cancels the creation of an image. This operation can only be used on images in a non-terminal state.

response = client.cancel_image_creation(
    imageBuildVersionArn='string',
    clientToken='string'
)

Parameters:

imageBuildVersionArn (string) –
[REQUIRED]

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

A unique, case-sensitive identifier you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

This field is autopopulated if not provided.

Return type:

dict

Returns:

{
    'requestId': 'string',
    'clientToken': 'string',
    'imageBuildVersionArn': 'string'
}