How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon MediaConvert Jobs API

The Jobs API from Amazon MediaConvert — 2 operation(s) for jobs.

Amazon MediaConvert Jobs API is one of 8 APIs that Amazon MediaConvert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 4 operations across 2 paths, and defines 755 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://mediaconvert.{region}.amazonaws.com, https://mediaconvert.{region}.amazonaws.com, http://mediaconvert.{region}.amazonaws.com.cn, https://mediaconvert.{region}.amazonaws.com.cn.

4 operations 2 paths 755 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
http://mediaconvert.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon MediaConvert Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 4
DELETE
/2017-08-29/jobs/{id}
Amazon MediaConvert Cancel Job
CancelJob 8 params → 202480481482483484485
GET
/2017-08-29/jobs/{id}
Amazon MediaConvert Get Job
GetJob 8 params → 200480481482483484485
POST
/2017-08-29/jobs
Amazon MediaConvert Create Job
CreateJob 7 params body → 201480481482483484485
GET
/2017-08-29/jobs
Amazon MediaConvert List Jobs
ListJobs 14 params → 200480481482483484485

Schemas 755

The contract defines 755 schemas that model the data the API accepts and returns. The most detailed are H264Settings (42 properties), H265Settings (41 properties), M2tsSettings (39 properties), Mpeg2Settings (33 properties). Each schema is shown below with its type and property counts.

