:doc:`CleanRoomsML <../../cleanroomsml>` / Client / cancel_trained_model

********************
cancel_trained_model
********************



.. py:method:: CleanRoomsML.Client.cancel_trained_model(**kwargs)

  

  Submits a request to cancel the trained model job.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CancelTrainedModel>`_  


  **Request Syntax**
  ::

    response = client.cancel_trained_model(
        membershipIdentifier='string',
        trainedModelArn='string',
        versionIdentifier='string'
    )
    
  :type membershipIdentifier: string
  :param membershipIdentifier: **[REQUIRED]** 

    The membership ID of the trained model job that you want to cancel.

    

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

    The Amazon Resource Name (ARN) of the trained model job that you want to cancel.

    

  
  :type versionIdentifier: string
  :param versionIdentifier: 

    The version identifier of the trained model to cancel. This parameter allows you to specify which version of the trained model you want to cancel when multiple versions exist.

     

    If ``versionIdentifier`` is not specified, the base model will be cancelled.

    

  
  
  :returns: None
  **Exceptions**
  
  *   :py:class:`CleanRoomsML.Client.exceptions.ConflictException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.ValidationException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.ThrottlingException`

  