Skip to main content

job_templates

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

Overview

Namejob_templates
TypeResource
Idaws.mediaconvert.job_templates

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
acceleration_settingsobjectAccelerated transcoding can significantly speed up jobs with long, visually complex content.
arnstringAn identifier for this resource that is unique within all of AWS.
categorystringAn optional category you create to organize your job templates.
created_atstring (date-time)The timestamp in epoch seconds for Job template creation.
descriptionstringAn optional description you create for each job template.
hop_destinationsarrayOptional list of hop destinations.
last_updatedstring (date-time)The timestamp in epoch seconds when the Job template was last updated.
namestringA name you create for each job template. Each name must be unique within your account.
priorityintegerRelative priority on the job.
queuestringOptional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.
settingsobjectJobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
status_update_intervalstringSpecify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. (SECONDS_10, SECONDS_12, SECONDS_15, SECONDS_20, SECONDS_30, SECONDS_60, SECONDS_120, SECONDS_180, SECONDS_240, SECONDS_300, SECONDS_360, SECONDS_420, SECONDS_480, SECONDS_540, SECONDS_600)
typestringA job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user. (SYSTEM, CUSTOM)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_job_templateselectname, regionRetrieve the JSON for a specific job template.
list_job_templatesselectregioncategory, listBy, maxResults, nextToken, orderRetrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array
create_job_templateinsertregionCreate a new job template. For information about job templates see the User Guide at http:​//docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
update_job_templateupdatename, regionModify one of your existing job templates.
delete_job_templatedeletename, regionPermanently delete a job template you have created.

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.

NameDatatypeDescription
namestringThe name of the job template to be deleted.
regionstringAWS region (default: us-east-1)
categorystringOptionally, specify a job template category to limit responses to only job templates from that category.
listBystringOptional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
maxResultsintegerOptional. Number of job templates, up to twenty, that will be returned at one time.
nextTokenstringUse this string, provided with the response to a previous request, to request the next batch of job templates.
orderstringOptional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

SELECT examples

Retrieve the JSON for a specific job template.

SELECT
acceleration_settings,
arn,
category,
created_at,
description,
hop_destinations,
last_updated,
name,
priority,
queue,
settings,
status_update_interval,
type
FROM aws.mediaconvert.job_templates
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

INSERT INTO aws.mediaconvert.job_templates (
AccelerationSettings,
Category,
Description,
HopDestinations,
Name,
Priority,
Queue,
Settings,
StatusUpdateInterval,
Tags,
region
)
SELECT
'{{ AccelerationSettings }}',
'{{ Category }}',
'{{ Description }}',
'{{ HopDestinations }}',
'{{ Name }}',
{{ Priority }},
'{{ Queue }}',
'{{ Settings }}',
'{{ StatusUpdateInterval }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
job_template
;

UPDATE examples

Modify one of your existing job templates.

UPDATE aws.mediaconvert.job_templates
SET
AccelerationSettings = '{{ AccelerationSettings }}',
Category = '{{ Category }}',
Description = '{{ Description }}',
HopDestinations = '{{ HopDestinations }}',
Priority = {{ Priority }},
Queue = '{{ Queue }}',
Settings = '{{ Settings }}',
StatusUpdateInterval = '{{ StatusUpdateInterval }}'
WHERE
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
job_template;

DELETE examples

Permanently delete a job template you have created.

DELETE FROM aws.mediaconvert.job_templates
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;