@aws-sdk/client-mediaconvert 3.798.0 → 3.803.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +31 -4
- package/dist-cjs/runtimeConfig.js +1 -0
- package/dist-es/models/models_0.js +9 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +18 -2
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/commands/CreateJobCommand.d.ts +38 -2
- package/dist-types/commands/CreateJobTemplateCommand.d.ts +38 -2
- package/dist-types/commands/CreatePresetCommand.d.ts +34 -0
- package/dist-types/commands/GetJobCommand.d.ts +19 -1
- package/dist-types/commands/GetJobTemplateCommand.d.ts +19 -1
- package/dist-types/commands/GetPresetCommand.d.ts +17 -0
- package/dist-types/commands/ListJobTemplatesCommand.d.ts +19 -1
- package/dist-types/commands/ListJobsCommand.d.ts +19 -1
- package/dist-types/commands/ListPresetsCommand.d.ts +17 -0
- package/dist-types/commands/ProbeCommand.d.ts +2 -2
- package/dist-types/commands/SearchJobsCommand.d.ts +19 -1
- package/dist-types/commands/UpdateJobTemplateCommand.d.ts +38 -2
- package/dist-types/commands/UpdatePresetCommand.d.ts +34 -0
- package/dist-types/models/models_0.d.ts +19 -14
- package/dist-types/models/models_1.d.ts +54 -153
- package/dist-types/models/models_2.d.ts +155 -4
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +11 -6
- package/dist-types/ts3.4/models/models_1.d.ts +15 -40
- package/dist-types/ts3.4/models/models_2.d.ts +38 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
- package/package.json +7 -7
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AudioDescription, AutomatedEncodingSettings, AvailBlanking, CaptionDescription, CmafGroupSettings, ColorConversion3DLUTSetting, DashIsoGroupSettings, DestinationSettings, EsamSettings, ExtendedDataServices, FileGroupSettings, FrameMetricType, Hdr10Metadata, HlsGroupSettings, Id3Insertion, ImageInserter, Input, KantarWatermarkSettings, MotionImageInserter, MsSmoothAdditionalManifest, MsSmoothAudioDeduplication, MsSmoothEncryptionSettings, NielsenConfiguration, NielsenNonLinearWatermarkSettings, Rectangle } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
* @enum
|
|
5
|
+
*/
|
|
6
|
+
export declare const MsSmoothFragmentLengthControl: {
|
|
7
|
+
readonly EXACT: "EXACT";
|
|
8
|
+
readonly GOP_MULTIPLE: "GOP_MULTIPLE";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export type MsSmoothFragmentLengthControl = (typeof MsSmoothFragmentLengthControl)[keyof typeof MsSmoothFragmentLengthControl];
|
|
2
14
|
/**
|
|
3
15
|
* @public
|
|
4
16
|
* @enum
|
|
@@ -102,6 +114,11 @@ export interface OutputGroupSettings {
|
|
|
102
114
|
* @public
|
|
103
115
|
*/
|
|
104
116
|
MsSmoothGroupSettings?: MsSmoothGroupSettings | undefined;
|
|
117
|
+
/**
|
|
118
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
105
122
|
/**
|
|
106
123
|
* Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)
|
|
107
124
|
* @public
|
|
@@ -1819,6 +1836,11 @@ export interface Av1Settings {
|
|
|
1819
1836
|
* @public
|
|
1820
1837
|
*/
|
|
1821
1838
|
NumberBFramesBetweenReferenceFrames?: number | undefined;
|
|
1839
|
+
/**
|
|
1840
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
1841
|
+
* @public
|
|
1842
|
+
*/
|
|
1843
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
1822
1844
|
/**
|
|
1823
1845
|
* Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode.
|
|
1824
1846
|
* @public
|
|
@@ -1994,6 +2016,11 @@ export interface AvcIntraSettings {
|
|
|
1994
2016
|
* @public
|
|
1995
2017
|
*/
|
|
1996
2018
|
InterlaceMode?: AvcIntraInterlaceMode | undefined;
|
|
2019
|
+
/**
|
|
2020
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
2021
|
+
* @public
|
|
2022
|
+
*/
|
|
2023
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
1997
2024
|
/**
|
|
1998
2025
|
* Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
|
|
1999
2026
|
* @public
|
|
@@ -2685,6 +2712,11 @@ export interface H264Settings {
|
|
|
2685
2712
|
* @public
|
|
2686
2713
|
*/
|
|
2687
2714
|
ParNumerator?: number | undefined;
|
|
2715
|
+
/**
|
|
2716
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
2717
|
+
* @public
|
|
2718
|
+
*/
|
|
2719
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
2688
2720
|
/**
|
|
2689
2721
|
* The Quality tuning level you choose represents a trade-off between the encoding speed of your job and the output video quality. For the fastest encoding speed at the cost of video quality: Choose Single pass. For a good balance between encoding speed and video quality: Leave blank or keep the default value Single pass HQ. For the best video quality, at the cost of encoding speed: Choose Multi pass HQ. MediaConvert performs an analysis pass on your input followed by an encoding pass. Outputs that use this feature incur pro-tier pricing.
|
|
2690
2722
|
* @public
|
|
@@ -3295,6 +3327,11 @@ export interface H265Settings {
|
|
|
3295
3327
|
* @public
|
|
3296
3328
|
*/
|
|
3297
3329
|
ParNumerator?: number | undefined;
|
|
3330
|
+
/**
|
|
3331
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
3332
|
+
* @public
|
|
3333
|
+
*/
|
|
3334
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
3298
3335
|
/**
|
|
3299
3336
|
* Optional. Use Quality tuning level to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.
|
|
3300
3337
|
* @public
|
|
@@ -3733,6 +3770,11 @@ export interface Mpeg2Settings {
|
|
|
3733
3770
|
* @public
|
|
3734
3771
|
*/
|
|
3735
3772
|
ParNumerator?: number | undefined;
|
|
3773
|
+
/**
|
|
3774
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
3775
|
+
* @public
|
|
3776
|
+
*/
|
|
3777
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
3736
3778
|
/**
|
|
3737
3779
|
* Optional. Use Quality tuning level to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.
|
|
3738
3780
|
* @public
|
|
@@ -3956,6 +3998,11 @@ export interface ProresSettings {
|
|
|
3956
3998
|
* @public
|
|
3957
3999
|
*/
|
|
3958
4000
|
ParNumerator?: number | undefined;
|
|
4001
|
+
/**
|
|
4002
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
4003
|
+
* @public
|
|
4004
|
+
*/
|
|
4005
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
3959
4006
|
/**
|
|
3960
4007
|
* Use this setting for interlaced outputs, when your output frame rate is half of your input frame rate. In this situation, choose Optimized interlacing to create a better quality interlaced output. In this case, each progressive frame from the input corresponds to an interlaced field in the output. Keep the default value, Basic interlacing, for all other output frame rates. With basic interlacing, MediaConvert performs any frame rate conversion first and then interlaces the frames. When you choose Optimized interlacing and you set your output frame rate to a value that isn't suitable for optimized interlacing, MediaConvert automatically falls back to basic interlacing. Required settings: To use optimized interlacing, you must set Telecine to None or Soft. You can't use optimized interlacing for hard telecine outputs. You must also set Interlace mode to a value other than Progressive.
|
|
3961
4008
|
* @public
|
|
@@ -4938,6 +4985,11 @@ export interface XavcSettings {
|
|
|
4938
4985
|
* @public
|
|
4939
4986
|
*/
|
|
4940
4987
|
FramerateNumerator?: number | undefined;
|
|
4988
|
+
/**
|
|
4989
|
+
* Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.
|
|
4990
|
+
* @public
|
|
4991
|
+
*/
|
|
4992
|
+
PerFrameMetrics?: FrameMetricType[] | undefined;
|
|
4941
4993
|
/**
|
|
4942
4994
|
* 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 support the interlaced video XAVC operating points for XAVC_HD_INTRA_CBG. To create an interlaced XAVC output, choose the profile XAVC_HD.
|
|
4943
4995
|
* @public
|
|
@@ -5955,7 +6007,7 @@ export interface JobSettings {
|
|
|
5955
6007
|
*/
|
|
5956
6008
|
ExtendedDataServices?: ExtendedDataServices | undefined;
|
|
5957
6009
|
/**
|
|
5958
|
-
* Specify the input that MediaConvert references for your default output settings.
|
|
6010
|
+
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable "Follow source" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.
|
|
5959
6011
|
* @public
|
|
5960
6012
|
*/
|
|
5961
6013
|
FollowSource?: number | undefined;
|
|
@@ -6089,154 +6141,3 @@ export interface WarningGroup {
|
|
|
6089
6141
|
*/
|
|
6090
6142
|
Count: number | undefined;
|
|
6091
6143
|
}
|
|
6092
|
-
/**
|
|
6093
|
-
* 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/what-is.html
|
|
6094
|
-
* @public
|
|
6095
|
-
*/
|
|
6096
|
-
export interface Job {
|
|
6097
|
-
/**
|
|
6098
|
-
* Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
|
6099
|
-
* @public
|
|
6100
|
-
*/
|
|
6101
|
-
AccelerationSettings?: AccelerationSettings | undefined;
|
|
6102
|
-
/**
|
|
6103
|
-
* Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
|
|
6104
|
-
* @public
|
|
6105
|
-
*/
|
|
6106
|
-
AccelerationStatus?: AccelerationStatus | undefined;
|
|
6107
|
-
/**
|
|
6108
|
-
* An identifier for this resource that is unique within all of AWS.
|
|
6109
|
-
* @public
|
|
6110
|
-
*/
|
|
6111
|
-
Arn?: string | undefined;
|
|
6112
|
-
/**
|
|
6113
|
-
* 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.
|
|
6114
|
-
* @public
|
|
6115
|
-
*/
|
|
6116
|
-
BillingTagsSource?: BillingTagsSource | undefined;
|
|
6117
|
-
/**
|
|
6118
|
-
* Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
|
|
6119
|
-
* @public
|
|
6120
|
-
*/
|
|
6121
|
-
ClientRequestToken?: string | undefined;
|
|
6122
|
-
/**
|
|
6123
|
-
* The time, in Unix epoch format in seconds, when the job got created.
|
|
6124
|
-
* @public
|
|
6125
|
-
*/
|
|
6126
|
-
CreatedAt?: Date | undefined;
|
|
6127
|
-
/**
|
|
6128
|
-
* A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
|
6129
|
-
* @public
|
|
6130
|
-
*/
|
|
6131
|
-
CurrentPhase?: JobPhase | undefined;
|
|
6132
|
-
/**
|
|
6133
|
-
* Error code for the job
|
|
6134
|
-
* @public
|
|
6135
|
-
*/
|
|
6136
|
-
ErrorCode?: number | undefined;
|
|
6137
|
-
/**
|
|
6138
|
-
* Error message of Job
|
|
6139
|
-
* @public
|
|
6140
|
-
*/
|
|
6141
|
-
ErrorMessage?: string | undefined;
|
|
6142
|
-
/**
|
|
6143
|
-
* Optional list of hop destinations.
|
|
6144
|
-
* @public
|
|
6145
|
-
*/
|
|
6146
|
-
HopDestinations?: HopDestination[] | undefined;
|
|
6147
|
-
/**
|
|
6148
|
-
* A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
|
|
6149
|
-
* @public
|
|
6150
|
-
*/
|
|
6151
|
-
Id?: string | undefined;
|
|
6152
|
-
/**
|
|
6153
|
-
* The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.
|
|
6154
|
-
* @public
|
|
6155
|
-
*/
|
|
6156
|
-
JobEngineVersionRequested?: string | undefined;
|
|
6157
|
-
/**
|
|
6158
|
-
* The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.
|
|
6159
|
-
* @public
|
|
6160
|
-
*/
|
|
6161
|
-
JobEngineVersionUsed?: string | undefined;
|
|
6162
|
-
/**
|
|
6163
|
-
* An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
|
|
6164
|
-
* @public
|
|
6165
|
-
*/
|
|
6166
|
-
JobPercentComplete?: number | undefined;
|
|
6167
|
-
/**
|
|
6168
|
-
* The job template that the job is created from, if it is created from a job template.
|
|
6169
|
-
* @public
|
|
6170
|
-
*/
|
|
6171
|
-
JobTemplate?: string | undefined;
|
|
6172
|
-
/**
|
|
6173
|
-
* Provides messages from the service about jobs that you have already successfully submitted.
|
|
6174
|
-
* @public
|
|
6175
|
-
*/
|
|
6176
|
-
Messages?: JobMessages | undefined;
|
|
6177
|
-
/**
|
|
6178
|
-
* List of output group details
|
|
6179
|
-
* @public
|
|
6180
|
-
*/
|
|
6181
|
-
OutputGroupDetails?: OutputGroupDetail[] | undefined;
|
|
6182
|
-
/**
|
|
6183
|
-
* Relative priority on the job.
|
|
6184
|
-
* @public
|
|
6185
|
-
*/
|
|
6186
|
-
Priority?: number | undefined;
|
|
6187
|
-
/**
|
|
6188
|
-
* When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
|
|
6189
|
-
* @public
|
|
6190
|
-
*/
|
|
6191
|
-
Queue?: string | undefined;
|
|
6192
|
-
/**
|
|
6193
|
-
* The job's queue hopping history.
|
|
6194
|
-
* @public
|
|
6195
|
-
*/
|
|
6196
|
-
QueueTransitions?: QueueTransition[] | undefined;
|
|
6197
|
-
/**
|
|
6198
|
-
* The number of times that the service automatically attempted to process your job after encountering an error.
|
|
6199
|
-
* @public
|
|
6200
|
-
*/
|
|
6201
|
-
RetryCount?: number | undefined;
|
|
6202
|
-
/**
|
|
6203
|
-
* The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
|
|
6204
|
-
* @public
|
|
6205
|
-
*/
|
|
6206
|
-
Role: string | undefined;
|
|
6207
|
-
/**
|
|
6208
|
-
* JobSettings contains all the transcode settings for a job.
|
|
6209
|
-
* @public
|
|
6210
|
-
*/
|
|
6211
|
-
Settings: JobSettings | undefined;
|
|
6212
|
-
/**
|
|
6213
|
-
* Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
|
|
6214
|
-
* @public
|
|
6215
|
-
*/
|
|
6216
|
-
SimulateReservedQueue?: SimulateReservedQueue | undefined;
|
|
6217
|
-
/**
|
|
6218
|
-
* A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
|
6219
|
-
* @public
|
|
6220
|
-
*/
|
|
6221
|
-
Status?: JobStatus | undefined;
|
|
6222
|
-
/**
|
|
6223
|
-
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
|
|
6224
|
-
* @public
|
|
6225
|
-
*/
|
|
6226
|
-
StatusUpdateInterval?: StatusUpdateInterval | undefined;
|
|
6227
|
-
/**
|
|
6228
|
-
* Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
|
|
6229
|
-
* @public
|
|
6230
|
-
*/
|
|
6231
|
-
Timing?: Timing | undefined;
|
|
6232
|
-
/**
|
|
6233
|
-
* User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
|
|
6234
|
-
* @public
|
|
6235
|
-
*/
|
|
6236
|
-
UserMetadata?: Record<string, string> | undefined;
|
|
6237
|
-
/**
|
|
6238
|
-
* Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html
|
|
6239
|
-
* @public
|
|
6240
|
-
*/
|
|
6241
|
-
Warnings?: WarningGroup[] | undefined;
|
|
6242
|
-
}
|
|
@@ -1,7 +1,158 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { MediaConvertServiceException as __BaseException } from "./MediaConvertServiceException";
|
|
3
|
-
import { AccelerationSettings, AudioDescription, AvailBlanking, BillingTagsSource, CaptionDescriptionPreset, ColorConversion3DLUTSetting, Endpoint, EsamSettings, ExtendedDataServices, HopDestination, InputTemplate, KantarWatermarkSettings, MotionImageInserter, NielsenConfiguration, NielsenNonLinearWatermarkSettings } from "./models_0";
|
|
4
|
-
import { ContainerSettings,
|
|
3
|
+
import { AccelerationSettings, AccelerationStatus, AudioDescription, AvailBlanking, BillingTagsSource, CaptionDescriptionPreset, ColorConversion3DLUTSetting, Endpoint, EsamSettings, ExtendedDataServices, HopDestination, InputTemplate, JobMessages, JobPhase, KantarWatermarkSettings, MotionImageInserter, NielsenConfiguration, NielsenNonLinearWatermarkSettings, OutputGroupDetail, QueueTransition } from "./models_0";
|
|
4
|
+
import { ContainerSettings, JobSettings, JobStatus, OutputGroup, SimulateReservedQueue, StatusUpdateInterval, TimecodeConfig, TimedMetadataInsertion, Timing, VideoDescription, WarningGroup } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* 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/what-is.html
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface Job {
|
|
10
|
+
/**
|
|
11
|
+
* Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
AccelerationSettings?: AccelerationSettings | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
AccelerationStatus?: AccelerationStatus | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* An identifier for this resource that is unique within all of AWS.
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
Arn?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* 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.
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
BillingTagsSource?: BillingTagsSource | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
ClientRequestToken?: string | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* The time, in Unix epoch format in seconds, when the job got created.
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
CreatedAt?: Date | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
CurrentPhase?: JobPhase | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* Error code for the job
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
ErrorCode?: number | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* Error message of Job
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
ErrorMessage?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Optional list of hop destinations.
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
HopDestinations?: HopDestination[] | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
Id?: string | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
JobEngineVersionRequested?: string | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
JobEngineVersionUsed?: string | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
JobPercentComplete?: number | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* The job template that the job is created from, if it is created from a job template.
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
JobTemplate?: string | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* Provides messages from the service about jobs that you have already successfully submitted.
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
Messages?: JobMessages | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* List of output group details
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
OutputGroupDetails?: OutputGroupDetail[] | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* Relative priority on the job.
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
Priority?: number | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
Queue?: string | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* The job's queue hopping history.
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
QueueTransitions?: QueueTransition[] | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* The number of times that the service automatically attempted to process your job after encountering an error.
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
RetryCount?: number | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
Role: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* JobSettings contains all the transcode settings for a job.
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
Settings: JobSettings | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
SimulateReservedQueue?: SimulateReservedQueue | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
Status?: JobStatus | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
StatusUpdateInterval?: StatusUpdateInterval | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
Timing?: Timing | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
UserMetadata?: Record<string, string> | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
Warnings?: WarningGroup[] | undefined;
|
|
155
|
+
}
|
|
5
156
|
/**
|
|
6
157
|
* Use Job engine versions to run jobs for your production workflow on one version, while you test and validate the latest version. Job engine versions are in a YYYY-MM-DD format.
|
|
7
158
|
* @public
|
|
@@ -49,7 +200,7 @@ export interface JobTemplateSettings {
|
|
|
49
200
|
*/
|
|
50
201
|
ExtendedDataServices?: ExtendedDataServices | undefined;
|
|
51
202
|
/**
|
|
52
|
-
* Specify the input that MediaConvert references for your default output settings.
|
|
203
|
+
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable "Follow source" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.
|
|
53
204
|
* @public
|
|
54
205
|
*/
|
|
55
206
|
FollowSource?: number | undefined;
|
|
@@ -951,7 +1102,7 @@ export interface CreateJobRequest {
|
|
|
951
1102
|
*/
|
|
952
1103
|
AccelerationSettings?: AccelerationSettings | undefined;
|
|
953
1104
|
/**
|
|
954
|
-
*
|
|
1105
|
+
* Optionally choose a Billing tags source that AWS Billing and Cost Management will use to display tags for individual output costs on any billing report that you set up. Leave blank to use the default value, Job.
|
|
955
1106
|
* @public
|
|
956
1107
|
*/
|
|
957
1108
|
BillingTagsSource?: BillingTagsSource | undefined;
|
|
@@ -6,6 +6,7 @@ import { MediaConvertClientConfig } from "./MediaConvertClient";
|
|
|
6
6
|
export declare const getRuntimeConfig: (config: MediaConvertClientConfig) => {
|
|
7
7
|
runtime: string;
|
|
8
8
|
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
|
+
authSchemePreference: string[] | import("@smithy/types").Provider<string[]>;
|
|
9
10
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
11
|
credentialDefaultProvider: ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider) | ((init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit | undefined) => import("@smithy/types").MemoizedProvider<import("@smithy/types").AwsCredentialIdentity>);
|
|
11
12
|
defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
|
|
@@ -38,7 +39,6 @@ export declare const getRuntimeConfig: (config: MediaConvertClientConfig) => {
|
|
|
38
39
|
}) => import("@smithy/types").EndpointV2;
|
|
39
40
|
tls?: boolean | undefined;
|
|
40
41
|
serviceConfiguredEndpoint?: undefined;
|
|
41
|
-
authSchemePreference?: string[] | import("@smithy/types").Provider<string[]> | undefined;
|
|
42
42
|
httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
|
|
43
43
|
httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").MediaConvertHttpAuthSchemeProvider;
|
|
44
44
|
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
|
|
@@ -1148,6 +1148,16 @@ export interface DashAdditionalManifest {
|
|
|
1148
1148
|
export interface Endpoint {
|
|
1149
1149
|
Url?: string | undefined;
|
|
1150
1150
|
}
|
|
1151
|
+
export declare const FrameMetricType: {
|
|
1152
|
+
readonly MS_SSIM: "MS_SSIM";
|
|
1153
|
+
readonly PSNR: "PSNR";
|
|
1154
|
+
readonly PSNR_HVS: "PSNR_HVS";
|
|
1155
|
+
readonly QVBR: "QVBR";
|
|
1156
|
+
readonly SSIM: "SSIM";
|
|
1157
|
+
readonly VMAF: "VMAF";
|
|
1158
|
+
};
|
|
1159
|
+
export type FrameMetricType =
|
|
1160
|
+
(typeof FrameMetricType)[keyof typeof FrameMetricType];
|
|
1151
1161
|
export interface HlsAdditionalManifest {
|
|
1152
1162
|
ManifestNameModifier?: string | undefined;
|
|
1153
1163
|
SelectedOutputs?: string[] | undefined;
|
|
@@ -1219,6 +1229,7 @@ export interface HlsRenditionGroupSettings {
|
|
|
1219
1229
|
RenditionName?: string | undefined;
|
|
1220
1230
|
}
|
|
1221
1231
|
export declare const AudioSelectorType: {
|
|
1232
|
+
readonly ALL_PCM: "ALL_PCM";
|
|
1222
1233
|
readonly HLS_RENDITION_GROUP: "HLS_RENDITION_GROUP";
|
|
1223
1234
|
readonly LANGUAGE_CODE: "LANGUAGE_CODE";
|
|
1224
1235
|
readonly PID: "PID";
|
|
@@ -2381,9 +2392,3 @@ export type MsSmoothAudioDeduplication =
|
|
|
2381
2392
|
export interface MsSmoothEncryptionSettings {
|
|
2382
2393
|
SpekeKeyProvider?: SpekeKeyProvider | undefined;
|
|
2383
2394
|
}
|
|
2384
|
-
export declare const MsSmoothFragmentLengthControl: {
|
|
2385
|
-
readonly EXACT: "EXACT";
|
|
2386
|
-
readonly GOP_MULTIPLE: "GOP_MULTIPLE";
|
|
2387
|
-
};
|
|
2388
|
-
export type MsSmoothFragmentLengthControl =
|
|
2389
|
-
(typeof MsSmoothFragmentLengthControl)[keyof typeof MsSmoothFragmentLengthControl];
|