:doc:`imagebuilder <../../imagebuilder>` / Client / cancel_lifecycle_execution

**************************
cancel_lifecycle_execution
**************************



.. py:method:: imagebuilder.Client.cancel_lifecycle_execution(**kwargs)

  

  Cancel a specific image lifecycle policy runtime instance.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CancelLifecycleExecution>`_  


  **Request Syntax**
  ::

    response = client.cancel_lifecycle_execution(
        lifecycleExecutionId='string',
        clientToken='string'
    )
    
  :type lifecycleExecutionId: string
  :param lifecycleExecutionId: **[REQUIRED]** 

    Identifies the specific runtime instance of the image lifecycle to cancel.

    

  
  :type clientToken: string
  :param clientToken: **[REQUIRED]** 

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html>`__ in the *Amazon EC2 API Reference*.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'lifecycleExecutionId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **lifecycleExecutionId** *(string) --* 

        The unique identifier for the image lifecycle runtime instance that was canceled.

        
  
  **Exceptions**
  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ClientException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`imagebuilder.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`imagebuilder.Client.exceptions.IdempotentParameterMismatchException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ForbiddenException`

  
  *   :py:class:`imagebuilder.Client.exceptions.CallRateLimitExceededException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ResourceInUseException`

  