aws-sdk
Version:
AWS SDK for JavaScript
843 lines • 166 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class MediaConvert extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: MediaConvert.Types.ClientConfiguration)
config: Config & MediaConvert.Types.ClientConfiguration;
/**
* Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert.
*/
associateCertificate(params: MediaConvert.Types.AssociateCertificateRequest, callback?: (err: AWSError, data: MediaConvert.Types.AssociateCertificateResponse) => void): Request<MediaConvert.Types.AssociateCertificateResponse, AWSError>;
/**
* Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert.
*/
associateCertificate(callback?: (err: AWSError, data: MediaConvert.Types.AssociateCertificateResponse) => void): Request<MediaConvert.Types.AssociateCertificateResponse, AWSError>;
/**
* Permanently remove a job from a queue. Once you have canceled a job, you can't start it again. You can't delete a running job.
*/
cancelJob(params: MediaConvert.Types.CancelJobRequest, callback?: (err: AWSError, data: MediaConvert.Types.CancelJobResponse) => void): Request<MediaConvert.Types.CancelJobResponse, AWSError>;
/**
* Permanently remove a job from a queue. Once you have canceled a job, you can't start it again. You can't delete a running job.
*/
cancelJob(callback?: (err: AWSError, data: MediaConvert.Types.CancelJobResponse) => void): Request<MediaConvert.Types.CancelJobResponse, AWSError>;
/**
* Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
*/
createJob(params: MediaConvert.Types.CreateJobRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreateJobResponse) => void): Request<MediaConvert.Types.CreateJobResponse, AWSError>;
/**
* Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
*/
createJob(callback?: (err: AWSError, data: MediaConvert.Types.CreateJobResponse) => void): Request<MediaConvert.Types.CreateJobResponse, AWSError>;
/**
* Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
*/
createJobTemplate(params: MediaConvert.Types.CreateJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreateJobTemplateResponse) => void): Request<MediaConvert.Types.CreateJobTemplateResponse, AWSError>;
/**
* Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
*/
createJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.CreateJobTemplateResponse) => void): Request<MediaConvert.Types.CreateJobTemplateResponse, AWSError>;
/**
* Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
*/
createPreset(params: MediaConvert.Types.CreatePresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreatePresetResponse) => void): Request<MediaConvert.Types.CreatePresetResponse, AWSError>;
/**
* Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
*/
createPreset(callback?: (err: AWSError, data: MediaConvert.Types.CreatePresetResponse) => void): Request<MediaConvert.Types.CreatePresetResponse, AWSError>;
/**
* Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html
*/
createQueue(params: MediaConvert.Types.CreateQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.CreateQueueResponse) => void): Request<MediaConvert.Types.CreateQueueResponse, AWSError>;
/**
* Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html
*/
createQueue(callback?: (err: AWSError, data: MediaConvert.Types.CreateQueueResponse) => void): Request<MediaConvert.Types.CreateQueueResponse, AWSError>;
/**
* Permanently delete a job template you have created.
*/
deleteJobTemplate(params: MediaConvert.Types.DeleteJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.DeleteJobTemplateResponse) => void): Request<MediaConvert.Types.DeleteJobTemplateResponse, AWSError>;
/**
* Permanently delete a job template you have created.
*/
deleteJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.DeleteJobTemplateResponse) => void): Request<MediaConvert.Types.DeleteJobTemplateResponse, AWSError>;
/**
* Permanently delete a preset you have created.
*/
deletePreset(params: MediaConvert.Types.DeletePresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.DeletePresetResponse) => void): Request<MediaConvert.Types.DeletePresetResponse, AWSError>;
/**
* Permanently delete a preset you have created.
*/
deletePreset(callback?: (err: AWSError, data: MediaConvert.Types.DeletePresetResponse) => void): Request<MediaConvert.Types.DeletePresetResponse, AWSError>;
/**
* Permanently delete a queue you have created.
*/
deleteQueue(params: MediaConvert.Types.DeleteQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.DeleteQueueResponse) => void): Request<MediaConvert.Types.DeleteQueueResponse, AWSError>;
/**
* Permanently delete a queue you have created.
*/
deleteQueue(callback?: (err: AWSError, data: MediaConvert.Types.DeleteQueueResponse) => void): Request<MediaConvert.Types.DeleteQueueResponse, AWSError>;
/**
* Send an request with an empty body to the regional API endpoint to get your account API endpoint.
*/
describeEndpoints(params: MediaConvert.Types.DescribeEndpointsRequest, callback?: (err: AWSError, data: MediaConvert.Types.DescribeEndpointsResponse) => void): Request<MediaConvert.Types.DescribeEndpointsResponse, AWSError>;
/**
* Send an request with an empty body to the regional API endpoint to get your account API endpoint.
*/
describeEndpoints(callback?: (err: AWSError, data: MediaConvert.Types.DescribeEndpointsResponse) => void): Request<MediaConvert.Types.DescribeEndpointsResponse, AWSError>;
/**
* Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource.
*/
disassociateCertificate(params: MediaConvert.Types.DisassociateCertificateRequest, callback?: (err: AWSError, data: MediaConvert.Types.DisassociateCertificateResponse) => void): Request<MediaConvert.Types.DisassociateCertificateResponse, AWSError>;
/**
* Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource.
*/
disassociateCertificate(callback?: (err: AWSError, data: MediaConvert.Types.DisassociateCertificateResponse) => void): Request<MediaConvert.Types.DisassociateCertificateResponse, AWSError>;
/**
* Retrieve the JSON for a specific completed transcoding job.
*/
getJob(params: MediaConvert.Types.GetJobRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetJobResponse) => void): Request<MediaConvert.Types.GetJobResponse, AWSError>;
/**
* Retrieve the JSON for a specific completed transcoding job.
*/
getJob(callback?: (err: AWSError, data: MediaConvert.Types.GetJobResponse) => void): Request<MediaConvert.Types.GetJobResponse, AWSError>;
/**
* Retrieve the JSON for a specific job template.
*/
getJobTemplate(params: MediaConvert.Types.GetJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetJobTemplateResponse) => void): Request<MediaConvert.Types.GetJobTemplateResponse, AWSError>;
/**
* Retrieve the JSON for a specific job template.
*/
getJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.GetJobTemplateResponse) => void): Request<MediaConvert.Types.GetJobTemplateResponse, AWSError>;
/**
* Retrieve the JSON for a specific preset.
*/
getPreset(params: MediaConvert.Types.GetPresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetPresetResponse) => void): Request<MediaConvert.Types.GetPresetResponse, AWSError>;
/**
* Retrieve the JSON for a specific preset.
*/
getPreset(callback?: (err: AWSError, data: MediaConvert.Types.GetPresetResponse) => void): Request<MediaConvert.Types.GetPresetResponse, AWSError>;
/**
* Retrieve the JSON for a specific queue.
*/
getQueue(params: MediaConvert.Types.GetQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.GetQueueResponse) => void): Request<MediaConvert.Types.GetQueueResponse, AWSError>;
/**
* Retrieve the JSON for a specific queue.
*/
getQueue(callback?: (err: AWSError, data: MediaConvert.Types.GetQueueResponse) => void): Request<MediaConvert.Types.GetQueueResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array
*/
listJobTemplates(params: MediaConvert.Types.ListJobTemplatesRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListJobTemplatesResponse) => void): Request<MediaConvert.Types.ListJobTemplatesResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array
*/
listJobTemplates(callback?: (err: AWSError, data: MediaConvert.Types.ListJobTemplatesResponse) => void): Request<MediaConvert.Types.ListJobTemplatesResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.
*/
listJobs(params: MediaConvert.Types.ListJobsRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListJobsResponse) => void): Request<MediaConvert.Types.ListJobsResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.
*/
listJobs(callback?: (err: AWSError, data: MediaConvert.Types.ListJobsResponse) => void): Request<MediaConvert.Types.ListJobsResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.
*/
listPresets(params: MediaConvert.Types.ListPresetsRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListPresetsResponse) => void): Request<MediaConvert.Types.ListPresetsResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.
*/
listPresets(callback?: (err: AWSError, data: MediaConvert.Types.ListPresetsResponse) => void): Request<MediaConvert.Types.ListPresetsResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.
*/
listQueues(params: MediaConvert.Types.ListQueuesRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListQueuesResponse) => void): Request<MediaConvert.Types.ListQueuesResponse, AWSError>;
/**
* Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.
*/
listQueues(callback?: (err: AWSError, data: MediaConvert.Types.ListQueuesResponse) => void): Request<MediaConvert.Types.ListQueuesResponse, AWSError>;
/**
* Retrieve the tags for a MediaConvert resource.
*/
listTagsForResource(params: MediaConvert.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaConvert.Types.ListTagsForResourceResponse) => void): Request<MediaConvert.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieve the tags for a MediaConvert resource.
*/
listTagsForResource(callback?: (err: AWSError, data: MediaConvert.Types.ListTagsForResourceResponse) => void): Request<MediaConvert.Types.ListTagsForResourceResponse, AWSError>;
/**
* Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html
*/
tagResource(params: MediaConvert.Types.TagResourceRequest, callback?: (err: AWSError, data: MediaConvert.Types.TagResourceResponse) => void): Request<MediaConvert.Types.TagResourceResponse, AWSError>;
/**
* Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html
*/
tagResource(callback?: (err: AWSError, data: MediaConvert.Types.TagResourceResponse) => void): Request<MediaConvert.Types.TagResourceResponse, AWSError>;
/**
* Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html
*/
untagResource(params: MediaConvert.Types.UntagResourceRequest, callback?: (err: AWSError, data: MediaConvert.Types.UntagResourceResponse) => void): Request<MediaConvert.Types.UntagResourceResponse, AWSError>;
/**
* Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html
*/
untagResource(callback?: (err: AWSError, data: MediaConvert.Types.UntagResourceResponse) => void): Request<MediaConvert.Types.UntagResourceResponse, AWSError>;
/**
* Modify one of your existing job templates.
*/
updateJobTemplate(params: MediaConvert.Types.UpdateJobTemplateRequest, callback?: (err: AWSError, data: MediaConvert.Types.UpdateJobTemplateResponse) => void): Request<MediaConvert.Types.UpdateJobTemplateResponse, AWSError>;
/**
* Modify one of your existing job templates.
*/
updateJobTemplate(callback?: (err: AWSError, data: MediaConvert.Types.UpdateJobTemplateResponse) => void): Request<MediaConvert.Types.UpdateJobTemplateResponse, AWSError>;
/**
* Modify one of your existing presets.
*/
updatePreset(params: MediaConvert.Types.UpdatePresetRequest, callback?: (err: AWSError, data: MediaConvert.Types.UpdatePresetResponse) => void): Request<MediaConvert.Types.UpdatePresetResponse, AWSError>;
/**
* Modify one of your existing presets.
*/
updatePreset(callback?: (err: AWSError, data: MediaConvert.Types.UpdatePresetResponse) => void): Request<MediaConvert.Types.UpdatePresetResponse, AWSError>;
/**
* Modify one of your existing queues.
*/
updateQueue(params: MediaConvert.Types.UpdateQueueRequest, callback?: (err: AWSError, data: MediaConvert.Types.UpdateQueueResponse) => void): Request<MediaConvert.Types.UpdateQueueResponse, AWSError>;
/**
* Modify one of your existing queues.
*/
updateQueue(callback?: (err: AWSError, data: MediaConvert.Types.UpdateQueueResponse) => void): Request<MediaConvert.Types.UpdateQueueResponse, AWSError>;
}
declare namespace MediaConvert {
export type AacAudioDescriptionBroadcasterMix = "BROADCASTER_MIXED_AD"|"NORMAL"|string;
export type AacCodecProfile = "LC"|"HEV1"|"HEV2"|string;
export type AacCodingMode = "AD_RECEIVER_MIX"|"CODING_MODE_1_0"|"CODING_MODE_1_1"|"CODING_MODE_2_0"|"CODING_MODE_5_1"|string;
export type AacRateControlMode = "CBR"|"VBR"|string;
export type AacRawFormat = "LATM_LOAS"|"NONE"|string;
export interface AacSettings {
AudioDescriptionBroadcasterMix?: AacAudioDescriptionBroadcasterMix;
/**
* Average bitrate in bits/second. Defaults and valid values depend on rate control mode and profile.
*/
Bitrate?: __integerMin6000Max1024000;
CodecProfile?: AacCodecProfile;
CodingMode?: AacCodingMode;
RateControlMode?: AacRateControlMode;
RawFormat?: AacRawFormat;
/**
* Sample rate in Hz. Valid values depend on rate control mode and profile.
*/
SampleRate?: __integerMin8000Max96000;
Specification?: AacSpecification;
VbrQuality?: AacVbrQuality;
}
export type AacSpecification = "MPEG2"|"MPEG4"|string;
export type AacVbrQuality = "LOW"|"MEDIUM_LOW"|"MEDIUM_HIGH"|"HIGH"|string;
export type Ac3BitstreamMode = "COMPLETE_MAIN"|"COMMENTARY"|"DIALOGUE"|"EMERGENCY"|"HEARING_IMPAIRED"|"MUSIC_AND_EFFECTS"|"VISUALLY_IMPAIRED"|"VOICE_OVER"|string;
export type Ac3CodingMode = "CODING_MODE_1_0"|"CODING_MODE_1_1"|"CODING_MODE_2_0"|"CODING_MODE_3_2_LFE"|string;
export type Ac3DynamicRangeCompressionProfile = "FILM_STANDARD"|"NONE"|string;
export type Ac3LfeFilter = "ENABLED"|"DISABLED"|string;
export type Ac3MetadataControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string;
export interface Ac3Settings {
/**
* Average bitrate in bits/second. Valid bitrates depend on the coding mode.
*/
Bitrate?: __integerMin64000Max640000;
BitstreamMode?: Ac3BitstreamMode;
CodingMode?: Ac3CodingMode;
/**
* Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through.
*/
Dialnorm?: __integerMin1Max31;
DynamicRangeCompressionProfile?: Ac3DynamicRangeCompressionProfile;
LfeFilter?: Ac3LfeFilter;
MetadataControl?: Ac3MetadataControl;
/**
* Sample rate in hz. Sample rate is always 48000.
*/
SampleRate?: __integerMin48000Max48000;
}
export type AfdSignaling = "NONE"|"AUTO"|"FIXED"|string;
export interface AiffSettings {
/**
* Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.
*/
BitDepth?: __integerMin16Max24;
/**
* Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2.
*/
Channels?: __integerMin1Max2;
/**
* Sample rate in hz.
*/
SampleRate?: __integerMin8000Max192000;
}
export interface AncillarySourceSettings {
/**
* Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough.
*/
SourceAncillaryChannelNumber?: __integerMin1Max4;
}
export type AntiAlias = "DISABLED"|"ENABLED"|string;
export interface AssociateCertificateRequest {
/**
* The ARN of the ACM certificate that you want to associate with your MediaConvert resource.
*/
Arn: __string;
}
export interface AssociateCertificateResponse {
}
export type AudioCodec = "AAC"|"MP2"|"WAV"|"AIFF"|"AC3"|"EAC3"|"PASSTHROUGH"|string;
export interface AudioCodecSettings {
AacSettings?: AacSettings;
Ac3Settings?: Ac3Settings;
AiffSettings?: AiffSettings;
Codec?: AudioCodec;
Eac3Settings?: Eac3Settings;
Mp2Settings?: Mp2Settings;
WavSettings?: WavSettings;
}
export type AudioDefaultSelection = "DEFAULT"|"NOT_DEFAULT"|string;
export interface AudioDescription {
AudioNormalizationSettings?: AudioNormalizationSettings;
/**
* Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.
*/
AudioSourceName?: __string;
/**
* Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.
*/
AudioType?: __integerMin0Max255;
AudioTypeControl?: AudioTypeControl;
CodecSettings?: AudioCodecSettings;
/**
* Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.
*/
CustomLanguageCode?: __stringMin3Max3PatternAZaZ3;
/**
* Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.
*/
LanguageCode?: LanguageCode;
LanguageCodeControl?: AudioLanguageCodeControl;
/**
* Advanced audio remixing settings.
*/
RemixSettings?: RemixSettings;
/**
* Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal.
*/
StreamName?: __stringPatternWS;
}
export type AudioLanguageCodeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string;
export type AudioNormalizationAlgorithm = "ITU_BS_1770_1"|"ITU_BS_1770_2"|string;
export type AudioNormalizationAlgorithmControl = "CORRECT_AUDIO"|"MEASURE_ONLY"|string;
export type AudioNormalizationLoudnessLogging = "LOG"|"DONT_LOG"|string;
export type AudioNormalizationPeakCalculation = "TRUE_PEAK"|"NONE"|string;
export interface AudioNormalizationSettings {
Algorithm?: AudioNormalizationAlgorithm;
AlgorithmControl?: AudioNormalizationAlgorithmControl;
/**
* Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction.
*/
CorrectionGateLevel?: __integerMinNegative70Max0;
LoudnessLogging?: AudioNormalizationLoudnessLogging;
PeakCalculation?: AudioNormalizationPeakCalculation;
/**
* Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
*/
TargetLkfs?: __doubleMinNegative59Max0;
}
export interface AudioSelector {
/**
* Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code
*/
CustomLanguageCode?: __stringMin3Max3PatternAZaZ3;
DefaultSelection?: AudioDefaultSelection;
/**
* Specifies audio data from an external file source.
*/
ExternalAudioFileInput?: __stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE;
/**
* Selects a specific language code from within an audio source.
*/
LanguageCode?: LanguageCode;
/**
* Specifies a time delta in milliseconds to offset the audio from the input video.
*/
Offset?: __integerMinNegative2147483648Max2147483647;
/**
* Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101).
*/
Pids?: __listOf__integerMin1Max2147483647;
/**
* Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.
*/
ProgramSelection?: __integerMin0Max8;
/**
* Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other.
*/
RemixSettings?: RemixSettings;
SelectorType?: AudioSelectorType;
/**
* Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, "tracks": [1,2,3].
*/
Tracks?: __listOf__integerMin1Max2147483647;
}
export interface AudioSelectorGroup {
/**
* Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., "Audio Selector 1"). The audio selector name parameter can be repeated to add any number of audio selectors to the group.
*/
AudioSelectorNames?: __listOf__stringMin1;
}
export type AudioSelectorType = "PID"|"TRACK"|"LANGUAGE_CODE"|string;
export type AudioTypeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string;
export interface AvailBlanking {
/**
* Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
*/
AvailBlankingImage?: __stringMin14PatternS3BmpBMPPngPNG;
}
export type BillingTagsSource = "QUEUE"|"PRESET"|"JOB_TEMPLATE"|string;
export interface BurninDestinationSettings {
Alignment?: BurninSubtitleAlignment;
BackgroundColor?: BurninSubtitleBackgroundColor;
/**
* Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
*/
BackgroundOpacity?: __integerMin0Max255;
FontColor?: BurninSubtitleFontColor;
/**
* Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.
All burn-in and DVB-Sub font settings must match.
*/
FontOpacity?: __integerMin0Max255;
/**
* Font resolution in DPI (dots per inch); default is 96 dpi.
All burn-in and DVB-Sub font settings must match.
*/
FontResolution?: __integerMin96Max600;
/**
* A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.
*/
FontSize?: __integerMin0Max96;
OutlineColor?: BurninSubtitleOutlineColor;
/**
* Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
*/
OutlineSize?: __integerMin0Max10;
ShadowColor?: BurninSubtitleShadowColor;
/**
* Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
*/
ShadowOpacity?: __integerMin0Max255;
/**
* Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
*/
ShadowXOffset?: __integerMinNegative2147483648Max2147483647;
/**
* Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
*/
ShadowYOffset?: __integerMinNegative2147483648Max2147483647;
TeletextSpacing?: BurninSubtitleTeletextSpacing;
/**
* Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
*/
XPosition?: __integerMin0Max2147483647;
/**
* Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
*/
YPosition?: __integerMin0Max2147483647;
}
export type BurninSubtitleAlignment = "CENTERED"|"LEFT"|string;
export type BurninSubtitleBackgroundColor = "NONE"|"BLACK"|"WHITE"|string;
export type BurninSubtitleFontColor = "WHITE"|"BLACK"|"YELLOW"|"RED"|"GREEN"|"BLUE"|string;
export type BurninSubtitleOutlineColor = "BLACK"|"WHITE"|"YELLOW"|"RED"|"GREEN"|"BLUE"|string;
export type BurninSubtitleShadowColor = "NONE"|"BLACK"|"WHITE"|string;
export type BurninSubtitleTeletextSpacing = "FIXED_GRID"|"PROPORTIONAL"|string;
export interface CancelJobRequest {
/**
* The Job ID of the job to be cancelled.
*/
Id: __string;
}
export interface CancelJobResponse {
}
export interface CaptionDescription {
/**
* Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.
*/
CaptionSelectorName?: __stringMin1;
/**
* Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code
*/
CustomLanguageCode?: __stringMin3Max3PatternAZaZ3;
DestinationSettings?: CaptionDestinationSettings;
/**
* Indicates the language of the caption output track.
*/
LanguageCode?: LanguageCode;
/**
* Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal.
*/
LanguageDescription?: __string;
}
export interface CaptionDescriptionPreset {
/**
* Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code
*/
CustomLanguageCode?: __stringMin3Max3PatternAZaZ3;
DestinationSettings?: CaptionDestinationSettings;
/**
* Indicates the language of the caption output track.
*/
LanguageCode?: LanguageCode;
/**
* Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal.
*/
LanguageDescription?: __string;
}
export interface CaptionDestinationSettings {
BurninDestinationSettings?: BurninDestinationSettings;
DestinationType?: CaptionDestinationType;
DvbSubDestinationSettings?: DvbSubDestinationSettings;
SccDestinationSettings?: SccDestinationSettings;
TeletextDestinationSettings?: TeletextDestinationSettings;
TtmlDestinationSettings?: TtmlDestinationSettings;
}
export type CaptionDestinationType = "BURN_IN"|"DVB_SUB"|"EMBEDDED"|"EMBEDDED_PLUS_SCTE20"|"SCTE20_PLUS_EMBEDDED"|"SCC"|"SRT"|"SMI"|"TELETEXT"|"TTML"|"WEBVTT"|string;
export interface CaptionSelector {
/**
* The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.
*/
CustomLanguageCode?: __stringMin3Max3PatternAZaZ3;
/**
* The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.
*/
LanguageCode?: LanguageCode;
SourceSettings?: CaptionSourceSettings;
}
export interface CaptionSourceSettings {
AncillarySourceSettings?: AncillarySourceSettings;
DvbSubSourceSettings?: DvbSubSourceSettings;
EmbeddedSourceSettings?: EmbeddedSourceSettings;
FileSourceSettings?: FileSourceSettings;
SourceType?: CaptionSourceType;
TeletextSourceSettings?: TeletextSourceSettings;
}
export type CaptionSourceType = "ANCILLARY"|"DVB_SUB"|"EMBEDDED"|"SCTE20"|"SCC"|"TTML"|"STL"|"SRT"|"SMI"|"TELETEXT"|"NULL_SOURCE"|string;
export interface ChannelMapping {
/**
* List of output channels
*/
OutputChannels?: __listOfOutputChannelMapping;
}
export type CmafClientCache = "DISABLED"|"ENABLED"|string;
export type CmafCodecSpecification = "RFC_6381"|"RFC_4281"|string;
export interface CmafEncryptionSettings {
/**
* This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.
*/
ConstantInitializationVector?: __stringMin32Max32Pattern09aFAF32;
EncryptionMethod?: CmafEncryptionType;
InitializationVectorInManifest?: CmafInitializationVectorInManifest;
StaticKeyProvider?: StaticKeyProvider;
Type?: CmafKeyProviderType;
}
export type CmafEncryptionType = "SAMPLE_AES"|string;
export interface CmafGroupSettings {
/**
* A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.
*/
BaseUrl?: __string;
ClientCache?: CmafClientCache;
CodecSpecification?: CmafCodecSpecification;
/**
* Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.
*/
Destination?: __stringPatternS3;
/**
* DRM settings.
*/
Encryption?: CmafEncryptionSettings;
/**
* Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.
*/
FragmentLength?: __integerMin1Max2147483647;
ManifestCompression?: CmafManifestCompression;
ManifestDurationFormat?: CmafManifestDurationFormat;
/**
* Minimum time of initially buffered media that is needed to ensure smooth playout.
*/
MinBufferTime?: __integerMin0Max2147483647;
/**
* Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.
*/
MinFinalSegmentLength?: __doubleMin0Max2147483647;
SegmentControl?: CmafSegmentControl;
/**
* Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.
*/
SegmentLength?: __integerMin1Max2147483647;
StreamInfResolution?: CmafStreamInfResolution;
WriteDashManifest?: CmafWriteDASHManifest;
WriteHlsManifest?: CmafWriteHLSManifest;
}
export type CmafInitializationVectorInManifest = "INCLUDE"|"EXCLUDE"|string;
export type CmafKeyProviderType = "STATIC_KEY"|string;
export type CmafManifestCompression = "GZIP"|"NONE"|string;
export type CmafManifestDurationFormat = "FLOATING_POINT"|"INTEGER"|string;
export type CmafSegmentControl = "SINGLE_FILE"|"SEGMENTED_FILES"|string;
export type CmafStreamInfResolution = "INCLUDE"|"EXCLUDE"|string;
export type CmafWriteDASHManifest = "DISABLED"|"ENABLED"|string;
export type CmafWriteHLSManifest = "DISABLED"|"ENABLED"|string;
export interface ColorCorrector {
/**
* Brightness level.
*/
Brightness?: __integerMin1Max100;
ColorSpaceConversion?: ColorSpaceConversion;
/**
* Contrast level.
*/
Contrast?: __integerMin1Max100;
Hdr10Metadata?: Hdr10Metadata;
/**
* Hue in degrees.
*/
Hue?: __integerMinNegative180Max180;
/**
* Saturation level.
*/
Saturation?: __integerMin1Max100;
}
export type ColorMetadata = "IGNORE"|"INSERT"|string;
export type ColorSpace = "FOLLOW"|"REC_601"|"REC_709"|"HDR10"|"HLG_2020"|string;
export type ColorSpaceConversion = "NONE"|"FORCE_601"|"FORCE_709"|"FORCE_HDR10"|"FORCE_HLG_2020"|string;
export type ColorSpaceUsage = "FORCE"|"FALLBACK"|string;
export type Commitment = "ONE_YEAR"|string;
export interface ContainerSettings {
Container?: ContainerType;
F4vSettings?: F4vSettings;
M2tsSettings?: M2tsSettings;
M3u8Settings?: M3u8Settings;
MovSettings?: MovSettings;
Mp4Settings?: Mp4Settings;
}
export type ContainerType = "F4V"|"ISMV"|"M2TS"|"M3U8"|"CMFC"|"MOV"|"MP4"|"MPD"|"MXF"|"RAW"|string;
export interface CreateJobRequest {
BillingTagsSource?: BillingTagsSource;
/**
* Idempotency token for CreateJob operation.
*/
ClientRequestToken?: __string;
/**
* When you create a job, you can either specify a job template or specify the transcoding settings individually
*/
JobTemplate?: __string;
/**
* Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
*/
Queue?: __string;
/**
* Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
*/
Role: __string;
Settings: JobSettings;
/**
* User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
*/
UserMetadata?: __mapOf__string;
}
export interface CreateJobResponse {
Job?: Job;
}
export interface CreateJobTemplateRequest {
/**
* Optional. A category for the job template you are creating
*/
Category?: __string;
/**
* Optional. A description of the job template you are creating.
*/
Description?: __string;
/**
* The name of the job template you are creating.
*/
Name: __string;
/**
* Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.
*/
Queue?: __string;
Settings: JobTemplateSettings;
/**
* The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
*/
Tags?: __mapOf__string;
}
export interface CreateJobTemplateResponse {
JobTemplate?: JobTemplate;
}
export interface CreatePresetRequest {
/**
* Optional. A category for the preset you are creating.
*/
Category?: __string;
/**
* Optional. A description of the preset you are creating.
*/
Description?: __string;
/**
* The name of the preset you are creating.
*/
Name: __string;
Settings: PresetSettings;
/**
* The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
*/
Tags?: __mapOf__string;
}
export interface CreatePresetResponse {
Preset?: Preset;
}
export interface CreateQueueRequest {
/**
* Optional. A description of the queue that you are creating.
*/
Description?: __string;
/**
* The name of the queue that you are creating.
*/
Name: __string;
/**
* Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.
*/
PricingPlan?: PricingPlan;
/**
* Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
*/
ReservationPlanSettings?: ReservationPlanSettings;
/**
* The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
*/
Tags?: __mapOf__string;
}
export interface CreateQueueResponse {
Queue?: Queue;
}
export interface DashIsoEncryptionSettings {
SpekeKeyProvider?: SpekeKeyProvider;
}
export interface DashIsoGroupSettings {
/**
* A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.
*/
BaseUrl?: __string;
/**
* Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.
*/
Destination?: __stringPatternS3;
/**
* DRM settings.
*/
Encryption?: DashIsoEncryptionSettings;
/**
* Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.
*/
FragmentLength?: __integerMin1Max2147483647;
HbbtvCompliance?: DashIsoHbbtvCompliance;
/**
* Minimum time of initially buffered media that is needed to ensure smooth playout.
*/
MinBufferTime?: __integerMin0Max2147483647;
SegmentControl?: DashIsoSegmentControl;
/**
* Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.
*/
SegmentLength?: __integerMin1Max2147483647;
/**
* When you enable Precise segment duration in manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.
*/
WriteSegmentTimelineInRepresentation?: DashIsoWriteSegmentTimelineInRepresentation;
}
export type DashIsoHbbtvCompliance = "HBBTV_1_5"|"NONE"|string;
export type DashIsoSegmentControl = "SINGLE_FILE"|"SEGMENTED_FILES"|string;
export type DashIsoWriteSegmentTimelineInRepresentation = "ENABLED"|"DISABLED"|string;
export type DecryptionMode = "AES_CTR"|"AES_CBC"|"AES_GCM"|string;
export type DeinterlaceAlgorithm = "INTERPOLATE"|"INTERPOLATE_TICKER"|"BLEND"|"BLEND_TICKER"|string;
export interface Deinterlacer {
Algorithm?: DeinterlaceAlgorithm;
Control?: DeinterlacerControl;
Mode?: DeinterlacerMode;
}
export type DeinterlacerControl = "FORCE_ALL_FRAMES"|"NORMAL"|string;
export type DeinterlacerMode = "DEINTERLACE"|"INVERSE_TELECINE"|"ADAPTIVE"|string;
export interface DeleteJobTemplateRequest {
/**
* The name of the job template to be deleted.
*/
Name: __string;
}
export interface DeleteJobTemplateResponse {
}
export interface DeletePresetRequest {
/**
* The name of the preset to be deleted.
*/
Name: __string;
}
export interface DeletePresetResponse {
}
export interface DeleteQueueRequest {
/**
* The name of the queue that you want to delete.
*/
Name: __string;
}
export interface DeleteQueueResponse {
}
export type DescribeEndpointsMode = "DEFAULT"|"GET_ONLY"|string;
export interface DescribeEndpointsRequest {
/**
* Optional. Max number of endpoints, up to twenty, that will be returned at one time.
*/
MaxResults?: __integer;
Mode?: DescribeEndpointsMode;
/**
* Use this string, provided with the response to a previous request, to request the next batch of endpoints.
*/
NextToken?: __string;
}
export interface DescribeEndpointsResponse {
/**
* List of endpoints
*/
Endpoints?: __listOfEndpoint;
/**
* Use this string to request the next batch of endpoints.
*/
NextToken?: __string;
}
export interface DisassociateCertificateRequest {
/**
* The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.
*/
Arn: __string;
}
export interface DisassociateCertificateResponse {
}
export type DropFrameTimecode = "DISABLED"|"ENABLED"|string;
export interface DvbNitSettings {
/**
* The numeric value placed in the Network Information Table (NIT).
*/
NetworkId?: __integerMin0Max65535;
/**
* The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters.
*/
NetworkName?: __stringMin1Max256;
/**
* The number of milliseconds between instances of this table in the