:doc:`mediapackagev2 <../../mediapackagev2>` / Client / cancel_harvest_job

******************
cancel_harvest_job
******************



.. py:method:: mediapackagev2.Client.cancel_harvest_job(**kwargs)

  

  Cancels an in-progress harvest job.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CancelHarvestJob>`_  


  **Request Syntax**
  ::

    response = client.cancel_harvest_job(
        ChannelGroupName='string',
        ChannelName='string',
        OriginEndpointName='string',
        HarvestJobName='string',
        ETag='string'
    )
    
  :type ChannelGroupName: string
  :param ChannelGroupName: **[REQUIRED]** 

    The name of the channel group containing the channel from which the harvest job is running.

    

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

    The name of the channel from which the harvest job is running.

    

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

    The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.

    

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

    The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.

    

  
  :type ETag: string
  :param ETag: 

    The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`mediapackagev2.Client.exceptions.ConflictException`

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

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

  
  *   :py:class:`mediapackagev2.Client.exceptions.InternalServerException`

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

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

  