Jobs
URI
/2017-08-29/jobs
HTTP methods
GET
Operation ID: ListJobs
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.
| Name | Type | Required | Description |
|---|---|---|---|
status | String | False | |
nextToken | String | False | |
maxResults | String | False | |
order | String | False | |
queue | String | False |
| Status code | Response model | Description |
|---|---|---|
200 | ListJobsResponse | 200 response |
400 | ExceptionBody | The service can't process your request because of a problem in the request. Please check your request form and syntax. |
402 | ExceptionBody | You attempted to create more resources than the service allows based on service quotas. |
403 | ExceptionBody | You don't have permissions for this action with the credentials you sent. |
404 | ExceptionBody | The resource you requested does not exist. |
409 | ExceptionBody | The service could not complete your request because there is a conflict with the current state of the resource. |
429 | ExceptionBody | Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
500 | ExceptionBody | The service encountered an unexpected condition and cannot fulfill your request. |
POST
Operation ID: CreateJob
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
| Status code | Response model | Description |
|---|---|---|
201 | CreateJobResponse | 201 response |
400 | ExceptionBody | The service can't process your request because of a problem in the request. Please check your request form and syntax. |
402 | ExceptionBody | You attempted to create more resources than the service allows based on service quotas. |
403 | ExceptionBody | You don't have permissions for this action with the credentials you sent. |
404 | ExceptionBody | The resource you requested does not exist. |
409 | ExceptionBody | The service could not complete your request because there is a conflict with the current state of the resource. |
429 | ExceptionBody | Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests. |
500 | ExceptionBody | The service encountered an unexpected condition and cannot fulfill your request. |
OPTIONS
Supports CORS preflight requests.
| Status code | Response model | Description |
|---|---|---|
200 | None | The request completed successfully. |
Schemas
Request bodies
{ "queue": "string", "status": enum, "order": enum, "nextToken": "string", "maxResults": integer }
{ "clientRequestToken": "string", "jobTemplate": "string", "jobEngineVersion": "string", "queue": "string", "role": "string", "settings": { "timecodeConfig": { "anchor": "string", "source": enum, "start": "string", "timestampOffset": "string" }, "outputGroups": [ { "customName": "string", "name": "string", "outputs": [ { "containerSettings": { "container": enum, "m3u8Settings": { "audioFramesPerPes": integer, "pcrControl": enum, "dataPTSControl": enum, "maxPcrInterval": integer, "pcrPid": integer, "pmtPid": integer, "privateMetadataPid": integer, "programNumber": integer, "patInterval": integer, "pmtInterval": integer, "scte35Source": enum, "scte35Pid": integer, "nielsenId3": enum, "timedMetadata": enum, "timedMetadataPid": integer, "transportStreamId": integer, "videoPid": integer, "ptsOffsetMode": enum, "ptsOffset": integer, "audioPtsOffsetDelta": integer, "audioPids": [ integer ], "audioDuration": enum }, "f4vSettings": { "moovPlacement": enum }, "m2tsSettings": { "audioBufferModel": enum, "minEbpInterval": integer, "esRateInPes": enum, "patInterval": integer, "dvbNitSettings": { "nitInterval": integer, "networkId": integer, "networkName": "string" }, "dvbSdtSettings": { "outputSdt": enum, "sdtInterval": integer, "serviceName": "string", "serviceProviderName": "string" }, "scte35Source": enum, "scte35Pid": integer, "scte35Esam": { "scte35EsamPid": integer }, "klvMetadata": enum, "videoPid": integer, "dvbTdtSettings": { "tdtInterval": integer }, "pmtInterval": integer, "segmentationStyle": enum, "segmentationTime": number, "pmtPid": integer, "bitrate": integer, "audioPids": [ integer ], "privateMetadataPid": integer, "nielsenId3": enum, "timedMetadataPid": integer, "maxPcrInterval": integer, "transportStreamId": integer, "dvbSubPids": [ integer ], "rateMode": enum, "audioFramesPerPes": integer, "pcrControl": enum, "dataPTSControl": enum, "segmentationMarkers": enum, "ebpAudioInterval": enum, "forceTsVideoEbpOrder": enum, "programNumber": integer, "pcrPid": integer, "bufferModel": enum, "dvbTeletextPid": integer, "fragmentTime": number, "ebpPlacement": enum, "nullPacketBitrate": number, "audioDuration": enum, "ptsOffsetMode": enum, "ptsOffset": integer, "audioPtsOffsetDelta": integer, "preventBufferUnderflow": enum }, "movSettings": { "clapAtom": enum, "cslgAtom": enum, "paddingControl": enum, "reference": enum, "mpeg2FourCCControl": enum }, "mp4Settings": { "cslgAtom": enum, "cttsVersion": integer, "freeSpaceBox": enum, "mp4MajorBrand": "string", "moovPlacement": enum, "audioDuration": enum, "c2paManifest": enum, "certificateSecret": "string", "signingKmsKey": "string" }, "mpdSettings": { "accessibilityCaptionHints": enum, "captionContainerType": enum, "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum, "c2paManifest": enum, "certificateSecret": "string", "signingKmsKey": "string" }, "cmfcSettings": { "scte35Source": enum, "scte35Esam": enum, "audioDuration": enum, "iFrameOnlyManifest": enum, "audioGroupId": "string", "audioRenditionSets": "string", "audioTrackType": enum, "descriptiveVideoServiceFlag": enum, "timedMetadata": enum, "timedMetadataBoxVersion": enum, "timedMetadataSchemeIdUri": "string", "timedMetadataValue": "string", "manifestMetadataSignaling": enum, "klvMetadata": enum, "c2paManifest": enum, "certificateSecret": "string", "signingKmsKey": "string" }, "mxfSettings": { "afdSignaling": enum, "profile": enum, "uncompressedAudioWrapping": enum, "xavcProfileSettings": { "durationMode": enum, "maxAncDataSize": integer } } }, "preset": "string", "videoDescription": { "fixedAfd": integer, "width": integer, "scalingBehavior": enum, "crop": { "height": integer, "width": integer, "x": integer, "y": integer }, "height": integer, "videoPreprocessors": { "colorCorrector": { "brightness": integer, "colorSpaceConversion": enum, "sampleRangeConversion": enum, "clipLimits": { "minimumYUV": integer, "maximumYUV": integer, "minimumRGBTolerance": integer, "maximumRGBTolerance": integer }, "sdrReferenceWhiteLevel": integer, "contrast": integer, "hue": integer, "saturation": integer, "maxLuminance": integer, "hdr10Metadata": { "redPrimaryX": integer, "redPrimaryY": integer, "greenPrimaryX": integer, "greenPrimaryY": integer, "bluePrimaryX": integer, "bluePrimaryY": integer, "whitePointX": integer, "whitePointY": integer, "maxFrameAverageLightLevel": integer, "maxContentLightLevel": integer, "maxLuminance": integer, "minLuminance": integer }, "hdrToSdrToneMapper": enum }, "deinterlacer": { "algorithm": enum, "mode": enum, "control": enum }, "dolbyVision": { "profile": enum, "l6Mode": enum, "l6Metadata": { "maxCll": integer, "maxFall": integer }, "mapping": enum, "compatibility": enum }, "hdr10Plus": { "masteringMonitorNits": integer, "targetMonitorNits": integer }, "imageInserter": { "insertableImages": [ { "width": integer, "height": integer, "imageX": integer, "imageY": integer, "duration": integer, "fadeIn": integer, "layer": integer, "imageInserterInput": "string", "startTime": "string", "fadeOut": integer, "opacity": integer } ], "sdrReferenceWhiteLevel": integer }, "noiseReducer": { "filter": enum, "filterSettings": { "strength": integer }, "spatialFilterSettings": { "strength": integer, "speed": integer, "postFilterSharpenStrength": integer }, "temporalFilterSettings": { "strength": integer, "speed": integer, "aggressiveMode": integer, "postTemporalSharpening": enum, "postTemporalSharpeningStrength": enum } }, "timecodeBurnin": { "fontSize": integer, "position": enum, "prefix": "string" }, "partnerWatermarking": { "nexguardFileMarkerSettings": { "license": "string", "preset": "string", "payload": integer, "strength": enum } } }, "timecodeInsertion": enum, "timecodeTrack": enum, "antiAlias": enum, "position": { "height": integer, "width": integer, "x": integer, "y": integer }, "sharpness": integer, "codecSettings": { "codec": enum, "av1Settings": { "gopSize": number, "numberBFramesBetweenReferenceFrames": integer, "slices": integer, "bitDepth": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "qvbrQualityLevelFineTune": number }, "maxBitrate": integer, "adaptiveQuantization": enum, "spatialAdaptiveQuantization": enum, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "filmGrainSynthesis": enum, "perFrameMetrics": [ enum ] }, "avcIntraSettings": { "avcIntraClass": enum, "avcIntraUhdSettings": { "qualityTuningLevel": enum }, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateDenominator": integer, "slowPal": enum, "framerateControl": enum, "telecine": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "perFrameMetrics": [ enum ] }, "frameCaptureSettings": { "framerateNumerator": integer, "framerateDenominator": integer, "maxCaptures": integer, "quality": integer }, "gifSettings": { "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer }, "h264Settings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "entropyEncoding": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "qvbrQualityLevelFineTune": number, "maxAverageBitrate": integer }, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "saliencyAwareEncoding": enum, "codecLevel": enum, "fieldEncoding": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "repeatPps": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum, "hrdBufferFinalFillPercentage": integer, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum }, "endOfStreamMarkers": enum, "perFrameMetrics": [ enum ] }, "h265Settings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "numberReferenceFrames": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "alternateTransferFunctionSei": enum, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "slices": integer, "gopBReference": enum, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "flickerAdaptiveQuantization": enum, "bitrate": integer, "framerateControl": enum, "rateControlMode": enum, "qvbrSettings": { "qvbrQualityLevel": integer, "qvbrQualityLevelFineTune": number, "maxAverageBitrate": integer }, "codecProfile": enum, "tiles": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "unregisteredSeiTimecode": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "temporalIds": enum, "sampleAdaptiveOffsetFilterMode": enum, "writeMp4PackagingType": enum, "dynamicSubGop": enum, "hrdBufferFinalFillPercentage": integer, "endOfStreamMarkers": enum, "deblocking": enum, "tileWidth": integer, "tileHeight": integer, "tilePadding": enum, "mvTemporalPredictor": enum, "mvOverPictureBoundaries": enum, "treeBlockSize": enum, "bandwidthReductionFilter": { "strength": enum, "sharpening": enum }, "perFrameMetrics": [ enum ] }, "mpeg2Settings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "syntax": enum, "softness": integer, "framerateDenominator": integer, "gopClosedCadence": integer, "hrdBufferInitialFillPercentage": integer, "gopSize": number, "hrdBufferSize": integer, "maxBitrate": integer, "slowPal": enum, "parDenominator": integer, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "bitrate": integer, "intraDcPrecision": enum, "framerateControl": enum, "rateControlMode": enum, "codecProfile": enum, "telecine": enum, "framerateNumerator": integer, "minIInterval": integer, "adaptiveQuantization": enum, "codecLevel": enum, "sceneChangeDetect": enum, "qualityTuningLevel": enum, "framerateConversionAlgorithm": enum, "gopSizeUnits": enum, "parControl": enum, "numberBFramesBetweenReferenceFrames": integer, "dynamicSubGop": enum, "hrdBufferFinalFillPercentage": integer, "perFrameMetrics": [ enum ] }, "proresSettings": { "interlaceMode": enum, "scanTypeConversionMode": enum, "parNumerator": integer, "framerateDenominator": integer, "codecProfile": enum, "slowPal": enum, "parDenominator": integer, "framerateControl": enum, "telecine": enum, "chromaSampling": enum, "framerateNumerator": integer, "framerateConversionAlgorithm": enum, "parControl": enum, "perFrameMetrics": [ enum ] }, "uncompressedSettings": { "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "interlaceMode": enum, "scanTypeConversionMode": enum, "telecine": enum, "slowPal": enum, "fourcc": enum }, "vc3Settings": { "vc3Class": enum, "interlaceMode": enum, "scanTypeConversionMode": enum, "framerateConversionAlgorithm": enum, "telecine": enum, "slowPal": enum, "framerateControl": enum, "framerateDenominator": integer, "framerateNumerator": integer }, "vp8Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "vp9Settings": { "qualityTuningLevel": enum, "rateControlMode": enum, "gopSize": number, "maxBitrate": integer, "bitrate": integer, "hrdBufferSize": integer, "framerateControl": enum, "framerateConversionAlgorithm": enum, "framerateNumerator": integer, "framerateDenominator": integer, "parControl": enum, "parNumerator": integer, "parDenominator": integer }, "xavcSettings": { "profile": enum, "xavcHdIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraCbgProfileSettings": { "xavcClass": enum }, "xavc4kIntraVbrProfileSettings": { "xavcClass": enum }, "xavcHdProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "qualityTuningLevel": enum, "interlaceMode": enum, "telecine": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "xavc4kProfileSettings": { "bitrateClass": enum, "slices": integer, "hrdBufferSize": integer, "codecProfile": enum, "qualityTuningLevel": enum, "gopClosedCadence": integer, "gopBReference": enum, "flickerAdaptiveQuantization": enum }, "softness": integer, "framerateDenominator": integer, "slowPal": enum, "spatialAdaptiveQuantization": enum, "temporalAdaptiveQuantization": enum, "entropyEncoding": enum, "framerateControl": enum, "framerateNumerator": integer, "adaptiveQuantization": enum, "framerateConversionAlgorithm": enum, "perFrameMetrics": [ enum ] }, "passthroughSettings": { "videoSelectorMode": enum, "frameControl": enum } }, "afdSignaling": enum, "dropFrameTimecode": enum, "respondToAfd": enum, "chromaPositionMode": enum, "colorMetadata": enum }, "audioDescriptions": [ { "audioTypeControl": enum, "audioSourceName": "string", "audioNormalizationSettings": { "algorithm": enum, "algorithmControl": enum, "correctionGateLevel": integer, "loudnessLogging": enum, "targetLkfs": number, "peakCalculation": enum, "truePeakLimiterThreshold": number }, "audioPitchCorrectionSettings": { "slowPalPitchCorrection": enum }, "audioChannelTaggingSettings": { "channelTag": enum, "channelTags": [ enum ] }, "codecSettings": { "codec": enum, "aacSettings": { "audioDescriptionBroadcasterMix": enum, "vbrQuality": enum, "