mediapackagev2 / Client / cancel_harvest_job

cancel_harvest_job#

mediapackagev2.Client.cancel_harvest_job(**kwargs)#

Cancels an in-progress harvest job.

See also: AWS API Documentation

Request Syntax

response = client.cancel_harvest_job(
    ChannelGroupName='string',
    ChannelName='string',
    OriginEndpointName='string',
    HarvestJobName='string',
    ETag='string'
)
Parameters:

  • ChannelGroupName (string) –

    [REQUIRED]

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

  • ChannelName (string) –

    [REQUIRED]

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

  • OriginEndpointName (string) –

    [REQUIRED]

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

  • HarvestJobName (string) –

    [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.

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • mediapackagev2.Client.exceptions.ThrottlingException

  • mediapackagev2.Client.exceptions.ConflictException

  • mediapackagev2.Client.exceptions.InternalServerException

  • mediapackagev2.Client.exceptions.AccessDeniedException

  • mediapackagev2.Client.exceptions.ValidationException

  • mediapackagev2.Client.exceptions.ResourceNotFoundException