harvest_jobs

Creates, updates, deletes, gets or lists a harvest_jobs resource.

Overview

Name	harvest_jobs
Type	Resource
Id	aws.mediapackagev2.harvest_jobs

Fields

The following fields are returned by SELECT queries:

get_harvest_job

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the harvest job.
channel_group_name	string	The name of the channel group containing the channel associated with the harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
channel_name	string	The name of the channel associated with the harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
created_at	string (date-time)	The date and time when the harvest job was created.
description	string	The description of the harvest job, if provided.
destination	object	The S3 destination where the harvested content is being placed.
e_tag	string	The current version of the harvest job. Used for concurrency control. (pattern: <code>[\S]+</code>)
error_message	string	An error message if the harvest job encountered any issues.
harvest_job_name	string	The name of the harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
harvested_manifests	object	A list of manifests that are being or have been harvested.
modified_at	string (date-time)	The date and time when the harvest job was last modified.
origin_endpoint_name	string	The name of the origin endpoint associated with the harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
schedule_configuration	object	The configuration for when the harvest job is scheduled to run, including start and end times.
status	string	The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED). (QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED)
tags	object	A collection of tags associated with the harvest job.

list_harvest_jobs

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the harvest job.
channel_group_name	string	The name of the channel group containing the channel associated with this harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
channel_name	string	The name of the channel associated with this harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
created_at	string (date-time)	The date and time when the harvest job was created.
description	string	An optional description of the harvest job.
destination	object	The configuration for the destination where the harvested content will be exported.
e_tag	string	The current version of the harvest job. Used for concurrency control. (pattern: <code>[\S]+</code>)
error_message	string	An error message if the harvest job encountered any issues.
harvest_job_name	string	The name of the harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
harvested_manifests	object	A collection of harvested manifests of different types.
modified_at	string (date-time)	The date and time when the harvest job was last modified.
origin_endpoint_name	string	The name of the origin endpoint associated with this harvest job. (pattern: <code>[a-zA-Z0-9_-]+</code>)
schedule_configuration	object	Defines the schedule configuration for a harvest job.
status	string	The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED). (QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_harvest_job	select	channel_group_name, channel_name, origin_endpoint_name, harvest_job_name, region		Retrieves the details of a specific harvest job.
list_harvest_jobs	select	channel_group_name, region	channelName, originEndpointName, includeStatus, maxResults, nextToken	Retrieves a list of harvest jobs that match the specified criteria.
create_harvest_job	insert	channel_group_name, channel_name, origin_endpoint_name, region, HarvestedManifests, ScheduleConfiguration	x-amzn-client-token	Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
channel_group_name	string	The name of the channel group containing the channel from which to harvest content.
channel_name	string	The name of the channel from which to harvest content.
harvest_job_name	string	The name of the harvest job to retrieve.
origin_endpoint_name	string	The name of the origin endpoint from which to harvest content.
region	string	AWS region (default: us-east-1)
channelName	string	The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.
includeStatus	string	The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.
maxResults	integer	The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.
nextToken	string	A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.
originEndpointName	string	The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.
x-amzn-client-token	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

SELECT examples

get_harvest_job

Retrieves the details of a specific harvest job.

SELECT
arn,
channel_group_name,
channel_name,
created_at,
description,
destination,
e_tag,
error_message,
harvest_job_name,
harvested_manifests,
modified_at,
origin_endpoint_name,
schedule_configuration,
status,
tags
FROM aws.mediapackagev2.harvest_jobs
WHERE channel_group_name = '{{ channel_group_name }}' -- required
AND channel_name = '{{ channel_name }}' -- required
AND origin_endpoint_name = '{{ origin_endpoint_name }}' -- required
AND harvest_job_name = '{{ harvest_job_name }}' -- required
AND region = '{{ region }}' -- required
;

list_harvest_jobs

Retrieves a list of harvest jobs that match the specified criteria.

SELECT
arn,
channel_group_name,
channel_name,
created_at,
description,
destination,
e_tag,
error_message,
harvest_job_name,
harvested_manifests,
modified_at,
origin_endpoint_name,
schedule_configuration,
status
FROM aws.mediapackagev2.harvest_jobs
WHERE channel_group_name = '{{ channel_group_name }}' -- required
AND region = '{{ region }}' -- required
AND channelName = '{{ channelName }}'
AND originEndpointName = '{{ originEndpointName }}'
AND includeStatus = '{{ includeStatus }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_harvest_job

Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.

INSERT INTO aws.mediapackagev2.harvest_jobs (
Description,
HarvestedManifests,
ScheduleConfiguration,
Destination,
HarvestJobName,
Tags,
channel_group_name,
channel_name,
origin_endpoint_name,
region,
`x-amzn-client-token`
)
SELECT 
'{{ Description }}',
'{{ HarvestedManifests }}' /* required */,
'{{ ScheduleConfiguration }}' /* required */,
'{{ Destination }}',
'{{ HarvestJobName }}',
'{{ Tags }}',
'{{ channel_group_name }}',
'{{ channel_name }}',
'{{ origin_endpoint_name }}',
'{{ region }}',
'{{ x-amzn-client-token }}'
RETURNING
arn,
channel_group_name,
channel_name,
created_at,
description,
destination,
e_tag,
error_message,
harvest_job_name,
harvested_manifests,
modified_at,
origin_endpoint_name,
schedule_configuration,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: harvest_jobs
props:
  - name: channel_group_name
    value: "{{ channel_group_name }}"
    description: Required parameter for the harvest_jobs resource.
  - name: channel_name
    value: "{{ channel_name }}"
    description: Required parameter for the harvest_jobs resource.
  - name: origin_endpoint_name
    value: "{{ origin_endpoint_name }}"
    description: Required parameter for the harvest_jobs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the harvest_jobs resource.
  - name: Description
    value: "{{ Description }}"
  - name: HarvestedManifests
    description: |
      A collection of harvested manifests of different types.
    value:
      HlsManifests:
        - ManifestName: "{{ ManifestName }}"
      DashManifests:
        - ManifestName: "{{ ManifestName }}"
      LowLatencyHlsManifests:
        - ManifestName: "{{ ManifestName }}"
  - name: ScheduleConfiguration
    description: |
      Defines the schedule configuration for a harvest job.
    value:
      StartTime: "{{ StartTime }}"
      EndTime: "{{ EndTime }}"
  - name: Destination
    description: |
      The configuration for the destination where the harvested content will be exported.
    value:
      S3Destination:
        BucketName: "{{ BucketName }}"
        DestinationPath: "{{ DestinationPath }}"
  - name: HarvestJobName
    value: "{{ HarvestJobName }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: x-amzn-client-token
    value: "{{ x-amzn-client-token }}"
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.