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

See also: AWS API Documentation

Request Syntax

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • requestId (string) –

      The request ID that uniquely identifies this request.

    • clientToken (string) –

      The client token that uniquely identifies the request.

    • imageBuildVersionArn (string) –

      The Amazon Resource Name (ARN) of the image whose creation this request canceled.

Exceptions