The JobTemplates API from Amazon MediaConvert — 2 operation(s) for jobtemplates.
openapi: 3.0.0
info:
version: 2017-08-29
x-release: v4
title: AWS Elemental MediaConvert Certificates JobTemplates API
description: AWS Elemental MediaConvert
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediaconvert
x-aws-signingName: mediaconvert
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediaconvert-2017-08-29.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://mediaconvert.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaConvert multi-region endpoint
- url: https://mediaconvert.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaConvert multi-region endpoint
- url: http://mediaconvert.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaConvert endpoint for China (Beijing) and China (Ningxia)
- url: https://mediaconvert.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaConvert endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: JobTemplates
paths:
/2017-08-29/jobTemplates:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateJobTemplate
description: 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
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJobTemplateResponse'
examples:
CreateJobTemplate201Example:
summary: Default CreateJobTemplate 201 response
x-microcks-default: true
value:
JobTemplate: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateJobTemplate480Example:
summary: Default CreateJobTemplate 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateJobTemplate481Example:
summary: Default CreateJobTemplate 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreateJobTemplate482Example:
summary: Default CreateJobTemplate 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
CreateJobTemplate483Example:
summary: Default CreateJobTemplate 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateJobTemplate484Example:
summary: Default CreateJobTemplate 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateJobTemplate485Example:
summary: Default CreateJobTemplate 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- settings
properties:
accelerationSettings:
description: Accelerated transcoding can significantly speed up jobs with long, visually complex content.
type: object
properties:
Mode:
allOf:
- $ref: '#/components/schemas/AccelerationMode'
- xml:
name: mode
description: Specify the conditions when the service will run your job with accelerated transcoding.
category:
description: Optional. A category for the job template you are creating
type: string
description:
description: Optional. A description of the job template you are creating.
type: string
hopDestinations:
description: Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
type: array
items:
$ref: '#/components/schemas/HopDestination'
name:
description: The name of the job template you are creating.
type: string
priority:
description: Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.
type: integer
minimum: -50
maximum: 50
queue:
description: Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.
type: string
settings:
description: JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
type: object
properties:
AdAvailOffset:
allOf:
- $ref: '#/components/schemas/__integerMinNegative1000Max1000'
- xml:
name: adAvailOffset
description: When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
AvailBlanking:
allOf:
- $ref: '#/components/schemas/AvailBlanking'
- xml:
name: availBlanking
description: Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.
Esam:
allOf:
- $ref: '#/components/schemas/EsamSettings'
- xml:
name: esam
description: Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
ExtendedDataServices:
allOf:
- $ref: '#/components/schemas/ExtendedDataServices'
- xml:
name: extendedDataServices
description: If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.
Inputs:
allOf:
- $ref: '#/components/schemas/__listOfInputTemplate'
- xml:
name: inputs
description: Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.
KantarWatermark:
allOf:
- $ref: '#/components/schemas/KantarWatermarkSettings'
- xml:
name: kantarWatermark
description: Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
MotionImageInserter:
allOf:
- $ref: '#/components/schemas/MotionImageInserter'
- xml:
name: motionImageInserter
description: Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.
NielsenConfiguration:
allOf:
- $ref: '#/components/schemas/NielsenConfiguration'
- xml:
name: nielsenConfiguration
description: Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.
NielsenNonLinearWatermark:
allOf:
- $ref: '#/components/schemas/NielsenNonLinearWatermarkSettings'
- xml:
name: nielsenNonLinearWatermark
description: 'Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]'
OutputGroups:
allOf:
- $ref: '#/components/schemas/__listOfOutputGroup'
- xml:
name: outputGroups
description: (OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings
TimecodeConfig:
allOf:
- $ref: '#/components/schemas/TimecodeConfig'
- xml:
name: timecodeConfig
description: These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
TimedMetadataInsertion:
allOf:
- $ref: '#/components/schemas/TimedMetadataInsertion'
- xml:
name: timedMetadataInsertion
description: Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).
statusUpdateInterval:
description: Specify 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.
type: string
enum:
- 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
tags:
description: The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
summary: Amazon MediaConvert Create Job Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- JobTemplates
get:
operationId: ListJobTemplates
description: Retrieve 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
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobTemplatesResponse'
examples:
ListJobTemplates200Example:
summary: Default ListJobTemplates 200 response
x-microcks-default: true
value:
JobTemplates: example-value
NextToken: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListJobTemplates480Example:
summary: Default ListJobTemplates 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListJobTemplates481Example:
summary: Default ListJobTemplates 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListJobTemplates482Example:
summary: Default ListJobTemplates 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListJobTemplates483Example:
summary: Default ListJobTemplates 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ListJobTemplates484Example:
summary: Default ListJobTemplates 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListJobTemplates485Example:
summary: Default ListJobTemplates 485 response
x-microcks-default: true
value: {}
parameters:
- name: category
in: query
required: false
description: Optionally, specify a job template category to limit responses to only job templates from that category.
schema:
type: string
- name: listBy
in: query
required: false
description: Optional. 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.
schema:
type: string
enum:
- NAME
- CREATION_DATE
- SYSTEM
description: Optional. 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.
- name: maxResults
in: query
required: false
description: Optional. Number of job templates, up to twenty, that will be returned at one time.
schema:
type: integer
minimum: 1
maximum: 20
- name: nextToken
in: query
required: false
description: Use this string, provided with the response to a previous request, to request the next batch of job templates.
schema:
type: string
- name: order
in: query
required: false
description: Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
schema:
type: string
enum:
- ASCENDING
- DESCENDING
description: Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon MediaConvert List Job Templates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- JobTemplates
/2017-08-29/jobTemplates/{name}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteJobTemplate
description: Permanently delete a job template you have created.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteJobTemplateResponse'
examples:
DeleteJobTemplate202Example:
summary: Default DeleteJobTemplate 202 response
x-microcks-default: true
value: {}
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
DeleteJobTemplate480Example:
summary: Default DeleteJobTemplate 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeleteJobTemplate481Example:
summary: Default DeleteJobTemplate 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
DeleteJobTemplate482Example:
summary: Default DeleteJobTemplate 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
DeleteJobTemplate483Example:
summary: Default DeleteJobTemplate 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
DeleteJobTemplate484Example:
summary: Default DeleteJobTemplate 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeleteJobTemplate485Example:
summary: Default DeleteJobTemplate 485 response
x-microcks-default: true
value: {}
parameters:
- name: name
in: path
required: true
description: The name of the job template to be deleted.
schema:
type: string
summary: Amazon MediaConvert Delete Job Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- JobTemplates
get:
operationId: GetJobTemplate
description: Retrieve the JSON for a specific job template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetJobTemplateResponse'
examples:
GetJobTemplate200Example:
summary: Default GetJobTemplate 200 response
x-microcks-default: true
value:
JobTemplate: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
GetJobTemplate480Example:
summary: Default GetJobTemplate 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
GetJobTemplate481Example:
summary: Default GetJobTemplate 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
GetJobTemplate482Example:
summary: Default GetJobTemplate 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
GetJobTemplate483Example:
summary: Default GetJobTemplate 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
GetJobTemplate484Example:
summary: Default GetJobTemplate 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
GetJobTemplate485Example:
summary: Default GetJobTemplate 485 response
x-microcks-default: true
value: {}
parameters:
- name: name
in: path
required: true
description: The name of the job template.
schema:
type: string
summary: Amazon MediaConvert Get Job Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- JobTemplates
put:
operationId: UpdateJobTemplate
description: Modify one of your existing job templates.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJobTemplateResponse'
examples:
UpdateJobTemplate200Example:
summary: Default UpdateJobTemplate 200 response
x-microcks-default: true
value:
JobTemplate: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UpdateJobTemplate480Example:
summary: Default UpdateJobTemplate 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UpdateJobTemplate481Example:
summary: Default UpdateJobTemplate 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
UpdateJobTemplate482Example:
summary: Default UpdateJobTemplate 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
UpdateJobTemplate483Example:
summary: Default UpdateJobTemplate 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
UpdateJobTemplate484Example:
summary: Default UpdateJobTemplate 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
UpdateJobTemplate485Example:
summary: Default UpdateJobTemplate 485 response
x-microcks-default: true
value: {}
parameters:
- name: name
in: path
required: true
description: The name of the job template yo
# --- truncated at 32 KB (809 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/openapi/amazon-mediaconvert-jobtemplates-api-openapi.yml