Skip to content

CreateHarvestJobResponse

Source code in docs_src/capo_mediapackage/types/create_harvest_job_response.py
class CreateHarvestJobResponse(TypedDict, closed=True):
    arn: NotRequired["capo_mediapackage.types.__string.__string"]
    """The Amazon Resource Name (ARN) assigned to the HarvestJob."""
    channel_id: NotRequired["capo_mediapackage.types.__string.__string"]
    """The ID of the Channel that the HarvestJob will harvest from."""
    created_at: NotRequired["capo_mediapackage.types.__string.__string"]
    """The date and time the HarvestJob was submitted."""
    end_time: NotRequired["capo_mediapackage.types.__string.__string"]
    """The end of the time-window which will be harvested."""
    id: NotRequired["capo_mediapackage.types.__string.__string"]
    """The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted."""
    origin_endpoint_id: NotRequired["capo_mediapackage.types.__string.__string"]
    """The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted."""
    s3_destination: NotRequired["capo_mediapackage.types.s3_destination.S3Destination"]
    start_time: NotRequired["capo_mediapackage.types.__string.__string"]
    """The start of the time-window which will be harvested."""
    status: NotRequired["capo_mediapackage.types.status.Status"]
    """The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed."""

arn instance-attribute

arn: NotRequired[__string]

The Amazon Resource Name (ARN) assigned to the HarvestJob.

channel_id instance-attribute

channel_id: NotRequired[__string]

The ID of the Channel that the HarvestJob will harvest from.

created_at instance-attribute

created_at: NotRequired[__string]

The date and time the HarvestJob was submitted.

end_time instance-attribute

end_time: NotRequired[__string]

The end of the time-window which will be harvested.

id instance-attribute

id: NotRequired[__string]

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

origin_endpoint_id instance-attribute

origin_endpoint_id: NotRequired[__string]

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

s3_destination instance-attribute

s3_destination: NotRequired[S3Destination]

start_time instance-attribute

start_time: NotRequired[__string]

The start of the time-window which will be harvested.

status instance-attribute

status: NotRequired[Status]

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.