Skip to content

CancelHarvestJobRequest

Source code in docs_src/capo_mediapackagev2/types/cancel_harvest_job_request.py 
12
13
14
15
16
17
18
19
20
21
22
class CancelHarvestJobRequest(TypedDict, closed=True):
    channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the channel group containing the channel from which the harvest job is running.</p>"""
    channel_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the channel from which the harvest job is running.</p>"""
    origin_endpoint_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.</p>"""
    harvest_job_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>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.</p>"""
    e_tag: NotRequired["capo_mediapackagev2.types.entity_tag.EntityTag"]
    """<p>The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.</p>"""

channel_group_name instance-attribute 

channel_group_name: ResourceName

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

channel_name instance-attribute 

channel_name: ResourceName

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

e_tag instance-attribute 

e_tag: NotRequired[EntityTag]

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

harvest_job_name instance-attribute 

harvest_job_name: ResourceName

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.

origin_endpoint_name instance-attribute 

origin_endpoint_name: ResourceName

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