imagebuilder / Client / cancel_image_creation
cancel_image_creation#
- imagebuilder.Client.cancel_image_creation(**kwargs)#
CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.
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]
Unique, case-sensitive identifier you provide to ensure idempotency of the request. 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 ARN of the image whose creation this request canceled.
Exceptions
imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.IdempotentParameterMismatchException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException
imagebuilder.Client.exceptions.ResourceInUseException