imagebuilder / Client / cancel_lifecycle_execution

cancel_lifecycle_execution¶

imagebuilder.Client.cancel_lifecycle_execution(**kwargs)¶

Cancels a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started. You can only cancel an execution that hasn’t reached a terminal state. Cancellation is asynchronous and doesn’t undo completed lifecycle actions.

Request Syntax

response = client.cancel_lifecycle_execution(
    lifecycleExecutionId='string',
    clientToken='string'
)

Parameters:

lifecycleExecutionId (string) –
[REQUIRED]

Identifies the specific runtime instance of the image lifecycle to cancel.
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

{
    'lifecycleExecutionId': 'string'
}

Response Structure

(dict) –
- lifecycleExecutionId (string) –
  
  The unique identifier of the lifecycle execution that the cancellation request applies to. The cancellation completes asynchronously.

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