The Jobs API from Amazon MediaConvert — 2 operation(s) for jobs.
openapi: 3.0.0
info:
version: 2017-08-29
x-release: v4
title: AWS Elemental MediaConvert Certificates Jobs 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: Jobs
paths:
/2017-08-29/jobs/{id}:
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: CancelJob
description: Permanently cancel a job. Once you have canceled a job, you can't start it again.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelJobResponse'
examples:
CancelJob202Example:
summary: Default CancelJob 202 response
x-microcks-default: true
value: {}
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CancelJob480Example:
summary: Default CancelJob 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CancelJob481Example:
summary: Default CancelJob 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CancelJob482Example:
summary: Default CancelJob 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
CancelJob483Example:
summary: Default CancelJob 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CancelJob484Example:
summary: Default CancelJob 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CancelJob485Example:
summary: Default CancelJob 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The Job ID of the job to be cancelled.
schema:
type: string
summary: Amazon MediaConvert Cancel Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Jobs
get:
operationId: GetJob
description: Retrieve the JSON for a specific completed transcoding job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetJobResponse'
examples:
GetJob200Example:
summary: Default GetJob 200 response
x-microcks-default: true
value:
Job: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
GetJob480Example:
summary: Default GetJob 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
GetJob481Example:
summary: Default GetJob 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
GetJob482Example:
summary: Default GetJob 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
GetJob483Example:
summary: Default GetJob 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
GetJob484Example:
summary: Default GetJob 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
GetJob485Example:
summary: Default GetJob 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: the job ID of the job.
schema:
type: string
summary: Amazon MediaConvert Get Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Jobs
/2017-08-29/jobs:
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: CreateJob
description: Create a new transcoding job. For information about jobs and job settings, 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/CreateJobResponse'
examples:
CreateJob201Example:
summary: Default CreateJob 201 response
x-microcks-default: true
value:
Job: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateJob480Example:
summary: Default CreateJob 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateJob481Example:
summary: Default CreateJob 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreateJob482Example:
summary: Default CreateJob 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
CreateJob483Example:
summary: Default CreateJob 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateJob484Example:
summary: Default CreateJob 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateJob485Example:
summary: Default CreateJob 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- role
- 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.
billingTagsSource:
description: The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.
type: string
enum:
- QUEUE
- PRESET
- JOB_TEMPLATE
- JOB
clientRequestToken:
description: Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
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'
jobTemplate:
description: Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.
type: string
priority:
description: Optional. 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. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
type: string
role:
description: Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
type: string
settings:
description: JobSettings contains all the transcode settings for a job.
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/__listOfInput'
- xml:
name: inputs
description: Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.
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).
simulateReservedQueue:
description: Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
type: string
enum:
- DISABLED
- ENABLED
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: Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
userMetadata:
description: Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
summary: Amazon MediaConvert Create Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Jobs
get:
operationId: ListJobs
description: Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListJobsResponse'
examples:
ListJobs200Example:
summary: Default ListJobs 200 response
x-microcks-default: true
value:
Jobs: example-value
NextToken: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListJobs480Example:
summary: Default ListJobs 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListJobs481Example:
summary: Default ListJobs 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListJobs482Example:
summary: Default ListJobs 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListJobs483Example:
summary: Default ListJobs 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ListJobs484Example:
summary: Default ListJobs 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListJobs485Example:
summary: Default ListJobs 485 response
x-microcks-default: true
value: {}
parameters:
- name: maxResults
in: query
required: false
description: Optional. Number of jobs, up to twenty, that will be returned at one time.
schema:
type: integer
minimum: 1
maximum: 20
- name: nextToken
in: query
required: false
description: Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
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: queue
in: query
required: false
description: Optional. Provide a queue name to get back only jobs from that queue.
schema:
type: string
- name: status
in: query
required: false
description: Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
schema:
type: string
enum:
- SUBMITTED
- PROGRESSING
- COMPLETE
- CANCELED
- ERROR
description: A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
- 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 Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Jobs
components:
schemas:
TimedMetadata:
type: string
enum:
- PASSTHROUGH
- NONE
description: 'Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank.'
SccDestinationSettings:
type: object
properties:
Framerate:
allOf:
- $ref: '#/components/schemas/SccDestinationFramerate'
- xml:
name: framerate
description: Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME).
description: Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.
H265QvbrSettings:
type: object
properties:
MaxAverageBitrate:
allOf:
- $ref: '#/components/schemas/__integerMin1000Max1466400000'
- xml:
# --- truncated at 32 KB (816 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/openapi/amazon-mediaconvert-jobs-api-openapi.yml