Skip to content

CreateHarvestJobRequest

Source code in docs_src/capo_mediapackagev2/types/create_harvest_job_request.py
class CreateHarvestJobRequest(TypedDict, closed=True):
    channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the channel group containing the channel from which to harvest content.</p>"""
    channel_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the channel from which to harvest content.</p>"""
    origin_endpoint_name: "capo_mediapackagev2.types.resource_name.ResourceName"
    """<p>The name of the origin endpoint from which to harvest content.</p>"""
    description: NotRequired[
        "capo_mediapackagev2.types.resource_description.ResourceDescription"
    ]
    """<p>An optional description for the harvest job.</p>"""
    harvested_manifests: (
        "capo_mediapackagev2.types.harvested_manifests.HarvestedManifests"
    )
    """<p>A list of manifests to be harvested.</p>"""
    schedule_configuration: "capo_mediapackagev2.types.harvester_schedule_configuration.HarvesterScheduleConfiguration"
    """<p>The configuration for when the harvest job should run, including start and end times.</p>"""
    destination: "capo_mediapackagev2.types.destination.Destination"
    """<p>The S3 destination where the harvested content will be placed.</p>"""
    client_token: NotRequired[
        "capo_mediapackagev2.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    harvest_job_name: NotRequired[
        "capo_mediapackagev2.types.resource_name.ResourceName"
    ]
    """<p>A name for the harvest job. This name must be unique within the channel.</p>"""
    tags: NotRequired["capo_mediapackagev2.types.tag_map.TagMap"]
    """<p>A collection of tags associated with the harvest job.</p>"""

channel_group_name instance-attribute

channel_group_name: ResourceName

The name of the channel group containing the channel from which to harvest content.

channel_name instance-attribute

channel_name: ResourceName

The name of the channel from which to harvest content.

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

description instance-attribute

description: NotRequired[ResourceDescription]

An optional description for the harvest job.

destination instance-attribute

destination: Destination

The S3 destination where the harvested content will be placed.

harvest_job_name instance-attribute

harvest_job_name: NotRequired[ResourceName]

A name for the harvest job. This name must be unique within the channel.

harvested_manifests instance-attribute

harvested_manifests: HarvestedManifests

A list of manifests to be harvested.

origin_endpoint_name instance-attribute

origin_endpoint_name: ResourceName

The name of the origin endpoint from which to harvest content.

schedule_configuration instance-attribute

schedule_configuration: HarvesterScheduleConfiguration

The configuration for when the harvest job should run, including start and end times.

tags instance-attribute

tags: NotRequired[TagMap]

A collection of tags associated with the harvest job.