imagebuilder / Client / cancel_lifecycle_execution

cancel_lifecycle_execution

imagebuilder.Client.cancel_lifecycle_execution(**kwargs)

Cancel a specific image lifecycle policy runtime instance.

See also: AWS API Documentation

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]

  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

{
    'lifecycleExecutionId': 'string'
}

Response Structure

• (dict) –

  • lifecycleExecutionId (string) –

    The unique identifier for the image lifecycle runtime instance that was 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