Skip to content

HarvestJob

Source code in docs_src/capo_mediapackagev2/types/harvest_job.py
class HarvestJob(TypedDict, closed=True):
    channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the channel group containing the channel associated with this harvest job.</p>"""
    channel_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the channel associated with this harvest job.</p>"""
    origin_endpoint_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the origin endpoint associated with this harvest job.</p>"""
    destination: "capo_mediapackagev2.types.destination.Destination"
    """<p>The S3 destination where the harvested content will be placed.</p>"""
    harvest_job_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the harvest job.</p>"""
    harvested_manifests: (
        "capo_mediapackagev2.types.harvested_manifests.HarvestedManifests"
    )
    """<p>A list of manifests that are being or have been harvested.</p>"""
    description: NotRequired[
        "capo_mediapackagev2.types.resource_description.ResourceDescription"
    ]
    """<p>An optional description of the harvest job.</p>"""
    schedule_configuration: "capo_mediapackagev2.types.harvester_schedule_configuration.HarvesterScheduleConfiguration"
    """<p>The configuration for when the harvest job is scheduled to run.</p>"""
    arn: "str"
    """<p>The Amazon Resource Name (ARN) of the harvest job.</p>"""
    created_at: "datetime.datetime"
    """<p>The date and time when the harvest job was created.</p>"""
    modified_at: "datetime.datetime"
    """<p>The date and time when the harvest job was last modified.</p>"""
    status: "capo_mediapackagev2.types.harvest_job_status.HarvestJobStatus"
    """<p>The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).</p>"""
    error_message: NotRequired["str"]
    """<p>An error message if the harvest job encountered any issues.</p>"""
    e_tag: NotRequired["capo_mediapackagev2.types.entity_tag.EntityTag"]
    """<p>The current version of the harvest job. Used for concurrency control.</p>"""

arn instance-attribute

arn: str

The Amazon Resource Name (ARN) of the harvest job.

channel_group_name instance-attribute

channel_group_name: ResourceName

The name of the channel group containing the channel associated with this harvest job.

channel_name instance-attribute

channel_name: ResourceName

The name of the channel associated with this harvest job.

created_at instance-attribute

created_at: datetime

The date and time when the harvest job was created.

description instance-attribute

description: NotRequired[ResourceDescription]

An optional description of the harvest job.

destination instance-attribute

destination: Destination

The S3 destination where the harvested content will be placed.

e_tag instance-attribute

e_tag: NotRequired[EntityTag]

The current version of the harvest job. Used for concurrency control.

error_message instance-attribute

error_message: NotRequired[str]

An error message if the harvest job encountered any issues.

harvest_job_name instance-attribute

harvest_job_name: ResourceName

The name of the harvest job.

harvested_manifests instance-attribute

harvested_manifests: HarvestedManifests

A list of manifests that are being or have been harvested.

modified_at instance-attribute

modified_at: datetime

The date and time when the harvest job was last modified.

origin_endpoint_name instance-attribute

origin_endpoint_name: ResourceName

The name of the origin endpoint associated with this harvest job.

schedule_configuration instance-attribute

schedule_configuration: HarvesterScheduleConfiguration

The configuration for when the harvest job is scheduled to run.

status instance-attribute

The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).