AutomatedAbrRule
object
Specify one or more Automated ABR rule types. Note: Force include and Allowed renditions are mutually exclusive.
5 properties
Rectangle
object
Use Rectangle to identify a specific area of the video frame.
4 properties
HlsInitializationVectorInManifest
string
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the…
H265FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
H265Telecine
string
This field applies only if the Streams Advanced Framerate (framerate) field is set to 29.970. This field works with the Streams Advanced Preprocessors Deinterl…
Vp9QualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
AvcIntraUhdSettings
object
Optional when you set AVC-Intra class (avcIntraClass) to Class 4K/2K (CLASS4K2K). When you set AVC-Intra class to a different value, this object isn't allowed.
1 property
ProresFramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
VideoDetail
object
Contains details about the output's video stream
2 properties
QueueTransition
object
Description of the source and destination queues between which the job has moved, along with the timestamp of the move
3 properties
DvbNitSettings
object
Use these settings to insert a DVB Network Information Table (NIT) in the transport stream of this output. When you work directly in your JSON job specificatio…
3 properties
DropFrameTimecode
string
Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame t…
MovClapAtom
string
When enabled, include 'clap' atom if appropriate for the video output settings.
SpekeKeyProvider
object
If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output g…
4 properties
CopyProtectionAction
string
The action to take on copy and redistribution control XDS packets. If you select PASSTHROUGH, packets will not be changed. If you select STRIP, any packets wil…
__doubleMinNegative60Max3
number
DolbyVisionLevel6Metadata
object
Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in your input with new values.
2 properties
TimecodeBurninPosition
string
Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video.
Mpeg2CodecLevel
string
Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.
XavcSpatialAdaptiveQuantization
string
The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (adaptiveQuantization). When you…
MovReference
string
Always keep the default value (SELFCONTAINED) for this setting.
__stringPatternSNManifestConfirmConditionNotificationNS
string
XavcGopBReference
string
Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames a…
DashManifestStyle
string
Specify how MediaConvert writes SegmentTimeline in your output DASH manifest. To write a SegmentTimeline in each video Representation: Keep the default value,…
WebvttStylePassthrough
string
To use the available style, color, and position information from your input captions: Set Style passthrough (stylePassthrough) to Enabled (ENABLED). MediaConve…
__integerMin1Max512
integer
Vp9RateControlMode
string
With the VP9 codec, you can use only the variable bitrate (VBR) rate control mode.
BurninSubtitleShadowColor
string
Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the…
CmfcIFrameOnlyManifest
string
Choose Include (INCLUDE) to have MediaConvert generate an HLS child manifest that lists only the I-frames for this rendition, in addition to your regular manif…
__integerMin32Max8182
integer
CmafWriteDASHManifest
string
When set to ENABLED, a DASH MPD manifest will be generated for this output.
CmafPtsOffsetHandlingForBFrames
string
Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode t…
__integerMin10Max48
integer
HlsStreamInfResolution
string
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
JobStatus
string
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
BandwidthReductionFilterSharpening
string
Optionally specify the level of sharpening to apply when you use the Bandwidth reduction filter. Sharpening adds contrast to the edges of your video content an…
__listOfInput
array
HlsAdMarkers
string
Ad marker for Apple HLS manifest.
AudioDescription
object
Settings related to one audio tab on the MediaConvert console. In your job JSON, an instance of AudioDescription is equivalent to one audio tab in the console.…
11 properties
Eac3AtmosDialogueIntelligence
string
Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.
HlsProgramDateTime
string
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized…
Ac3DynamicRangeCompressionLine
string
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operati…
DvbSubSubtitleFallbackFont
string
Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you…
MsSmoothFragmentLengthControl
string
Specify how you want MediaConvert to determine the fragment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the set…
DashIsoVideoCompositionOffsets
string
Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or…
Mpeg2ScanTypeConversionMode
string
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLA…
H265DynamicSubGop
string
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based o…
Eac3LfeControl
string
When encoding 3/2 audio, controls whether the LFE channel is enabled
ImscStylePassthrough
string
Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available onl…
__doubleMin0
number
DvbSubtitleOutlineColor
string
Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data…
DolbyVisionMapping
string
Required when you set Dolby Vision Profile to Profile 8.1. When you set Content mapping to None, content mapping is not applied to the HDR10-compatible signal.…
AutomatedEncodingSettings
object
Use automated encoding to have MediaConvert choose your encoding settings for you, based on characteristics of your input video.
1 property
CmafImageBasedTrickPlaySettings
object
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
6 properties
AacSpecification
string
Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.
__listOfForceIncludeRenditionSize
array
__integerMin0Max1152000000
integer
MpdTimedMetadataBoxVersion
string
Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. L…
SccDestinationFramerate
string
Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the fram…
__listOfQueueTransition
array
M2tsEbpPlacement
string
Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when…
CmafManifestCompression
string
When set to GZIP, compresses HLS playlist.
Av1RateControlMode
string
'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'
AacCodingMode
string
The Coding mode that you specify determines the number of audio channels and the audio channel layout metadata in your AAC output. Valid coding modes depend on…
Vp8QualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
__stringPatternS3Https
string
__stringPatternHttpsKantarmediaCom
string
Av1QvbrSettings
object
Settings for quality-defined variable bitrate encoding with the AV1 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode).
2 properties
H265FlickerAdaptiveQuantization
string
Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some…
H264RateControlMode
string
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).
__stringMin1Max50PatternAZAZ09
string
Vp8Settings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value VP8.
13 properties
__stringMin14PatternS3BmpBMPPngPNGHttpsBmpBMPPngPNG
string
__integerMin1000Max1466400000
integer
DashIsoMpdProfile
string
Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAINPROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 i…
__listOfId3Insertion
array
__integerMin1Max10
integer
XavcHdProfileSettings
object
Required when you set (Profile) under (VideoDescription)(CodecSettings)(XavcSettings) to the value XAVCHD.
9 properties
HlsImageBasedTrickPlay
string
Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to…
__integerMin0Max4000
integer
__integerMin0Max65534
integer
H264Telecine
string
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or…
CmfcTimedMetadataBoxVersion
string
Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. L…
MotionImageInserter
object
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 h…
6 properties
MotionImageInsertionMode
string
Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.
H264CodecProfile
string
H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.
__integerMin0Max3600
integer
Xavc4kProfileCodecProfile
string
Specify the codec profile for this output. Choose High, 8-bit, 4:2:0 (HIGH) or High, 10-bit, 4:2:2 (HIGH422). These profiles are specified in ITU-T H.264.
XavcEntropyEncoding
string
Optional. Choose a specific entropy encoding mode only when you want to override XAVC recommendations. If you choose the value auto, MediaConvert uses the mode…
ContainerSettings
object
Container specific settings.
9 properties
__integerMin0Max99
integer
M2tsScte35Esam
object
Settings for SCTE-35 signals from ESAM. Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion poin…
1 property
AvailBlanking
object
Use ad avail blanking settings to specify your output content during SCTE-35 triggered ad avails. You can blank your video or overlay it with an image. MediaCo…
1 property
XavcAdaptiveQuantization
string
Keep the default value, Auto (AUTO), for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you…
HopDestination
object
Optional. Configuration for a destination queue to which the job can hop once a customer-defined minimum wait time has passed.
3 properties
CmafSegmentControl
string
When set to SINGLEFILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTEDFIL…
Mpeg2TemporalAdaptiveQuantization
string
Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this fea…
__stringMin6Max8Pattern09aFAF609aFAF2
string
CmafAdditionalManifest
object
Specify the details for each pair of HLS and DASH additional manifests that you want the service to generate for this CMAF output group. Each pair of manifests…
2 properties
CmafWriteHLSManifest
string
When set to ENABLED, an Apple HLS manifest will be generated for this output.
H264SlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL,…
Mpeg2GopSizeUnits
string
Specify the units for GOP size (GopSize). If you don't specify a value here, by default the encoder measures GOP size in frames.
__integerMin0Max7
integer
CmafClientCache
string
Disable this setting only when your workflow requires the EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in…
OutputSettings
object
Specific settings for this type of output.
1 property
__stringPatternAZaZ0902
string
TimecodeConfig
object
These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
4 properties
VideoDescription
object
Settings related to video encoding of your output. The specific video settings depend on the video codec that you choose. When you work directly in your JSON j…
15 properties
BurninSubtitleTeletextSpacing
string
Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXEDG…
__listOf__integerMin32Max8182
array
M2tsAudioDuration
string
Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between v…
JobPhase
string
A job's phase can be PROBING, TRANSCODING OR UPLOADING
__integerMinNegative1Max10
integer
__stringPatternWS
string
TeletextDestinationSettings
object
Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaco…
2 properties
AacRateControlMode
string
Rate Control Mode.
H264DynamicSubGop
string
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based o…
BandwidthReductionFilter
object
The Bandwidth reduction filter increases the video quality of your output relative to its bitrate. Use to lower the bitrate of your constant quality QVBR outpu…
2 properties
MovPaddingControl
string
Unless you need Omneon compatibility: Keep the default value, None. To make this output compatible with Omneon: Choose Omneon. When you do, MediaConvert increa…
AncillaryTerminateCaptions
string
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this s…
AudioNormalizationAlgorithmControl
string
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
HlsGroupSettings
object
Settings related to your HLS output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work…
31 properties
__integerMin96Max600
integer
StaticKeyProvider
object
Use these settings to set up encryption with a static key provider.
4 properties
H265GopSizeUnits
string
Specify how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on char…
__integerMin4Max12
integer
EmbeddedSourceSettings
object
Settings for embedded captions Source
4 properties
AudioDefaultSelection
string
Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified inp…
ScalingBehavior
string
Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCHTOOUTPUT) to have the…
M2tsRateMode
string
When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but th…
VchipAction
string
The action to take on content advisory XDS packets. If you select PASSTHROUGH, packets will not be changed. If you select STRIP, any packets will be removed in…
__stringMin16Max24PatternAZaZ0922AZaZ0916
string
Eac3AtmosDynamicRangeCompressionLine
string
Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default…
__integerMin100Max1000
integer
__integerMinNegative1000Max1000
integer
__listOf__doubleMinNegative60Max6
array
__integerMin0Max1
integer
__integerMin0Max500
integer
NoiseReducerTemporalFilterSettings
object
Noise reducer filter settings for temporal filter.
5 properties
ProresTelecine
string
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard tel…
__integerMin1000Max30000
integer
Mpeg2FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
Vp8ParControl
string
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZEFROMSOURCE), uses the…
__listOfOutputGroupDetail
array
ProresSettings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value PRORES.
13 properties
M2tsScte35Source
string
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Cho…
MpdScte35Source
string
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your…
RemixSettings
object
Use Manual audio remixing (RemixSettings) to adjust audio levels for each audio channel in each output of your job. With audio remixing, you can output more or…
3 properties
M2tsEbpAudioInterval
string
When set to VIDEOANDFIXEDINTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and wil…
TeletextPageType
string
A page type as defined in the standard ETSI EN 300 468, Table 94
Xavc4kProfileQualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
__integerMin1Max1001
integer
ColorSpaceUsage
string
There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10M…
M2tsPcrControl
string
When set to PCREVERYPESPACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the…
TimecodeSource
string
Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and t…
AudioSelectorType
string
Specifies the type of the audio selector.
AvcIntraInterlaceMode
string
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your…
__listOfOutputChannelMapping
array
MotionImageInsertionOffset
object
Specify the offset between the upper-left corner of the video frame and the top left corner of the overlay.
2 properties
MxfSettings
object
These settings relate to your MXF output container.
3 properties
__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTWebvttWEBVTTHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTWebvttWEBVTT
string
CmfcTimedMetadata
string
To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserte…
__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912MrkAFAF0932
string
H265AlternateTransferFunctionSei
string
Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).
DvbSubtitleTeletextSpacing
string
Specify whether the Text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXEDG…
DvbTdtSettings
object
Use these settings to insert a DVB Time and Date Table (TDT) in the transport stream of this output. When you work directly in your JSON job specification, inc…
1 property
Ac3DynamicRangeCompressionRf
string
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating…
XavcSettings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value XAVC.
16 properties
__listOf__string
array
AudioNormalizationLoudnessLogging
string
If set to LOG, log each output's audio track loudness to a CSV file.
__integerMin0Max0
integer
CmafEncryptionType
string
Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AESCTR (AES-CTR).
SrtDestinationSettings
object
Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in t…
1 property
Job
object
Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/wh…
27 properties 2 required
Mpeg2RateControlMode
string
Use Rate control mode (Mpeg2RateControlMode) to specify whether the bitrate is variable (vbr) or constant (cbr).
XavcHdIntraCbgProfileSettings
object
Required when you set (Profile) under (VideoDescription)(CodecSettings)(XavcSettings) to the value XAVCHDINTRACBG.
1 property
__stringPattern010920405090509092
string
__integerMinNegative5Max10
integer
__integerMin0Max1466400000
integer
InputDecryptionSettings
object
Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Manageme…
4 properties
H264QualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
AudioChannelTaggingSettings
object
When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks…
1 property
VideoPreprocessor
object
Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by…
8 properties
ForbiddenException
DashIsoImageBasedTrickPlaySettings
object
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
6 properties
DeinterlacerMode
string
Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. -…
__integerMin0Max10
integer
AacSettings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settin…
9 properties
__integerMin8Max4096
integer
XavcHdIntraCbgProfileClass
string
Specify the XAVC Intra HD (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that ar…
__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12
string
HlsOutputSelection
string
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.
Vc3InterlaceMode
string
Optional. Choose the scan line type for this output. If you don't specify a value, MediaConvert will create a progressive output.
Mpeg2Syntax
string
Specify whether this output's video uses the D10 syntax. Keep the default value to not use the syntax. Related settings: When you choose D10 (D10) for your MXF…
__listOfAllowedRenditionSize
array
AvcIntraSlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL,…
MovSettings
object
These settings relate to your QuickTime MOV output container.
5 properties
DashIsoGroupAudioChannelConfigSchemeIdUri
string
Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby ch…
InputClipping
object
To transcode only portions of your input, include one input clip for each part of your input that you want in your output. All input clips that you specify wil…
2 properties
S3DestinationAccessControl
object
Optional. Have MediaConvert automatically apply Amazon S3 access control for the outputs in this output group. When you don't use this setting, S3 automaticall…
1 property
__integerMin32000Max48000
integer
HlsAdditionalManifest
object
Specify the details for each additional HLS manifest that you want the service to generate for this output group. Each manifest can reference a different subse…
2 properties
EmbeddedTerminateCaptions
string
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this s…
AudioCodecSettings
object
Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.
11 properties
Eac3Settings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value EAC3.
21 properties
Eac3AtmosBitstreamMode
string
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).
M3u8NielsenId3
string
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
DeinterlacerControl
string
- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged…
__integerMinNegative2147483648Max2147483647
integer
Mpeg2SceneChangeDetect
string
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.
AudioCodec
string
Choose the audio codec for this output. Note that the option Dolby Digital passthrough (PASSTHROUGH) applies only to Dolby Digital and Dolby Digital Plus audio…
__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12
array
DashIsoHbbtvCompliance
string
Supports HbbTV specification as indicated
M2tsBufferModel
string
Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, b…
XavcTemporalAdaptiveQuantization
string
The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (adaptiveQuantization). When you…
InputFilterEnable
string
Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and…
Av1BitDepth
string
Specify the Bit depth (Av1BitDepth). You can choose 8-bit (BIT8) or 10-bit (BIT10).
__doubleMin0Max1
number
EsamSettings
object
Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
3 properties
M3u8Scte35Source
string
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Cho…
__integerMinNegative60Max6
integer
Eac3AtmosCodingMode
string
The coding mode for Dolby Digital Plus JOC (Atmos).
ProresInterlaceMode
string
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your…
Mp4Settings
object
These settings relate to your MP4 output container. You can create audio only outputs with this container. For more information, see https://docs.aws.amazon.co…
6 properties
BurninSubtitleFontColor
string
Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font co…
DvbSubtitleBackgroundColor
string
Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled…
TimedMetadata
string
Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: I…
H265RateControlMode
string
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).
XavcFramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
S3EncryptionSettings
object
Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.
3 properties
__integerMin1Max4096
integer
Mpeg2Settings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value MPEG2.
33 properties
CmfcScte35Source
string
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your…
Mpeg2DynamicSubGop
string
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based o…
__listOfInputClipping
array
__integerMin0Max128
integer
__listOfOutputDetail
array
__listOf__stringMin1
array
CaptionSelector
object
Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.
3 properties
__integerMin22050Max48000
integer
__stringMin1Max256
string
Eac3AtmosMeteringMode
string
Choose how the service meters the loudness of your audio.
InternalServerErrorException
__stringPatternIdentityAZaZ26AZaZ09163
string
Eac3BitstreamMode
string
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).
H265ParControl
string
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZEFROMSOURCE), uses the…
M2tsKlvMetadata
string
To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passe…
S3DestinationSettings
object
Settings associated with S3 destination
2 properties
DolbyVision
object
Create Dolby Vision Profile 5 or Profile 8.1 compatible video output.
4 properties
HlsAudioOnlyContainer
string
Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic…
Ac3MetadataControl
string
When set to FOLLOWINPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one…
Eac3AtmosStereoDownmix
string
Choose how the service does stereo downmixing. Default value: Not indicated (ATMOSSTORAGEDDPDMIXMODNOTINDICATED) Related setting: To have MediaConvert use this…
CmafWriteSegmentTimelineInRepresentation
string
When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segm…
CmafMpdProfile
string
Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAINPROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 i…
H264FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
DvbSubSourceSettings
object
DVB Sub Source Settings
1 property
OpusSettings
object
Required when you set Codec, under AudioDescriptionsCodecSettings, to the value OPUS.
3 properties
AvcIntraFramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
MxfProfile
string
Specify the MXF profile, also called shim, for this output. When you choose Auto, MediaConvert chooses a profile based on the video codec and resolution. For a…
Vc3Class
string
Specify the VC3 class to choose the quality characteristics for this output. VC3 class, together with the settings Framerate (framerateNumerator and framerateD…
TeletextSourceSettings
object
Settings specific to Teletext caption sources, including Page number.
1 property
__mapOfAudioSelectorGroup
object
DvbSubtitleApplyFontColor
string
Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Us…
Vp8RateControlMode
string
With the VP8 codec, you can use only the variable bitrate (VBR) rate control mode.
DvbSubDestinationSettings
object
Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconv…
27 properties
BurninSubtitleApplyFontColor
string
Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Us…
DashIsoEncryptionSettings
object
Specifies DRM settings for DASH outputs.
2 properties
M2tsForceTsVideoEbpOrder
string
Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem,…
InputTimecodeSource
string
Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input fram…
BadRequestException
CaptionDescription
object
This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.
5 properties
HlsManifestDurationFormat
string
Indicates whether the output manifest should use floating point values for segment duration.
XavcSlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video fra…
NielsenSourceWatermarkStatusType
string
Required. Specify whether your source content already contains Nielsen non-linear watermarks. When you set this value to Watermarked (WATERMARKED), the service…
__listOfCmafAdditionalManifest
array
H264SpatialAdaptiveQuantization
string
Only use this setting when you change the default value, Auto (AUTO), for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264Adapt…
Eac3AtmosDynamicRangeControl
string
Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom (SPECIFIED), to provide dynamic…
Xavc4kIntraVbrProfileSettings
object
Required when you set (Profile) under (VideoDescription)(CodecSettings)(XavcSettings) to the value XAVC4KINTRAVBR.
1 property
__listOfJob
array
AudioNormalizationAlgorithm
string
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of…
NoiseReducerFilterSettings
object
Settings for a noise reducer filter
1 property
ColorCorrector
object
Settings for color correction.
10 properties
__integerMin1Max10000000
integer
__stringPattern0940191020191209301
string
HlsManifestCompression
string
When set to GZIP, compresses HLS playlist.
__integerMin0Max30000
integer
Av1Settings
object
Required when you set Codec, under VideoDescriptionCodecSettings to the value AV1.
13 properties
Av1FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
__integerMin16000Max48000
integer
BurninSubtitleFallbackFont
string
Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you…
F4vSettings
object
Settings for F4v container
1 property
__string
string
HlsIntervalCadence
string
The cadence MediaConvert follows for generating thumbnails. If set to FOLLOWIFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matchin…
InsertableImage
object
These settings apply to a specific graphic overlay. You can include multiple overlays in your job.
11 properties
CaptionSourceFramerate
object
Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input vi…
2 properties
TtmlStylePassthrough
string
Pass through style and position information from a TTML-like input source (TTML, IMSC, SMPTE-TT) to the TTML output.
Mpeg2SpatialAdaptiveQuantization
string
Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feat…
Vc3FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
MsSmoothAdditionalManifest
object
Specify the details for each additional Microsoft Smooth Streaming manifest that you want the service to generate for this output group. Each manifest can refe…
2 properties
__integerMin0Max1000
integer
ColorSpace
string
If your input video has accurate color space metadata, or if you don't know about color space: Keep the default value, Follow. MediaConvert will automatically…
__integerMin6000Max1024000
integer
Mpeg2SlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL,…
H264QvbrSettings
object
Settings for quality-defined variable bitrate encoding with the H.264 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode).
3 properties
__integerMin0Max96
integer
SrtStylePassthrough
string
Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses def…
__stringPattern0xAFaF0908190908
string
__stringMin14PatternS3XmlXMLHttpsXmlXML
string
__integerMin1Max60000
integer
ClipLimits
object
Specify YUV limits and RGB tolerances when you set Sample range conversion to Limited range clip.
4 properties
AntiAlias
string
The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job,…
MpdAudioDuration
string
Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between v…
EmbeddedConvert608To708
string
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the c…
Eac3PhaseControl
string
Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.
Eac3AtmosSettings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value EAC3ATMOS.
17 properties
__listOfCaptionDescription
array
__integerMin48000Max48000
integer
RespondToAfd
string
Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. Choose Respond to clip the input…
M2tsSegmentationMarkers
string
Inserts segmentation markers at each segmentationtime period. raisegstart sets the Random Access Indicator bit in the adaptation field. raiadapt sets the RAI b…
H264GopSizeUnits
string
Specify how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on char…
__integerMin50Max86400000
integer
ImscDestinationSettings
object
Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in…
2 properties
__integerMinNegative1Max3
integer
M2tsSettings
object
MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In t…
39 properties
H264ParControl
string
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZEFROMSOURCE), uses the…
OutputGroupType
string
Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)
Vp9Settings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value VP9.
13 properties
HlsKeyProviderType
string
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aw…
FileSourceSettings
object
If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption sour…
5 properties
Mpeg2QualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
BurninSubtitleBackgroundColor
string
Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled…
__integerMin1Max2147483640
integer
TimedMetadataInsertion
object
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…
1 property
H265TemporalAdaptiveQuantization
string
Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this fea…
DvbSubtitleFontColor
string
Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data f…
TimecodeBurnin
object
Settings for burning the output timecode and specified prefix into the output.
3 properties
InputSampleRange
string
If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this settin…
__stringMin1
string
ColorSpaceConversion
string
Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SD…
GetJobResponse
object
1 property
ProresCodecProfile
string
Use Profile (ProResCodecProfile) to specify the type of Apple ProRes codec to use for this output.
H265TemporalIds
string
Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference…
Vp8FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
HlsCodecSpecification
string
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
Eac3AtmosDownmixControl
string
Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom (SPECIFIED) to provide downmix values in your…
Vc3Settings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value VC3
9 properties
MpdScte35Esam
string
Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify…
AccelerationMode
string
Specify whether the service runs your job with accelerated transcoding. Choose DISABLED if you don't want accelerated transcoding. Choose ENABLED if you want y…
S3ServerSideEncryptionType
string
Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master ke…
CmafVideoCompositionOffsets
string
Specify the video sample composition time offset mode in the output fMP4 TRUN box. For wider player compatibility, set Video composition offsets to Unsigned or…
__listOfHlsAdMarkers
array
__integerMin90Max105
integer
H265WriteMp4PackagingType
string
If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with stand…
M3u8AudioDuration
string
Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between v…
M2tsDataPtsControl
string
If you select ALIGNTOVIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video pac…
CmafImageBasedTrickPlay
string
Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to…
__doubleMinNegative6Max3
number
H265InterlaceMode
string
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your…
DashIsoPtsOffsetHandlingForBFrames
string
Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode t…
__integerMin0Max47185920
integer
AvcIntraTelecine
string
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard tel…
HlsCaptionLanguageMapping
object
Caption Language Mapping
4 properties
HlsIFrameOnlyManifest
string
Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest f…
HlsAudioTrackType
string
Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scen…
__doubleMinNegative60Max6
number
__integerMin1Max6
integer
BurnInSubtitleStylePassthrough
string
Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses def…
Xavc4kProfileBitrateClass
string
Specify the XAVC 4k (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points…
__integerMin1000Max288000000
integer
HlsTargetDurationCompatibilityMode
string
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\COMPLIA…
XavcHdProfileBitrateClass
string
Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points…
HlsDirectoryStructure
string
Indicates whether segments should be placed in subdirectories.
HlsAudioOnlyHeader
string
Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output a…
CmfcAudioTrackType
string
Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. T…
Vp9FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
H265Settings
object
Settings for H265 codec
41 properties
__stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912
string
M2tsEsRateInPes
string
Controls whether to include the ES Rate field in the PES header.
Ac3BitstreamMode
string
Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).
BurninDestinationSettings
object
Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video cont…
21 properties
__integerMinNegative2Max3
integer
__stringMin1Max512PatternAZAZ09
string
__stringPatternHttps
string
DolbyVisionLevel6Mode
string
Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.
__integerMin0Max2147483647
integer
__integerMin1000Max480000000
integer
__integerMin1Max4
integer
__integerMin1Max100
integer
Eac3SurroundExMode
string
When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
__stringMin32Max32Pattern09aFAF32
string
ContainerType
string
Container for this output. Some containers require a container settings object. If not specified, the default object will be created.
MsSmoothEncryptionSettings
object
If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.
1 property
H265UnregisteredSeiTimecode
string
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
__integerMin1Max1
integer
ConflictException
TooManyRequestsException
FontScript
string
Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLan…
ChannelMapping
object
Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel, in dB. Specify remix values to indicate how much o…
1 property
WebvttHlsSourceSettings
object
Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to id…
3 properties
AudioSelectorGroup
object
Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output audio tab (AudioDescription). Note that, if y…
1 property
CmafMpdManifestBandwidthType
string
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwi…
MinBottomRenditionSize
object
Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. The lowest resolution in your ABR stack will be equal to o…
2 properties
DvbSubtitlingType
string
Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Cho…
MxfAfdSignaling
string
Optional. When you have AFD signaling set up in your output video stream, use this setting to choose whether to also include it in the MXF wrapper. Choose Don'…
MovCslgAtom
string
When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a…
H265AdaptiveQuantization
string
When you set Adaptive Quantization (H265AdaptiveQuantization) to Auto (AUTO), or leave blank, MediaConvert automatically applies quantization to improve the vi…
AllowedRenditionSize
object
Use Allowed renditions to specify a list of possible resolutions in your ABR stack. MediaConvert will create an ABR stack exclusively from the list of resoluti…
3 properties
Output
object
Each output in your job is a collection of settings that describes how you want MediaConvert to encode a single output file or stream. For more information, se…
8 properties
__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12
string
__doubleMinNegative59Max0
number
CmfcManifestMetadataSignaling
string
To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messa…
HlsSegmentControl
string
When set to SINGLEFILE, emits program as a single media resource (.ts) file, uses EXT-X-BYTERANGE tags to index segment for playback.
XavcHdProfileTelecine
string
Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (H…
CmfcAudioDuration
string
Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between v…
ListJobsResponse
object
2 properties
H264Settings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value H264.
42 properties
__integerMin25Max2000
integer
DashIsoImageBasedTrickPlay
string
Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to…
Mpeg2InterlaceMode
string
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your…
__stringMin3Max3Pattern1809aFAF09aEAE
string
__integerMinNegative70Max0
integer
Mp2Settings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value MP2.
3 properties
DashIsoGroupSettings
object
Settings related to your DASH output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work…
21 properties
EmbeddedTimecodeOverride
string
Set Embedded timecode override (embeddedTimecodeOverride) to Use MDPM (USEMDPM) when your AVCHD input contains timecode tag data in the Modified Digital Video…
__listOfAutomatedAbrRule
array
__stringPatternS3
string
WavFormat
string
The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support o…
CmafEncryptionSettings
object
Settings for CMAF encryption
6 properties
M3u8PcrControl
string
When set to PCREVERYPESPACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only…
__doubleMinNegative20Max0
number
MotionImageInsertionFramerate
object
For motion overlays that don't have a built-in frame rate, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 f…
2 properties
Mp3RateControlMode
string
Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate (VBR).
__mapOfAudioSelector
object
H265SampleAdaptiveOffsetFilterMode
string
Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content
InputPsiControl
string
Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. Ignore PSI - Scan all PIDs for audio and video.…
MxfXavcProfileSettings
object
Specify the XAVC profile settings for MXF outputs when you set your MXF profile to XAVC.
2 properties
NotFoundException
InputScanType
string
When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, f…
Eac3DynamicRangeCompressionLine
string
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operati…
CmafManifestDurationFormat
string
Indicates whether the output manifest should use floating point values for segment duration.
Eac3DynamicRangeCompressionRf
string
Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating…
DeinterlaceAlgorithm
string
Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produce…
MpdTimedMetadata
string
To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserte…
InputDeblockFilter
string
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video…
__integerMin1Max2147483647
integer
HlsTimedMetadataId3Frame
string
Specify the type of the ID3 frame (timedMetadataId3Frame) to use for ID3 timestamps (timedMetadataId3Period) in your output. To include ID3 timestamps: Specify…
VideoSelector
object
Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector.
10 properties
AlphaBehavior
string
Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create separate Key and Fill outputs. In each output,…
AudioDurationCorrection
string
Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements…
MpdManifestMetadataSignaling
string
To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messa…
CmfcScte35Esam
string
Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify…
NoiseFilterPostTemporalSharpeningStrength
string
Use Post temporal sharpening strength (postTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post tempo…
Hdr10Plus
object
Setting for HDR10+ metadata insertion
2 properties
AutomatedAbrSettings
object
Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on characteristics of your input video. This feat…
4 properties
OutputGroupSettings
object
Output Group settings, including type
6 properties
__integerMin8000Max96000
integer
InputDenoiseFilter
string
Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.
__listOfHlsAdditionalManifest
array
CmafIntervalCadence
string
The cadence MediaConvert follows for generating thumbnails. If set to FOLLOWIFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matchin…
__doubleMinNegative60MaxNegative1
number
__integerMin8Max12
integer
H265CodecLevel
string
H.265 Level.
TrackSourceSettings
object
Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMS…
1 property
AacRawFormat
string
Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for the output container.
CmafKeyProviderType
string
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aw…
VideoCodec
string
Type of video codec
RequiredFlag
string
Set to ENABLED to force a rendition to be included.
H265CodecProfile
string
Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so "Main/High" represents Main Profile with…
AiffSettings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value AIFF.
3 properties
NexGuardFileMarkerSettings
object
For forensic video watermarking, MediaConvert supports Nagra NexGuard File Marker watermarking. MediaConvert supports both PreRelease Content (NGPR/G2) and OTT…
4 properties
DashIsoWriteSegmentTimelineInRepresentation
string
When you enable Precise segment duration in manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment d…
XavcHdProfileQualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
AvcIntraUhdQualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how many transcoding passes MediaConvert does with your video. When you choose Multi-pass (MU…
SccDestinationSettings
object
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 t…
1 property
Mpeg2ParControl
string
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZEFROMSOURCE), uses the…
H264UnregisteredSeiTimecode
string
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.
S3ObjectCannedAcl
string
Choose an Amazon S3 canned ACL for MediaConvert to apply to this output.
__stringPatternDD
string
M3u8Settings
object
These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs.
19 properties
EsamSignalProcessingNotification
object
ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025.
1 property
H264TemporalAdaptiveQuantization
string
Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuan…
__stringMin11Max11Pattern01D20305D205D
string
RuleType
string
Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. The highest resolution in your ABR stack will be equal to or…
__integerMin1000Max1152000000
integer
Xavc4kIntraVbrProfileClass
string
Specify the XAVC Intra 4k (VBR) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that ar…
HlsCaptionSegmentLengthControl
string
Set Caption segment length control (CaptionSegmentLengthControl) to Match video (MATCHVIDEO) to create caption segments that align with the video segments from…
Eac3MetadataControl
string
When set to FOLLOWINPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one…
H264FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
HlsOfflineEncrypted
string
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.
AudioNormalizationPeakCalculation
string
If set to TRUEPEAK, calculate and log the TruePeak for each output's audio track loudness.
Eac3AttenuationControl
string
If set to ATTENUATE3DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
AacCodecProfile
string
AAC Profile.
CmfcDescriptiveVideoServiceFlag
string
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the…
__integerMin0Max100
integer
HlsEncryptionSettings
object
Settings for HLS encryption
7 properties
__integerMin25Max10000
integer
__stringMin1Max100000
string
CmfcSettings
object
These settings relate to the fragmented MP4 container for the segments in your CMAF outputs.
14 properties
DestinationSettings
object
Settings associated with the destination. Will vary based on the type of destination
1 property
CmafTargetDurationCompatibilityMode
string
When set to LEGACY, the segment target duration is always rounded up to the nearest integer value above its current value in seconds. When set to SPEC\\COMPLIA…
OutputSdt
string
Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from input stream to output stream. "Follow input SDT…
NielsenUniqueTicPerAudioTrackType
string
To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAMETICSPERTRACK). To create assets that have unique TIC…
AudioTypeControl
string
When set to FOLLOWINPUT, if the input contains an ISO 639 audiotype, then that value is passed through to the output. If the input contains no ISO 639 audiotyp…
PadVideo
string
Use this setting if your input has video and audio durations that don't align, and your output or player has strict alignment requirements. Examples: Input aud…
HlsSettings
object
Settings for HLS output groups
7 properties
ExtendedDataServices
object
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.…
2 properties
__integerMin100000Max100000000
integer
__integerMin1Max64
integer
Eac3AtmosDynamicRangeCompressionRf
string
Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default v…
NoiseReducer
object
Enable the Noise reducer feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting…
4 properties
OutputDetail
object
Details regarding output
2 properties
__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12
array
MsSmoothAudioDeduplication
string
COMBINEDUPLICATESTREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a single audio stream.
HlsCaptionLanguageSetting
string
Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code fie…
__integerMin64000Max640000
integer
BillingTagsSource
string
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.
__stringMin14PatternS3BmpBMPPngPNGTgaTGAHttpsBmpBMPPngPNGTgaTGA
string
M2tsSegmentationStyle
string
The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be tru…
BurninSubtitleOutlineColor
string
Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data…
AudioChannelTag
string
You can add a tag for this mono-channel audio track to mimic its placement in a multi-channel layout. For example, if this track is the left surround channel,…
__integerMin0Max4
integer
M3u8DataPtsControl
string
If you select ALIGNTOVIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video pac…
__mapOfCaptionSelector
object
ImscAccessibilitySubs
string
Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. Wh…
FileSourceConvert608To708
string
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the c…
__listOfOutput
array
Eac3CodingMode
string
Dolby Digital Plus coding mode. Determines number of channels.
H265GopBReference
string
If enable, use reference B frames for GOP structures that have B frames 1.
AacAudioDescriptionBroadcasterMix
string
Choose BROADCASTERMIXEDAD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, whi…
JobSettings
object
JobSettings contains all the transcode settings for a job.
12 properties
__listOf__integerMin1Max2147483647
array
__integerMin32000Max384000
integer
__stringMin1Max50
string
Mpeg2IntraDcPrecision
string
Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will au…
WebvttDestinationSettings
object
Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar caption…
2 properties
CmafInitializationVectorInManifest
string
When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.
KantarWatermarkSettings
object
Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audi…
13 properties
InputVideoGenerator
object
When you include Video generator, MediaConvert creates a video input with black frames. Use this setting if you do not have a video input or if you want to add…
1 property
CaptionSourceType
string
Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.
Vc3FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
NielsenActiveWatermarkProcessType
string
Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2ANDNW), you must provide a value for the setting SID (…
__listOfHlsCaptionLanguageMapping
array
Xavc4kIntraCbgProfileClass
string
Specify the XAVC Intra 4k (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that ar…
CmfcKlvMetadata
string
To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and write…
Xavc4kProfileSettings
object
Required when you set (Profile) under (VideoDescription)(CodecSettings)(XavcSettings) to the value XAVC4K.
8 properties
HlsDescriptiveVideoServiceFlag
string
Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the…
DashIsoIntervalCadence
string
The cadence MediaConvert follows for generating thumbnails. If set to FOLLOWIFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matchin…
H264FieldEncoding
string
The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force…
__listOfWarningGroup
array
__listOfInsertableImage
array
__doubleMin0Max2147483647
number
__integerMin1Max32
integer
Eac3DcFilter
string
Activates a DC highpass filter for all input channels.
XavcProfile
string
Specify the XAVC profile for this output. For more information, see the Sony documentation at https://www.xavc-info.org/. Note that MediaConvert doesn't suppor…
__integerMin24Max60000
integer
__integerMin0Max8
integer
H265SlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL,…
DecryptionMode
string
Specify the encryption mode that you used to encrypt your input files.
AudioNormalizationSettings
object
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
7 properties
H264ScanTypeConversionMode
string
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLA…
H264FlickerAdaptiveQuantization
string
Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuan…
__stringMin14PatternS3Mov09PngHttpsMov09Png
string
AudioLanguageCodeControl
string
Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOWINPUT), the service uses the language code fr…
DashIsoSegmentLengthControl
string
Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the sett…
DashIsoSegmentControl
string
When set to SINGLEFILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTEDFIL…
MinTopRenditionSize
object
Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. The highest resolution in your ABR stack will be equal to or…
2 properties
H264SceneChangeDetect
string
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this…
ProresChromaSampling
string
This setting applies only to ProRes 4444 and ProRes 4444 XQ outputs that you create from inputs that use 4:4:4 chroma sampling. Set Preserve 4:4:4 sampling (PR…
__stringMin3Max3PatternAZaZ3
string
VorbisSettings
object
Required when you set Codec, under AudioDescriptionsCodecSettings, to the value Vorbis.
3 properties
H264Syntax
string
Produces a bitstream compliant with SMPTE RP-2027.
Mp4FreeSpaceBox
string
Inserts a free-space box immediately after the moov box.
__stringPatternAZaZ0932
string
Eac3LfeFilter
string
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 32LFE coding mode.
__integerMin1Max31
integer
__integerMin1Max2
integer
Ac3Settings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value AC3.
10 properties
AudioSelector
object
Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors…
12 properties
H265QvbrSettings
object
Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode).
3 properties
ColorMetadata
string
Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don…
DvbddsHandling
string
Specify how MediaConvert handles the display definition segment (DDS). To exclude the DDS from this set of captions: Keep the default, None. To include the DDS…
AvcIntraClass
string
Specify the AVC-Intra class of your output. The AVC-Intra class selection determines the output video bit rate depending on the frame rate of the output. Outpu…
MxfXavcDurationMode
string
To create an output that complies with the XAVC file format guidelines for interoperability, keep the default value, Drop frames for compliance (DROPFRAMESFORC…
H264AdaptiveQuantization
string
Keep the default value, Auto (AUTO), for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you…
DvbSdtSettings
object
Use these settings to insert a DVB Service Description Table (SDT) in the transport stream of this output. When you work directly in your JSON job specificatio…
4 properties
H264InterlaceMode
string
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your…
__stringPatternS3ASSETMAPXml
string
Eac3PassthroughControl
string
When set to WHENPOSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Input…
NoiseReducerSpatialFilterSettings
object
Noise reducer filter settings for spatial filter.
3 properties
CmafCodecSpecification
string
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
DashIsoPlaybackDeviceCompatibility
string
This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Ch…
__integerMin1Max2048
integer
MpdSettings
object
These settings relate to the fragmented MP4 container for the segments in your DASH outputs.
11 properties
Av1FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
HlsSegmentLengthControl
string
Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the sett…
ImageInserter
object
Use the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. For more infor…
2 properties
Av1SpatialAdaptiveQuantization
string
Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feat…
__integerMin0Max5
integer
WatermarkingStrength
string
Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its def…
M2tsAudioBufferModel
string
Selects between the DVB and ATSC buffer models for Dolby Digital audio.
NoiseReducerFilter
string
Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise…
__stringMin0
string
H265Tiles
string
Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.
__integerMin0Max3
integer
Input
object
Use inputs to define the source files used in your transcoding job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/specify-input-…
22 properties
__integerMin0Max65535
integer
CmafGroupSettings
object
Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work…
27 properties
Eac3StereoDownmix
string
Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODINGMODE32) for the setting…
ProresParControl
string
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZEFROMSOURCE), uses the…
MsSmoothManifestEncoding
string
Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.
WarningGroup
object
Contains any warning codes and their count for the job.
2 properties 2 required
__integerMin920Max1023
integer
M2tsNielsenId3
string
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.
H265QualityTuningLevel
string
Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is fa…
__integerMin1000Max300000000
integer
__mapOf__string
object
MovMpeg2FourCCControl
string
When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, bu…
DolbyVisionProfile
string
Required when you enable Dolby Vision. Use Profile 5 to include frame-interleaved Dolby Vision metadata in your output. Your input must include Dolby Vision me…
CmafSegmentLengthControl
string
Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the sett…
BandwidthReductionFilterStrength
string
Specify the strength of the Bandwidth reduction filter. For most workflows, we recommend that you choose Auto to reduce the bandwidth of your output with littl…
H264RepeatPps
string
Places a PPS header on each encoded picture, even if repeated.
__stringMin24Max512PatternAZaZ0902
string
__listOfDashAdditionalManifest
array
Vp8FramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
__listOfOutputGroup
array
InputRotate
string
Use Rotate (InputRotate) to specify how the service rotates your video. You can choose automatic rotation or specify a rotation. You can specify a clockwise ro…
JobMessages
object
Provides messages from the service about jobs that you have already successfully submitted.
2 properties
Av1AdaptiveQuantization
string
Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization (spatialAdap…
__integerMin32Max8192
integer
__integerMin32000Max192000
integer
DvbSubtitleAlignment
string
Specify the alignment of your captions. If no explicit xposition is provided, setting alignment to centered will placethe captions at the bottom center of the…
Eac3AtmosSurroundExMode
string
Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.
OutputChannelMapping
object
OutputChannel mapping settings.
2 properties
FrameCaptureSettings
object
Required when you set (Codec) under (VideoDescription)(CodecSettings) to the value FRAMECAPTURE.
4 properties
Vc3SlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video fra…
Xavc4kIntraCbgProfileSettings
object
Required when you set (Profile) under (VideoDescription)(CodecSettings)(XavcSettings) to the value XAVC4KINTRACBG.
1 property
CaptionSourceSettings
object
If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC…
8 properties
Ac3DynamicRangeCompressionProfile
string
When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dyn…
Vc3Telecine
string
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard tel…
EmbeddedDestinationSettings
object
Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For mo…
2 properties
__stringPattern01D20305D205D
string
AvcIntraFramerateConversionAlgorithm
string
Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATEDROP) for numeric…
MpdAccessibilityCaptionHints
string
Optional. Choose Include (INCLUDE) to have MediaConvert mark up your DASH manifest with elements for embedded 608 captions. This markup isn't generally require…
Eac3SurroundMode
string
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
ForceIncludeRenditionSize
object
Use Force include renditions to specify one or more resolutions to include your ABR stack. (Recommended) To optimize automated ABR, specify as few resolutions…
2 properties
SampleRangeConversion
string
Specify how MediaConvert limits the color sample range for this output. To create a limited range output from a full range input: Choose Limited range squeeze.…
CancelJobResponse
object
HDRToSDRToneMapper
string
Specify how MediaConvert maps brightness and colors from your HDR input to your SDR output. The mode that you select represents a creative choice, with differe…
H265SceneChangeDetect
string
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this…
NielsenConfiguration
object
Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (niels…
2 properties
__integerMin0Max30
integer
ProresSlowPal
string
Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL,…
__stringMax1000
string
OutputGroupDetail
object
Contains details about the output groups specified in the job settings.
1 property
AccelerationStatus
string
Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStat…
Mpeg2FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
__integerMinNegative50Max50
integer
__integerMin0Max9
integer
AncillarySourceSettings
object
Settings for ancillary captions source.
3 properties
H265SpatialAdaptiveQuantization
string
Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feat…
__listOfTeletextPageType
array
AncillaryConvert608To708
string
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the c…
PartnerWatermarking
object
If you work with a third party video watermarking partner, use the group of settings that correspond with your watermarking partner to include watermarks in yo…
1 property
ProresFramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
HlsImageBasedTrickPlaySettings
object
Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED
6 properties
__integerMin0Max4194303
integer
H265ScanTypeConversionMode
string
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLA…
__stringPatternArnAwsUsGovAcm
string
FileSourceTimeDeltaUnits
string
When you use the setting Time delta (TimeDelta) to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the…
__integerMin384000Max1024000
integer
HlsRenditionGroupSettings
object
Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to id…
3 properties
__listOf__stringPatternS3ASSETMAPXml
array
DashIsoMpdManifestBandwidthType
string
Specify how the value for bandwidth is determined for each video Representation in your output MPD manifest. We recommend that you choose a MPD manifest bandwi…
__stringPatternW
string
__integerMin2Max2147483647
integer
__integerMin8000Max192000
integer
MotionImagePlayback
string
Specify whether your motion graphic overlay repeats on a loop or plays only once.
CreateJobResponse
object
1 property
AacVbrQuality
string
VBR Quality Level - Only used if ratecontrolmode is VBR.
__timestampUnix
string
__integerMin16Max24
integer
__integerMin1Max17895697
integer
F4vMoovPlacement
string
If set to PROGRESSIVEDOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed norma…
Mpeg2Telecine
string
When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or…
MpdCaptionContainerType
string
Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar captions in a separate output from your audio and v…
AvcIntraSettings
object
Required when you choose AVC-Intra for your output video codec. For more information about the AVC-Intra settings, see the relevant specification. For detailed…
10 properties
__integerMinNegative180Max180
integer
Vc3ScanTypeConversionMode
string
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLA…
Ac3CodingMode
string
Dolby Digital coding mode. Determines number of channels.
XavcFlickerAdaptiveQuantization
string
The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When…
AvcIntraScanTypeConversionMode
string
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLA…
DvbSubtitleStylePassthrough
string
Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses def…
LanguageCode
string
Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/codelist.php.
SpekeKeyProviderCmaf
object
If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or…
5 properties
Vp9ParControl
string
Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZEFROMSOURCE), uses the…
__integerMin0Max16
integer
Hdr10Metadata
object
Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in th…
12 properties
__stringPattern
string
BurninSubtitleAlignment
string
Specify the alignment of your captions. If no explicit xposition is provided, setting alignment to centered will placethe captions at the bottom center of the…
WebvttAccessibilitySubs
string
Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. Wh…
XavcInterlaceMode
string
Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your…
HlsEncryptionType
string
Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.
CmafStreamInfResolution
string
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
Timing
object
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
3 properties
__stringPatternSNSignalProcessingNotificationNS
string
FileGroupSettings
object
Settings related to your File output group. MediaConvert uses this group of settings to generate a single standalone file, rather than a streaming package. Whe…
2 properties
Mp4MoovPlacement
string
If set to PROGRESSIVEDOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed norma…
AccelerationSettings
object
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
1 property 1 required
ProresScanTypeConversionMode
string
Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing (INTERLA…
__stringMin1Max20
string
VideoTimecodeInsertion
string
Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To inc…
WavSettings
object
Required when you set (Codec) under (AudioDescriptions)(CodecSettings) to the value WAV.
4 properties
__integer
integer
Vp9FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
H264GopBReference
string
If enable, use reference B frames for GOP structures that have B frames 1.
StatusUpdateInterval
string
Specify how often MediaConvert sends STATUSUPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends…
AfdSignaling
string
This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the…
NielsenNonLinearWatermarkSettings
object
Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks…
11 properties
__listOfMsSmoothAdditionalManifest
array
CaptionDestinationType
string
Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container con…
H264CodecLevel
string
Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).
VideoCodecSettings
object
Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depen…
12 properties
NoiseFilterPostTemporalSharpening
string
When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the bandwidth and sharpness of your output is reduced. You can optionally use Post temporal s…
DashAdditionalManifest
object
Specify the details for each additional DASH manifest that you want the service to generate for this output group. Each manifest can reference a different subs…
2 properties
__integerMin0Max50000
integer
SimulateReservedQueue
string
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 fr…
Ac3LfeFilter
string
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 32LFE coding mode.
MpdKlvMetadata
string
To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and write…
__integerMin32000Max3024000
integer
__integerMin0Max255
integer
__listOfHopDestination
array
__integerMin2Max4096
integer
XavcFramerateControl
string
If you are using the console, use the Frame rate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
CaptionDestinationSettings
object
Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions t…
10 properties
H264EntropyEncoding
string
Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.
H265FramerateControl
string
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video,…
__listOfAudioDescription
array
Deinterlacer
object
Settings for deinterlacer
3 properties
EsamManifestConfirmConditionNotification
object
ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025.
1 property
__listOf__integerMinNegative60Max6
array
Mp4CslgAtom
string
When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a…
__integerMin3Max15
integer
Mpeg2AdaptiveQuantization
string
Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive q…
Id3Insertion
object
To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time…
2 properties
__integerMin16000Max320000
integer
Mp3Settings
object
Required when you set Codec, under AudioDescriptionsCodecSettings, to the value MP3.
5 properties
DvbSubtitleShadowColor
string
Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the…
__integerMin0Max15
integer
HlsClientCache
string
Disable this setting only when your workflow requires the EXT-X-ALLOW-CACHE:no tag. Otherwise, keep the default value Enabled (ENABLED) and control caching in…
MsSmoothGroupSettings
object
Settings related to your Microsoft Smooth Streaming output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-A…
8 properties
Mpeg2CodecProfile
string
Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.
__integerMin0Max10000
integer
TtmlDestinationSettings
object
Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in…
1 property
OutputGroup
object
Group of outputs
5 properties
__stringPatternAZaZ23AZaZ
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-mediaconvert-jobs-api-openapi.yml Raw ↑

Other APIs Amazon MediaConvert publishes across the network.

Amazon MediaConvert Certificates API
Amazon MediaConvert Endpoints API
Amazon MediaConvert JobTemplates API
Amazon MediaConvert Policy API
Amazon MediaConvert Presets API
Amazon MediaConvert Queues API
Amazon MediaConvert Tags API
Where this information came from

This is an independent, third-party profile of Amazon MediaConvert Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.