harvest_jobs

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

Overview

Name	harvest_jobs
Type	Resource
Id	aws.mediapackage.harvest_jobs

Fields

The following fields are returned by SELECT queries:

describe_harvest_job

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the HarvestJob.
channel_id	string	The ID of the Channel that the HarvestJob will harvest from.
created_at	string	The date and time the HarvestJob was submitted.
end_time	string	The end of the time-window which will be harvested.
id	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	string	The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
s3_destination	object	Configuration parameters for where in an S3 bucket to place the harvested content
start_time	string	The start of the time-window which will be harvested.
status	string	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. (IN_PROGRESS, SUCCEEDED, FAILED)

list_harvest_jobs

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the HarvestJob.
channel_id	string	The ID of the Channel that the HarvestJob will harvest from.
created_at	string	The date and time the HarvestJob was submitted.
end_time	string	The end of the time-window which will be harvested.
id	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	string	The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
s3_destination	object	Configuration parameters for where in an S3 bucket to place the harvested content
start_time	string	The start of the time-window which will be harvested.
status	string	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. (IN_PROGRESS, SUCCEEDED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_harvest_job	select	id, region		Gets details about an existing HarvestJob.
list_harvest_jobs	select	region	includeChannelId, includeStatus, maxResults, nextToken	Returns a collection of HarvestJob records.
create_harvest_job	insert	region, EndTime, OriginEndpointId, S3Destination, StartTime		Creates a new HarvestJob record.

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
id	string	The ID of the HarvestJob.
region	string	AWS region (default: us-east-1)
includeChannelId	string	When specified, the request will return only HarvestJobs associated with the given Channel ID.
includeStatus	string	When specified, the request will return only HarvestJobs in the given status.
maxResults	integer	The upper bound on the number of records to return.
nextToken	string	A token used to resume pagination from the end of a previous request.

SELECT examples

describe_harvest_job

Gets details about an existing HarvestJob.

SELECT
arn,
channel_id,
created_at,
end_time,
id,
origin_endpoint_id,
s3_destination,
start_time,
status
FROM aws.mediapackage.harvest_jobs
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_harvest_jobs

Returns a collection of HarvestJob records.

SELECT
arn,
channel_id,
created_at,
end_time,
id,
origin_endpoint_id,
s3_destination,
start_time,
status
FROM aws.mediapackage.harvest_jobs
WHERE region = '{{ region }}' -- required
AND includeChannelId = '{{ includeChannelId }}'
AND includeStatus = '{{ includeStatus }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_harvest_job

Creates a new HarvestJob record.

INSERT INTO aws.mediapackage.harvest_jobs (
EndTime,
Id,
OriginEndpointId,
S3Destination,
StartTime,
region
)
SELECT 
'{{ EndTime }}' /* required */,
'{{ Id }}',
'{{ OriginEndpointId }}' /* required */,
'{{ S3Destination }}' /* required */,
'{{ StartTime }}' /* required */,
'{{ region }}'
RETURNING
arn,
channel_id,
created_at,
end_time,
id,
origin_endpoint_id,
s3_destination,
start_time,
status
;

Manifest

# Description fields are for documentation purposes
- name: harvest_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the harvest_jobs resource.
  - name: EndTime
    value: "{{ EndTime }}"
  - name: Id
    value: "{{ Id }}"
  - name: OriginEndpointId
    value: "{{ OriginEndpointId }}"
  - name: S3Destination
    description: |
      Configuration parameters for where in an S3 bucket to place the harvested content
    value:
      BucketName: "{{ BucketName }}"
      ManifestKey: "{{ ManifestKey }}"
      RoleArn: "{{ RoleArn }}"
  - name: StartTime
    value: "{{ StartTime }}"