imagebuilder / Client / delete_image

delete_image

imagebuilder.Client.delete_image(**kwargs)

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.

• To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .

• To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .

• To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_image(
    imageBuildVersionArn='string'
)

Parameters:

imageBuildVersionArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • imageBuildVersionArn (string) –

    The ARN of the Image Builder image resource that this request deleted.

Exceptions

• imagebuilder.Client.exceptions.ServiceException

• imagebuilder.Client.exceptions.ClientException

• imagebuilder.Client.exceptions.InvalidRequestException

• imagebuilder.Client.exceptions.ServiceUnavailableException

• imagebuilder.Client.exceptions.ForbiddenException

• imagebuilder.Client.exceptions.CallRateLimitExceededException

• imagebuilder.Client.exceptions.ResourceDependencyException