@aws-sdk/client-medialive 3.379.1 → 3.382.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.
@@ -118,34 +118,41 @@ export type HlsTsFileMode = (typeof HlsTsFileMode)[keyof typeof HlsTsFileMode];
118
118
  */
119
119
  export interface HlsGroupSettings {
120
120
  /**
121
+ * @public
121
122
  * Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
122
123
  */
123
124
  AdMarkers?: (HlsAdMarkers | string)[];
124
125
  /**
126
+ * @public
125
127
  * A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
126
128
  */
127
129
  BaseUrlContent?: string;
128
130
  /**
131
+ * @public
129
132
  * Optional. One value per output group.
130
133
  *
131
134
  * This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.
132
135
  */
133
136
  BaseUrlContent1?: string;
134
137
  /**
138
+ * @public
135
139
  * A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
136
140
  */
137
141
  BaseUrlManifest?: string;
138
142
  /**
143
+ * @public
139
144
  * Optional. One value per output group.
140
145
  *
141
146
  * Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.
142
147
  */
143
148
  BaseUrlManifest1?: string;
144
149
  /**
150
+ * @public
145
151
  * Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
146
152
  */
147
153
  CaptionLanguageMappings?: CaptionLanguageMapping[];
148
154
  /**
155
+ * @public
149
156
  * Applies only to 608 Embedded output captions.
150
157
  * insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.
151
158
  * none: Include CLOSED-CAPTIONS=NONE line in the manifest.
@@ -153,74 +160,90 @@ export interface HlsGroupSettings {
153
160
  */
154
161
  CaptionLanguageSetting?: HlsCaptionLanguageSetting | string;
155
162
  /**
163
+ * @public
156
164
  * When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.
157
165
  */
158
166
  ClientCache?: HlsClientCache | string;
159
167
  /**
168
+ * @public
160
169
  * Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.
161
170
  */
162
171
  CodecSpecification?: HlsCodecSpecification | string;
163
172
  /**
173
+ * @public
164
174
  * For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
165
175
  */
166
176
  ConstantIv?: string;
167
177
  /**
178
+ * @public
168
179
  * A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
169
180
  */
170
181
  Destination: OutputLocationRef | undefined;
171
182
  /**
183
+ * @public
172
184
  * Place segments in subdirectories.
173
185
  */
174
186
  DirectoryStructure?: HlsDirectoryStructure | string;
175
187
  /**
188
+ * @public
176
189
  * Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group.
177
190
  * Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose.
178
191
  * Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.
179
192
  */
180
193
  DiscontinuityTags?: HlsDiscontinuityTags | string;
181
194
  /**
195
+ * @public
182
196
  * Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.
183
197
  */
184
198
  EncryptionType?: HlsEncryptionType | string;
185
199
  /**
200
+ * @public
186
201
  * Parameters that control interactions with the CDN.
187
202
  */
188
203
  HlsCdnSettings?: HlsCdnSettings;
189
204
  /**
205
+ * @public
190
206
  * State of HLS ID3 Segment Tagging
191
207
  */
192
208
  HlsId3SegmentTagging?: HlsId3SegmentTaggingState | string;
193
209
  /**
210
+ * @public
194
211
  * DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).
195
212
  *
196
213
  * STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888"
197
214
  */
198
215
  IFrameOnlyPlaylists?: IFrameOnlyPlaylistType | string;
199
216
  /**
217
+ * @public
200
218
  * Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline.
201
219
  * Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups.
202
220
  * Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.
203
221
  */
204
222
  IncompleteSegmentBehavior?: HlsIncompleteSegmentBehavior | string;
205
223
  /**
224
+ * @public
206
225
  * Applies only if Mode field is LIVE.
207
226
  *
208
227
  * Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field.
209
228
  */
210
229
  IndexNSegments?: number;
211
230
  /**
231
+ * @public
212
232
  * Parameter that control output group behavior on input loss.
213
233
  */
214
234
  InputLossAction?: InputLossActionForHlsOut | string;
215
235
  /**
236
+ * @public
216
237
  * For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.
217
238
  */
218
239
  IvInManifest?: HlsIvInManifest | string;
219
240
  /**
241
+ * @public
220
242
  * For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.
221
243
  */
222
244
  IvSource?: HlsIvSource | string;
223
245
  /**
246
+ * @public
224
247
  * Applies only if Mode field is LIVE.
225
248
  *
226
249
  * Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1).
@@ -229,36 +252,44 @@ export interface HlsGroupSettings {
229
252
  */
230
253
  KeepSegments?: number;
231
254
  /**
255
+ * @public
232
256
  * The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
233
257
  */
234
258
  KeyFormat?: string;
235
259
  /**
260
+ * @public
236
261
  * Either a single positive integer version value or a slash delimited list of version values (1/2/3).
237
262
  */
238
263
  KeyFormatVersions?: string;
239
264
  /**
265
+ * @public
240
266
  * The key provider settings.
241
267
  */
242
268
  KeyProviderSettings?: KeyProviderSettings;
243
269
  /**
270
+ * @public
244
271
  * When set to gzip, compresses HLS playlist.
245
272
  */
246
273
  ManifestCompression?: HlsManifestCompression | string;
247
274
  /**
275
+ * @public
248
276
  * Indicates whether the output manifest should use floating point or integer values for segment duration.
249
277
  */
250
278
  ManifestDurationFormat?: HlsManifestDurationFormat | string;
251
279
  /**
280
+ * @public
252
281
  * Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
253
282
  */
254
283
  MinSegmentLength?: number;
255
284
  /**
285
+ * @public
256
286
  * If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.
257
287
  *
258
288
  * VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.
259
289
  */
260
290
  Mode?: HlsMode | string;
261
291
  /**
292
+ * @public
262
293
  * MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.
263
294
  *
264
295
  * VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest.
@@ -267,10 +298,12 @@ export interface HlsGroupSettings {
267
298
  */
268
299
  OutputSelection?: HlsOutputSelection | string;
269
300
  /**
301
+ * @public
270
302
  * Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.
271
303
  */
272
304
  ProgramDateTime?: HlsProgramDateTime | string;
273
305
  /**
306
+ * @public
274
307
  * Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include:
275
308
  *
276
309
  * INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment.
@@ -279,10 +312,12 @@ export interface HlsGroupSettings {
279
312
  */
280
313
  ProgramDateTimeClock?: HlsProgramDateTimeClock | string;
281
314
  /**
315
+ * @public
282
316
  * Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
283
317
  */
284
318
  ProgramDateTimePeriod?: number;
285
319
  /**
320
+ * @public
286
321
  * ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.
287
322
  *
288
323
  * DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.
@@ -291,34 +326,42 @@ export interface HlsGroupSettings {
291
326
  */
292
327
  RedundantManifest?: HlsRedundantManifest | string;
293
328
  /**
329
+ * @public
294
330
  * Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.
295
331
  */
296
332
  SegmentLength?: number;
297
333
  /**
334
+ * @public
298
335
  * useInputSegmentation has been deprecated. The configured segment size is always used.
299
336
  */
300
337
  SegmentationMode?: HlsSegmentationMode | string;
301
338
  /**
339
+ * @public
302
340
  * Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
303
341
  */
304
342
  SegmentsPerSubdirectory?: number;
305
343
  /**
344
+ * @public
306
345
  * Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.
307
346
  */
308
347
  StreamInfResolution?: HlsStreamInfResolution | string;
309
348
  /**
349
+ * @public
310
350
  * Indicates ID3 frame that has the timecode.
311
351
  */
312
352
  TimedMetadataId3Frame?: HlsTimedMetadataId3Frame | string;
313
353
  /**
354
+ * @public
314
355
  * Timed Metadata interval in seconds.
315
356
  */
316
357
  TimedMetadataId3Period?: number;
317
358
  /**
359
+ * @public
318
360
  * Provides an extra millisecond delta offset to fine tune the timestamps.
319
361
  */
320
362
  TimestampDeltaMilliseconds?: number;
321
363
  /**
364
+ * @public
322
365
  * SEGMENTED_FILES: Emit the program as segments - multiple .ts media files.
323
366
  *
324
367
  * SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching.
@@ -331,6 +374,7 @@ export interface HlsGroupSettings {
331
374
  */
332
375
  export interface MediaPackageGroupSettings {
333
376
  /**
377
+ * @public
334
378
  * MediaPackage channel destination.
335
379
  */
336
380
  Destination: OutputLocationRef | undefined;
@@ -451,32 +495,39 @@ export type SmoothGroupTimestampOffsetMode = (typeof SmoothGroupTimestampOffsetM
451
495
  */
452
496
  export interface MsSmoothGroupSettings {
453
497
  /**
498
+ * @public
454
499
  * The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.
455
500
  */
456
501
  AcquisitionPointId?: string;
457
502
  /**
503
+ * @public
458
504
  * If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream.
459
505
  */
460
506
  AudioOnlyTimecodeControl?: SmoothGroupAudioOnlyTimecodeControl | string;
461
507
  /**
508
+ * @public
462
509
  * If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail.
463
510
  */
464
511
  CertificateMode?: SmoothGroupCertificateMode | string;
465
512
  /**
513
+ * @public
466
514
  * Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
467
515
  */
468
516
  ConnectionRetryInterval?: number;
469
517
  /**
518
+ * @public
470
519
  * Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
471
520
  */
472
521
  Destination: OutputLocationRef | undefined;
473
522
  /**
523
+ * @public
474
524
  * MS Smooth event ID to be sent to the IIS server.
475
525
  *
476
526
  * Should only be specified if eventIdMode is set to useConfigured.
477
527
  */
478
528
  EventId?: string;
479
529
  /**
530
+ * @public
480
531
  * Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.
481
532
  *
482
533
  * Options:
@@ -486,38 +537,47 @@ export interface MsSmoothGroupSettings {
486
537
  */
487
538
  EventIdMode?: SmoothGroupEventIdMode | string;
488
539
  /**
540
+ * @public
489
541
  * When set to sendEos, send EOS signal to IIS server when stopping the event
490
542
  */
491
543
  EventStopBehavior?: SmoothGroupEventStopBehavior | string;
492
544
  /**
545
+ * @public
493
546
  * Size in seconds of file cache for streaming outputs.
494
547
  */
495
548
  FilecacheDuration?: number;
496
549
  /**
550
+ * @public
497
551
  * Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
498
552
  */
499
553
  FragmentLength?: number;
500
554
  /**
555
+ * @public
501
556
  * Parameter that control output group behavior on input loss.
502
557
  */
503
558
  InputLossAction?: InputLossActionForMsSmoothOut | string;
504
559
  /**
560
+ * @public
505
561
  * Number of retry attempts.
506
562
  */
507
563
  NumRetries?: number;
508
564
  /**
565
+ * @public
509
566
  * Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
510
567
  */
511
568
  RestartDelay?: number;
512
569
  /**
570
+ * @public
513
571
  * useInputSegmentation has been deprecated. The configured segment size is always used.
514
572
  */
515
573
  SegmentationMode?: SmoothGroupSegmentationMode | string;
516
574
  /**
575
+ * @public
517
576
  * Number of milliseconds to delay the output from the second pipeline.
518
577
  */
519
578
  SendDelayMs?: number;
520
579
  /**
580
+ * @public
521
581
  * Identifies the type of data to place in the sparse track:
522
582
  * - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment.
523
583
  * - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment.
@@ -525,14 +585,17 @@ export interface MsSmoothGroupSettings {
525
585
  */
526
586
  SparseTrackType?: SmoothGroupSparseTrackType | string;
527
587
  /**
588
+ * @public
528
589
  * When set to send, send stream manifest so publishing point doesn't start until all streams start.
529
590
  */
530
591
  StreamManifestBehavior?: SmoothGroupStreamManifestBehavior | string;
531
592
  /**
593
+ * @public
532
594
  * Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
533
595
  */
534
596
  TimestampOffset?: string;
535
597
  /**
598
+ * @public
536
599
  * Type of timestamp date offset to use.
537
600
  * - useEventStartDate: Use the date the event was started as the offset
538
601
  * - useConfiguredOffset: Use an explicitly configured date as the offset
@@ -611,26 +674,32 @@ export type InputLossActionForRtmpOut = (typeof InputLossActionForRtmpOut)[keyof
611
674
  */
612
675
  export interface RtmpGroupSettings {
613
676
  /**
677
+ * @public
614
678
  * Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream.
615
679
  */
616
680
  AdMarkers?: (RtmpAdMarkers | string)[];
617
681
  /**
682
+ * @public
618
683
  * Authentication scheme to use when connecting with CDN
619
684
  */
620
685
  AuthenticationScheme?: AuthenticationScheme | string;
621
686
  /**
687
+ * @public
622
688
  * Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again.
623
689
  */
624
690
  CacheFullBehavior?: RtmpCacheFullBehavior | string;
625
691
  /**
692
+ * @public
626
693
  * Cache length, in seconds, is used to calculate buffer size.
627
694
  */
628
695
  CacheLength?: number;
629
696
  /**
697
+ * @public
630
698
  * Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.
631
699
  */
632
700
  CaptionData?: RtmpCaptionData | string;
633
701
  /**
702
+ * @public
634
703
  * Controls the behavior of this RTMP group if input becomes unavailable.
635
704
  *
636
705
  * - emitOutput: Emit a slate until input returns.
@@ -638,6 +707,7 @@ export interface RtmpGroupSettings {
638
707
  */
639
708
  InputLossAction?: InputLossActionForRtmpOut | string;
640
709
  /**
710
+ * @public
641
711
  * If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
642
712
  */
643
713
  RestartDelay?: number;
@@ -674,14 +744,17 @@ export type UdpTimedMetadataId3Frame = (typeof UdpTimedMetadataId3Frame)[keyof t
674
744
  */
675
745
  export interface UdpGroupSettings {
676
746
  /**
747
+ * @public
677
748
  * Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video.
678
749
  */
679
750
  InputLossAction?: InputLossActionForUdpOut | string;
680
751
  /**
752
+ * @public
681
753
  * Indicates ID3 frame that has the timecode.
682
754
  */
683
755
  TimedMetadataId3Frame?: UdpTimedMetadataId3Frame | string;
684
756
  /**
757
+ * @public
685
758
  * Timed Metadata interval in seconds.
686
759
  */
687
760
  TimedMetadataId3Period?: number;
@@ -692,34 +765,42 @@ export interface UdpGroupSettings {
692
765
  */
693
766
  export interface OutputGroupSettings {
694
767
  /**
768
+ * @public
695
769
  * Archive Group Settings
696
770
  */
697
771
  ArchiveGroupSettings?: ArchiveGroupSettings;
698
772
  /**
773
+ * @public
699
774
  * Frame Capture Group Settings
700
775
  */
701
776
  FrameCaptureGroupSettings?: FrameCaptureGroupSettings;
702
777
  /**
778
+ * @public
703
779
  * Hls Group Settings
704
780
  */
705
781
  HlsGroupSettings?: HlsGroupSettings;
706
782
  /**
783
+ * @public
707
784
  * Media Package Group Settings
708
785
  */
709
786
  MediaPackageGroupSettings?: MediaPackageGroupSettings;
710
787
  /**
788
+ * @public
711
789
  * Ms Smooth Group Settings
712
790
  */
713
791
  MsSmoothGroupSettings?: MsSmoothGroupSettings;
714
792
  /**
793
+ * @public
715
794
  * Multiplex Group Settings
716
795
  */
717
796
  MultiplexGroupSettings?: MultiplexGroupSettings;
718
797
  /**
798
+ * @public
719
799
  * Rtmp Group Settings
720
800
  */
721
801
  RtmpGroupSettings?: RtmpGroupSettings;
722
802
  /**
803
+ * @public
723
804
  * Udp Group Settings
724
805
  */
725
806
  UdpGroupSettings?: UdpGroupSettings;
@@ -730,14 +811,17 @@ export interface OutputGroupSettings {
730
811
  */
731
812
  export interface OutputGroup {
732
813
  /**
814
+ * @public
733
815
  * Custom output group name optionally defined by the user.
734
816
  */
735
817
  Name?: string;
736
818
  /**
819
+ * @public
737
820
  * Settings associated with the output group.
738
821
  */
739
822
  OutputGroupSettings: OutputGroupSettings | undefined;
740
823
  /**
824
+ * @public
741
825
  * Placeholder documentation for __listOfOutput
742
826
  */
743
827
  Outputs: Output[] | undefined;
@@ -748,22 +832,27 @@ export interface OutputGroup {
748
832
  */
749
833
  export interface PipelineDetail {
750
834
  /**
835
+ * @public
751
836
  * The name of the active input attachment currently being ingested by this pipeline.
752
837
  */
753
838
  ActiveInputAttachmentName?: string;
754
839
  /**
840
+ * @public
755
841
  * The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.
756
842
  */
757
843
  ActiveInputSwitchActionName?: string;
758
844
  /**
845
+ * @public
759
846
  * The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline.
760
847
  */
761
848
  ActiveMotionGraphicsActionName?: string;
762
849
  /**
850
+ * @public
763
851
  * The current URI being used for HTML5 motion graphics for this pipeline.
764
852
  */
765
853
  ActiveMotionGraphicsUri?: string;
766
854
  /**
855
+ * @public
767
856
  * Pipeline ID
768
857
  */
769
858
  PipelineId?: string;
@@ -786,6 +875,7 @@ export type PipelineId = (typeof PipelineId)[keyof typeof PipelineId];
786
875
  */
787
876
  export interface PipelinePauseStateSettings {
788
877
  /**
878
+ * @public
789
879
  * Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").
790
880
  */
791
881
  PipelineId: PipelineId | string | undefined;
@@ -809,10 +899,12 @@ export type ReservationAutomaticRenewal = (typeof ReservationAutomaticRenewal)[k
809
899
  */
810
900
  export interface RenewalSettings {
811
901
  /**
902
+ * @public
812
903
  * Automatic renewal status for the reservation
813
904
  */
814
905
  AutomaticRenewal?: ReservationAutomaticRenewal | string;
815
906
  /**
907
+ * @public
816
908
  * Count for the reservation renewal
817
909
  */
818
910
  RenewalCount?: number;
@@ -837,78 +929,97 @@ export type ReservationState = (typeof ReservationState)[keyof typeof Reservatio
837
929
  */
838
930
  export interface Reservation {
839
931
  /**
932
+ * @public
840
933
  * Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
841
934
  */
842
935
  Arn?: string;
843
936
  /**
937
+ * @public
844
938
  * Number of reserved resources
845
939
  */
846
940
  Count?: number;
847
941
  /**
942
+ * @public
848
943
  * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
849
944
  */
850
945
  CurrencyCode?: string;
851
946
  /**
947
+ * @public
852
948
  * Lease duration, e.g. '12'
853
949
  */
854
950
  Duration?: number;
855
951
  /**
952
+ * @public
856
953
  * Units for duration, e.g. 'MONTHS'
857
954
  */
858
955
  DurationUnits?: OfferingDurationUnits | string;
859
956
  /**
957
+ * @public
860
958
  * Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
861
959
  */
862
960
  End?: string;
863
961
  /**
962
+ * @public
864
963
  * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
865
964
  */
866
965
  FixedPrice?: number;
867
966
  /**
967
+ * @public
868
968
  * User specified reservation name
869
969
  */
870
970
  Name?: string;
871
971
  /**
972
+ * @public
872
973
  * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
873
974
  */
874
975
  OfferingDescription?: string;
875
976
  /**
977
+ * @public
876
978
  * Unique offering ID, e.g. '87654321'
877
979
  */
878
980
  OfferingId?: string;
879
981
  /**
982
+ * @public
880
983
  * Offering type, e.g. 'NO_UPFRONT'
881
984
  */
882
985
  OfferingType?: OfferingType | string;
883
986
  /**
987
+ * @public
884
988
  * AWS region, e.g. 'us-west-2'
885
989
  */
886
990
  Region?: string;
887
991
  /**
992
+ * @public
888
993
  * Renewal settings for the reservation
889
994
  */
890
995
  RenewalSettings?: RenewalSettings;
891
996
  /**
997
+ * @public
892
998
  * Unique reservation ID, e.g. '1234567'
893
999
  */
894
1000
  ReservationId?: string;
895
1001
  /**
1002
+ * @public
896
1003
  * Resource configuration details
897
1004
  */
898
1005
  ResourceSpecification?: ReservationResourceSpecification;
899
1006
  /**
1007
+ * @public
900
1008
  * Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
901
1009
  */
902
1010
  Start?: string;
903
1011
  /**
1012
+ * @public
904
1013
  * Current state of reservation, e.g. 'ACTIVE'
905
1014
  */
906
1015
  State?: ReservationState | string;
907
1016
  /**
1017
+ * @public
908
1018
  * A collection of key-value pairs
909
1019
  */
910
1020
  Tags?: Record<string, string>;
911
1021
  /**
1022
+ * @public
912
1023
  * Recurring usage charge for each reserved resource, e.g. '157.0'
913
1024
  */
914
1025
  UsagePrice?: number;
@@ -919,10 +1030,12 @@ export interface Reservation {
919
1030
  */
920
1031
  export interface HlsId3SegmentTaggingScheduleActionSettings {
921
1032
  /**
1033
+ * @public
922
1034
  * ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html
923
1035
  */
924
1036
  Tag?: string;
925
1037
  /**
1038
+ * @public
926
1039
  * Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure
927
1040
  */
928
1041
  Id3?: string;
@@ -933,6 +1046,7 @@ export interface HlsId3SegmentTaggingScheduleActionSettings {
933
1046
  */
934
1047
  export interface HlsTimedMetadataScheduleActionSettings {
935
1048
  /**
1049
+ * @public
936
1050
  * Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure
937
1051
  */
938
1052
  Id3: string | undefined;
@@ -955,6 +1069,7 @@ export type InputTimecodeSource = (typeof InputTimecodeSource)[keyof typeof Inpu
955
1069
  */
956
1070
  export interface StartTimecode {
957
1071
  /**
1072
+ * @public
958
1073
  * The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
959
1074
  */
960
1075
  Timecode?: string;
@@ -977,10 +1092,12 @@ export type LastFrameClippingBehavior = (typeof LastFrameClippingBehavior)[keyof
977
1092
  */
978
1093
  export interface StopTimecode {
979
1094
  /**
1095
+ * @public
980
1096
  * If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.
981
1097
  */
982
1098
  LastFrameClippingBehavior?: LastFrameClippingBehavior | string;
983
1099
  /**
1100
+ * @public
984
1101
  * The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.
985
1102
  */
986
1103
  Timecode?: string;
@@ -991,14 +1108,17 @@ export interface StopTimecode {
991
1108
  */
992
1109
  export interface InputClippingSettings {
993
1110
  /**
1111
+ * @public
994
1112
  * The source of the timecodes in the source being clipped.
995
1113
  */
996
1114
  InputTimecodeSource: InputTimecodeSource | string | undefined;
997
1115
  /**
1116
+ * @public
998
1117
  * Settings to identify the start of the clip.
999
1118
  */
1000
1119
  StartTimecode?: StartTimecode;
1001
1120
  /**
1121
+ * @public
1002
1122
  * Settings to identify the end of the clip.
1003
1123
  */
1004
1124
  StopTimecode?: StopTimecode;
@@ -1009,14 +1129,17 @@ export interface InputClippingSettings {
1009
1129
  */
1010
1130
  export interface InputPrepareScheduleActionSettings {
1011
1131
  /**
1132
+ * @public
1012
1133
  * The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated.
1013
1134
  */
1014
1135
  InputAttachmentNameReference?: string;
1015
1136
  /**
1137
+ * @public
1016
1138
  * Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.
1017
1139
  */
1018
1140
  InputClippingSettings?: InputClippingSettings;
1019
1141
  /**
1142
+ * @public
1020
1143
  * The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.
1021
1144
  */
1022
1145
  UrlPath?: string[];
@@ -1027,14 +1150,17 @@ export interface InputPrepareScheduleActionSettings {
1027
1150
  */
1028
1151
  export interface InputSwitchScheduleActionSettings {
1029
1152
  /**
1153
+ * @public
1030
1154
  * The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration.
1031
1155
  */
1032
1156
  InputAttachmentNameReference: string | undefined;
1033
1157
  /**
1158
+ * @public
1034
1159
  * Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.
1035
1160
  */
1036
1161
  InputClippingSettings?: InputClippingSettings;
1037
1162
  /**
1163
+ * @public
1038
1164
  * The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source.
1039
1165
  */
1040
1166
  UrlPath?: string[];
@@ -1045,18 +1171,22 @@ export interface InputSwitchScheduleActionSettings {
1045
1171
  */
1046
1172
  export interface MotionGraphicsActivateScheduleActionSettings {
1047
1173
  /**
1174
+ * @public
1048
1175
  * Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed.
1049
1176
  */
1050
1177
  Duration?: number;
1051
1178
  /**
1179
+ * @public
1052
1180
  * Key used to extract the password from EC2 Parameter store
1053
1181
  */
1054
1182
  PasswordParam?: string;
1055
1183
  /**
1184
+ * @public
1056
1185
  * URI of the HTML5 content to be rendered into the live stream.
1057
1186
  */
1058
1187
  Url?: string;
1059
1188
  /**
1189
+ * @public
1060
1190
  * Documentation update needed
1061
1191
  */
1062
1192
  Username?: string;
@@ -1073,6 +1203,7 @@ export interface MotionGraphicsDeactivateScheduleActionSettings {
1073
1203
  */
1074
1204
  export interface PauseStateScheduleActionSettings {
1075
1205
  /**
1206
+ * @public
1076
1207
  * Placeholder documentation for __listOfPipelinePauseStateSettings
1077
1208
  */
1078
1209
  Pipelines?: PipelinePauseStateSettings[];
@@ -1095,10 +1226,12 @@ export type Scte35InputMode = (typeof Scte35InputMode)[keyof typeof Scte35InputM
1095
1226
  */
1096
1227
  export interface Scte35InputScheduleActionSettings {
1097
1228
  /**
1229
+ * @public
1098
1230
  * In fixed mode, enter the name of the input attachment that you want to use as a SCTE-35 input. (Don't enter the ID of the input.)"
1099
1231
  */
1100
1232
  InputAttachmentNameReference?: string;
1101
1233
  /**
1234
+ * @public
1102
1235
  * Whether the SCTE-35 input should be the active input or a fixed input.
1103
1236
  */
1104
1237
  Mode: Scte35InputMode | string | undefined;
@@ -1109,6 +1242,7 @@ export interface Scte35InputScheduleActionSettings {
1109
1242
  */
1110
1243
  export interface Scte35ReturnToNetworkScheduleActionSettings {
1111
1244
  /**
1245
+ * @public
1112
1246
  * The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
1113
1247
  */
1114
1248
  SpliceEventId: number | undefined;
@@ -1119,10 +1253,12 @@ export interface Scte35ReturnToNetworkScheduleActionSettings {
1119
1253
  */
1120
1254
  export interface Scte35SpliceInsertScheduleActionSettings {
1121
1255
  /**
1256
+ * @public
1122
1257
  * Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.
1123
1258
  */
1124
1259
  Duration?: number;
1125
1260
  /**
1261
+ * @public
1126
1262
  * The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
1127
1263
  */
1128
1264
  SpliceEventId: number | undefined;
@@ -1183,18 +1319,22 @@ export type Scte35WebDeliveryAllowedFlag = (typeof Scte35WebDeliveryAllowedFlag)
1183
1319
  */
1184
1320
  export interface Scte35DeliveryRestrictions {
1185
1321
  /**
1322
+ * @public
1186
1323
  * Corresponds to SCTE-35 archive_allowed_flag.
1187
1324
  */
1188
1325
  ArchiveAllowedFlag: Scte35ArchiveAllowedFlag | string | undefined;
1189
1326
  /**
1327
+ * @public
1190
1328
  * Corresponds to SCTE-35 device_restrictions parameter.
1191
1329
  */
1192
1330
  DeviceRestrictions: Scte35DeviceRestrictions | string | undefined;
1193
1331
  /**
1332
+ * @public
1194
1333
  * Corresponds to SCTE-35 no_regional_blackout_flag parameter.
1195
1334
  */
1196
1335
  NoRegionalBlackoutFlag: Scte35NoRegionalBlackoutFlag | string | undefined;
1197
1336
  /**
1337
+ * @public
1198
1338
  * Corresponds to SCTE-35 web_delivery_allowed_flag parameter.
1199
1339
  */
1200
1340
  WebDeliveryAllowedFlag: Scte35WebDeliveryAllowedFlag | string | undefined;
@@ -1217,46 +1357,57 @@ export type Scte35SegmentationCancelIndicator = (typeof Scte35SegmentationCancel
1217
1357
  */
1218
1358
  export interface Scte35SegmentationDescriptor {
1219
1359
  /**
1360
+ * @public
1220
1361
  * Holds the four SCTE-35 delivery restriction parameters.
1221
1362
  */
1222
1363
  DeliveryRestrictions?: Scte35DeliveryRestrictions;
1223
1364
  /**
1365
+ * @public
1224
1366
  * Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
1225
1367
  */
1226
1368
  SegmentNum?: number;
1227
1369
  /**
1370
+ * @public
1228
1371
  * Corresponds to SCTE-35 segmentation_event_cancel_indicator.
1229
1372
  */
1230
1373
  SegmentationCancelIndicator: Scte35SegmentationCancelIndicator | string | undefined;
1231
1374
  /**
1375
+ * @public
1232
1376
  * Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
1233
1377
  */
1234
1378
  SegmentationDuration?: number;
1235
1379
  /**
1380
+ * @public
1236
1381
  * Corresponds to SCTE-35 segmentation_event_id.
1237
1382
  */
1238
1383
  SegmentationEventId: number | undefined;
1239
1384
  /**
1385
+ * @public
1240
1386
  * Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
1241
1387
  */
1242
1388
  SegmentationTypeId?: number;
1243
1389
  /**
1390
+ * @public
1244
1391
  * Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
1245
1392
  */
1246
1393
  SegmentationUpid?: string;
1247
1394
  /**
1395
+ * @public
1248
1396
  * Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
1249
1397
  */
1250
1398
  SegmentationUpidType?: number;
1251
1399
  /**
1400
+ * @public
1252
1401
  * Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
1253
1402
  */
1254
1403
  SegmentsExpected?: number;
1255
1404
  /**
1405
+ * @public
1256
1406
  * Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
1257
1407
  */
1258
1408
  SubSegmentNum?: number;
1259
1409
  /**
1410
+ * @public
1260
1411
  * Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
1261
1412
  */
1262
1413
  SubSegmentsExpected?: number;
@@ -1267,6 +1418,7 @@ export interface Scte35SegmentationDescriptor {
1267
1418
  */
1268
1419
  export interface Scte35DescriptorSettings {
1269
1420
  /**
1421
+ * @public
1270
1422
  * SCTE-35 Segmentation Descriptor.
1271
1423
  */
1272
1424
  SegmentationDescriptorScte35DescriptorSettings: Scte35SegmentationDescriptor | undefined;
@@ -1277,6 +1429,7 @@ export interface Scte35DescriptorSettings {
1277
1429
  */
1278
1430
  export interface Scte35Descriptor {
1279
1431
  /**
1432
+ * @public
1280
1433
  * SCTE-35 Descriptor Settings.
1281
1434
  */
1282
1435
  Scte35DescriptorSettings: Scte35DescriptorSettings | undefined;
@@ -1287,6 +1440,7 @@ export interface Scte35Descriptor {
1287
1440
  */
1288
1441
  export interface Scte35TimeSignalScheduleActionSettings {
1289
1442
  /**
1443
+ * @public
1290
1444
  * The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
1291
1445
  */
1292
1446
  Scte35Descriptors: Scte35Descriptor[] | undefined;
@@ -1297,42 +1451,52 @@ export interface Scte35TimeSignalScheduleActionSettings {
1297
1451
  */
1298
1452
  export interface StaticImageActivateScheduleActionSettings {
1299
1453
  /**
1454
+ * @public
1300
1455
  * The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.
1301
1456
  */
1302
1457
  Duration?: number;
1303
1458
  /**
1459
+ * @public
1304
1460
  * The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).
1305
1461
  */
1306
1462
  FadeIn?: number;
1307
1463
  /**
1464
+ * @public
1308
1465
  * Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).
1309
1466
  */
1310
1467
  FadeOut?: number;
1311
1468
  /**
1469
+ * @public
1312
1470
  * The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.
1313
1471
  */
1314
1472
  Height?: number;
1315
1473
  /**
1474
+ * @public
1316
1475
  * The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.
1317
1476
  */
1318
1477
  Image: InputLocation | undefined;
1319
1478
  /**
1479
+ * @public
1320
1480
  * Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.
1321
1481
  */
1322
1482
  ImageX?: number;
1323
1483
  /**
1484
+ * @public
1324
1485
  * Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.
1325
1486
  */
1326
1487
  ImageY?: number;
1327
1488
  /**
1489
+ * @public
1328
1490
  * The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.
1329
1491
  */
1330
1492
  Layer?: number;
1331
1493
  /**
1494
+ * @public
1332
1495
  * Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
1333
1496
  */
1334
1497
  Opacity?: number;
1335
1498
  /**
1499
+ * @public
1336
1500
  * The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
1337
1501
  */
1338
1502
  Width?: number;
@@ -1343,10 +1507,12 @@ export interface StaticImageActivateScheduleActionSettings {
1343
1507
  */
1344
1508
  export interface StaticImageDeactivateScheduleActionSettings {
1345
1509
  /**
1510
+ * @public
1346
1511
  * The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
1347
1512
  */
1348
1513
  FadeOut?: number;
1349
1514
  /**
1515
+ * @public
1350
1516
  * The image overlay layer to deactivate, 0 to 7. Default is 0.
1351
1517
  */
1352
1518
  Layer?: number;
@@ -1357,54 +1523,67 @@ export interface StaticImageDeactivateScheduleActionSettings {
1357
1523
  */
1358
1524
  export interface ScheduleActionSettings {
1359
1525
  /**
1526
+ * @public
1360
1527
  * Action to insert HLS ID3 segment tagging
1361
1528
  */
1362
1529
  HlsId3SegmentTaggingSettings?: HlsId3SegmentTaggingScheduleActionSettings;
1363
1530
  /**
1531
+ * @public
1364
1532
  * Action to insert HLS metadata
1365
1533
  */
1366
1534
  HlsTimedMetadataSettings?: HlsTimedMetadataScheduleActionSettings;
1367
1535
  /**
1536
+ * @public
1368
1537
  * Action to prepare an input for a future immediate input switch
1369
1538
  */
1370
1539
  InputPrepareSettings?: InputPrepareScheduleActionSettings;
1371
1540
  /**
1541
+ * @public
1372
1542
  * Action to switch the input
1373
1543
  */
1374
1544
  InputSwitchSettings?: InputSwitchScheduleActionSettings;
1375
1545
  /**
1546
+ * @public
1376
1547
  * Action to activate a motion graphics image overlay
1377
1548
  */
1378
1549
  MotionGraphicsImageActivateSettings?: MotionGraphicsActivateScheduleActionSettings;
1379
1550
  /**
1551
+ * @public
1380
1552
  * Action to deactivate a motion graphics image overlay
1381
1553
  */
1382
1554
  MotionGraphicsImageDeactivateSettings?: MotionGraphicsDeactivateScheduleActionSettings;
1383
1555
  /**
1556
+ * @public
1384
1557
  * Action to pause or unpause one or both channel pipelines
1385
1558
  */
1386
1559
  PauseStateSettings?: PauseStateScheduleActionSettings;
1387
1560
  /**
1561
+ * @public
1388
1562
  * Action to specify scte35 input
1389
1563
  */
1390
1564
  Scte35InputSettings?: Scte35InputScheduleActionSettings;
1391
1565
  /**
1566
+ * @public
1392
1567
  * Action to insert SCTE-35 return_to_network message
1393
1568
  */
1394
1569
  Scte35ReturnToNetworkSettings?: Scte35ReturnToNetworkScheduleActionSettings;
1395
1570
  /**
1571
+ * @public
1396
1572
  * Action to insert SCTE-35 splice_insert message
1397
1573
  */
1398
1574
  Scte35SpliceInsertSettings?: Scte35SpliceInsertScheduleActionSettings;
1399
1575
  /**
1576
+ * @public
1400
1577
  * Action to insert SCTE-35 time_signal message
1401
1578
  */
1402
1579
  Scte35TimeSignalSettings?: Scte35TimeSignalScheduleActionSettings;
1403
1580
  /**
1581
+ * @public
1404
1582
  * Action to activate a static image overlay
1405
1583
  */
1406
1584
  StaticImageActivateSettings?: StaticImageActivateScheduleActionSettings;
1407
1585
  /**
1586
+ * @public
1408
1587
  * Action to deactivate a static image overlay
1409
1588
  */
1410
1589
  StaticImageDeactivateSettings?: StaticImageDeactivateScheduleActionSettings;
@@ -1415,6 +1594,7 @@ export interface ScheduleActionSettings {
1415
1594
  */
1416
1595
  export interface FixedModeScheduleActionStartSettings {
1417
1596
  /**
1597
+ * @public
1418
1598
  * Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
1419
1599
  */
1420
1600
  Time: string | undefined;
@@ -1437,10 +1617,12 @@ export type FollowPoint = (typeof FollowPoint)[keyof typeof FollowPoint];
1437
1617
  */
1438
1618
  export interface FollowModeScheduleActionStartSettings {
1439
1619
  /**
1620
+ * @public
1440
1621
  * Identifies whether this action starts relative to the start or relative to the end of the reference action.
1441
1622
  */
1442
1623
  FollowPoint: FollowPoint | string | undefined;
1443
1624
  /**
1625
+ * @public
1444
1626
  * The action name of another action that this one refers to.
1445
1627
  */
1446
1628
  ReferenceActionName: string | undefined;
@@ -1457,14 +1639,17 @@ export interface ImmediateModeScheduleActionStartSettings {
1457
1639
  */
1458
1640
  export interface ScheduleActionStartSettings {
1459
1641
  /**
1642
+ * @public
1460
1643
  * Option for specifying the start time for an action.
1461
1644
  */
1462
1645
  FixedModeScheduleActionStartSettings?: FixedModeScheduleActionStartSettings;
1463
1646
  /**
1647
+ * @public
1464
1648
  * Option for specifying an action as relative to another action.
1465
1649
  */
1466
1650
  FollowModeScheduleActionStartSettings?: FollowModeScheduleActionStartSettings;
1467
1651
  /**
1652
+ * @public
1468
1653
  * Option for specifying an action that should be applied immediately.
1469
1654
  */
1470
1655
  ImmediateModeScheduleActionStartSettings?: ImmediateModeScheduleActionStartSettings;
@@ -1475,14 +1660,17 @@ export interface ScheduleActionStartSettings {
1475
1660
  */
1476
1661
  export interface ScheduleAction {
1477
1662
  /**
1663
+ * @public
1478
1664
  * The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.
1479
1665
  */
1480
1666
  ActionName: string | undefined;
1481
1667
  /**
1668
+ * @public
1482
1669
  * Settings for this schedule action.
1483
1670
  */
1484
1671
  ScheduleActionSettings: ScheduleActionSettings | undefined;
1485
1672
  /**
1673
+ * @public
1486
1674
  * The time for the action to start in the channel.
1487
1675
  */
1488
1676
  ScheduleActionStartSettings: ScheduleActionStartSettings | undefined;
@@ -1505,18 +1693,22 @@ export type ThumbnailType = (typeof ThumbnailType)[keyof typeof ThumbnailType];
1505
1693
  */
1506
1694
  export interface Thumbnail {
1507
1695
  /**
1696
+ * @public
1508
1697
  * The binary data for the latest thumbnail.
1509
1698
  */
1510
1699
  Body?: string;
1511
1700
  /**
1701
+ * @public
1512
1702
  * The content type for the latest thumbnail.
1513
1703
  */
1514
1704
  ContentType?: string;
1515
1705
  /**
1706
+ * @public
1516
1707
  * Thumbnail Type
1517
1708
  */
1518
1709
  ThumbnailType?: ThumbnailType | string;
1519
1710
  /**
1711
+ * @public
1520
1712
  * Time stamp for the latest thumbnail.
1521
1713
  */
1522
1714
  TimeStamp?: Date;
@@ -1527,10 +1719,12 @@ export interface Thumbnail {
1527
1719
  */
1528
1720
  export interface ThumbnailDetail {
1529
1721
  /**
1722
+ * @public
1530
1723
  * Pipeline ID
1531
1724
  */
1532
1725
  PipelineId?: string;
1533
1726
  /**
1727
+ * @public
1534
1728
  * thumbnails of a single pipeline
1535
1729
  */
1536
1730
  Thumbnails?: Thumbnail[];
@@ -1553,18 +1747,22 @@ export type InputDeviceTransferType = (typeof InputDeviceTransferType)[keyof typ
1553
1747
  */
1554
1748
  export interface TransferringInputDeviceSummary {
1555
1749
  /**
1750
+ * @public
1556
1751
  * The unique ID of the input device.
1557
1752
  */
1558
1753
  Id?: string;
1559
1754
  /**
1755
+ * @public
1560
1756
  * The optional message that the sender has attached to the transfer.
1561
1757
  */
1562
1758
  Message?: string;
1563
1759
  /**
1760
+ * @public
1564
1761
  * The AWS account ID for the recipient of the input device transfer.
1565
1762
  */
1566
1763
  TargetCustomerId?: string;
1567
1764
  /**
1765
+ * @public
1568
1766
  * The type (direction) of the input device transfer.
1569
1767
  */
1570
1768
  TransferType?: InputDeviceTransferType | string;
@@ -1575,10 +1773,12 @@ export interface TransferringInputDeviceSummary {
1575
1773
  */
1576
1774
  export interface ValidationError {
1577
1775
  /**
1776
+ * @public
1578
1777
  * Path to the source of the error.
1579
1778
  */
1580
1779
  ElementPath?: string;
1581
1780
  /**
1781
+ * @public
1582
1782
  * The error message.
1583
1783
  */
1584
1784
  ErrorMessage?: string;
@@ -1634,14 +1834,17 @@ export type TimecodeBurninPosition = (typeof TimecodeBurninPosition)[keyof typeo
1634
1834
  */
1635
1835
  export interface TimecodeBurninSettings {
1636
1836
  /**
1837
+ * @public
1637
1838
  * Choose a timecode burn-in font size
1638
1839
  */
1639
1840
  FontSize: TimecodeBurninFontSize | string | undefined;
1640
1841
  /**
1842
+ * @public
1641
1843
  * Choose a timecode burn-in output position
1642
1844
  */
1643
1845
  Position: TimecodeBurninPosition | string | undefined;
1644
1846
  /**
1847
+ * @public
1645
1848
  * Create a timecode burn-in prefix (optional)
1646
1849
  */
1647
1850
  Prefix?: string;
@@ -1652,14 +1855,17 @@ export interface TimecodeBurninSettings {
1652
1855
  */
1653
1856
  export interface FrameCaptureSettings {
1654
1857
  /**
1858
+ * @public
1655
1859
  * The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.
1656
1860
  */
1657
1861
  CaptureInterval?: number;
1658
1862
  /**
1863
+ * @public
1659
1864
  * Unit for the frame capture interval.
1660
1865
  */
1661
1866
  CaptureIntervalUnits?: FrameCaptureIntervalUnit | string;
1662
1867
  /**
1868
+ * @public
1663
1869
  * Timecode burn-in settings
1664
1870
  */
1665
1871
  TimecodeBurninSettings?: TimecodeBurninSettings;
@@ -1730,14 +1936,17 @@ export interface Rec709Settings {
1730
1936
  */
1731
1937
  export interface H264ColorSpaceSettings {
1732
1938
  /**
1939
+ * @public
1733
1940
  * Passthrough applies no color space conversion to the output
1734
1941
  */
1735
1942
  ColorSpacePassthroughSettings?: ColorSpacePassthroughSettings;
1736
1943
  /**
1944
+ * @public
1737
1945
  * Rec601 Settings
1738
1946
  */
1739
1947
  Rec601Settings?: Rec601Settings;
1740
1948
  /**
1949
+ * @public
1741
1950
  * Rec709 Settings
1742
1951
  */
1743
1952
  Rec709Settings?: Rec709Settings;
@@ -1800,12 +2009,14 @@ export type TemporalFilterStrength = (typeof TemporalFilterStrength)[keyof typeo
1800
2009
  */
1801
2010
  export interface TemporalFilterSettings {
1802
2011
  /**
2012
+ * @public
1803
2013
  * If you enable this filter, the results are the following:
1804
2014
  * - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source.
1805
2015
  * - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.
1806
2016
  */
1807
2017
  PostFilterSharpening?: TemporalFilterPostFilterSharpening | string;
1808
2018
  /**
2019
+ * @public
1809
2020
  * Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.
1810
2021
  */
1811
2022
  Strength?: TemporalFilterStrength | string;
@@ -1816,6 +2027,7 @@ export interface TemporalFilterSettings {
1816
2027
  */
1817
2028
  export interface H264FilterSettings {
1818
2029
  /**
2030
+ * @public
1819
2031
  * Temporal Filter Settings
1820
2032
  */
1821
2033
  TemporalFilterSettings?: TemporalFilterSettings;
@@ -2085,134 +2297,165 @@ export type H264TimecodeInsertionBehavior = (typeof H264TimecodeInsertionBehavio
2085
2297
  */
2086
2298
  export interface H264Settings {
2087
2299
  /**
2300
+ * @public
2088
2301
  * Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.
2089
2302
  */
2090
2303
  AdaptiveQuantization?: H264AdaptiveQuantization | string;
2091
2304
  /**
2305
+ * @public
2092
2306
  * Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
2093
2307
  */
2094
2308
  AfdSignaling?: AfdSignaling | string;
2095
2309
  /**
2310
+ * @public
2096
2311
  * Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
2097
2312
  */
2098
2313
  Bitrate?: number;
2099
2314
  /**
2315
+ * @public
2100
2316
  * Percentage of the buffer that should initially be filled (HRD buffer model).
2101
2317
  */
2102
2318
  BufFillPct?: number;
2103
2319
  /**
2320
+ * @public
2104
2321
  * Size of buffer (HRD buffer model) in bits.
2105
2322
  */
2106
2323
  BufSize?: number;
2107
2324
  /**
2325
+ * @public
2108
2326
  * Includes colorspace metadata in the output.
2109
2327
  */
2110
2328
  ColorMetadata?: H264ColorMetadata | string;
2111
2329
  /**
2330
+ * @public
2112
2331
  * Color Space settings
2113
2332
  */
2114
2333
  ColorSpaceSettings?: H264ColorSpaceSettings;
2115
2334
  /**
2335
+ * @public
2116
2336
  * Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.
2117
2337
  */
2118
2338
  EntropyEncoding?: H264EntropyEncoding | string;
2119
2339
  /**
2340
+ * @public
2120
2341
  * Optional filters that you can apply to an encode.
2121
2342
  */
2122
2343
  FilterSettings?: H264FilterSettings;
2123
2344
  /**
2345
+ * @public
2124
2346
  * Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
2125
2347
  */
2126
2348
  FixedAfd?: FixedAfd | string;
2127
2349
  /**
2350
+ * @public
2128
2351
  * Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.
2129
2352
  */
2130
2353
  FlickerAq?: H264FlickerAq | string;
2131
2354
  /**
2355
+ * @public
2132
2356
  * This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.)
2133
2357
  * enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately.
2134
2358
  * disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.
2135
2359
  */
2136
2360
  ForceFieldPictures?: H264ForceFieldPictures | string;
2137
2361
  /**
2362
+ * @public
2138
2363
  * This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input.
2139
2364
  */
2140
2365
  FramerateControl?: H264FramerateControl | string;
2141
2366
  /**
2367
+ * @public
2142
2368
  * Framerate denominator.
2143
2369
  */
2144
2370
  FramerateDenominator?: number;
2145
2371
  /**
2372
+ * @public
2146
2373
  * Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
2147
2374
  */
2148
2375
  FramerateNumerator?: number;
2149
2376
  /**
2377
+ * @public
2150
2378
  * Documentation update needed
2151
2379
  */
2152
2380
  GopBReference?: H264GopBReference | string;
2153
2381
  /**
2382
+ * @public
2154
2383
  * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
2155
2384
  */
2156
2385
  GopClosedCadence?: number;
2157
2386
  /**
2387
+ * @public
2158
2388
  * Number of B-frames between reference frames.
2159
2389
  */
2160
2390
  GopNumBFrames?: number;
2161
2391
  /**
2392
+ * @public
2162
2393
  * GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.
2163
2394
  * If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.
2164
2395
  * If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
2165
2396
  */
2166
2397
  GopSize?: number;
2167
2398
  /**
2399
+ * @public
2168
2400
  * Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
2169
2401
  */
2170
2402
  GopSizeUnits?: H264GopSizeUnits | string;
2171
2403
  /**
2404
+ * @public
2172
2405
  * H.264 Level.
2173
2406
  */
2174
2407
  Level?: H264Level | string;
2175
2408
  /**
2409
+ * @public
2176
2410
  * Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
2177
2411
  */
2178
2412
  LookAheadRateControl?: H264LookAheadRateControl | string;
2179
2413
  /**
2414
+ * @public
2180
2415
  * For QVBR: See the tooltip for Quality level
2181
2416
  *
2182
2417
  * For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
2183
2418
  */
2184
2419
  MaxBitrate?: number;
2185
2420
  /**
2421
+ * @public
2186
2422
  * Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
2187
2423
  */
2188
2424
  MinIInterval?: number;
2189
2425
  /**
2426
+ * @public
2190
2427
  * Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
2191
2428
  */
2192
2429
  NumRefFrames?: number;
2193
2430
  /**
2431
+ * @public
2194
2432
  * This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input.
2195
2433
  */
2196
2434
  ParControl?: H264ParControl | string;
2197
2435
  /**
2436
+ * @public
2198
2437
  * Pixel Aspect Ratio denominator.
2199
2438
  */
2200
2439
  ParDenominator?: number;
2201
2440
  /**
2441
+ * @public
2202
2442
  * Pixel Aspect Ratio numerator.
2203
2443
  */
2204
2444
  ParNumerator?: number;
2205
2445
  /**
2446
+ * @public
2206
2447
  * H.264 Profile.
2207
2448
  */
2208
2449
  Profile?: H264Profile | string;
2209
2450
  /**
2451
+ * @public
2210
2452
  * Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel).
2211
2453
  * - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY.
2212
2454
  * - STANDARD_QUALITY: Valid for any Rate control mode.
2213
2455
  */
2214
2456
  QualityLevel?: H264QualityLevel | string;
2215
2457
  /**
2458
+ * @public
2216
2459
  * Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are:
2217
2460
  * - Primary screen: Quality level: 8 to 10. Max bitrate: 4M
2218
2461
  * - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M
@@ -2221,6 +2464,7 @@ export interface H264Settings {
2221
2464
  */
2222
2465
  QvbrQualityLevel?: number;
2223
2466
  /**
2467
+ * @public
2224
2468
  * Rate control mode.
2225
2469
  *
2226
2470
  * QVBR: Quality will match the specified quality level except when it is constrained by the
@@ -2238,10 +2482,12 @@ export interface H264Settings {
2238
2482
  */
2239
2483
  RateControlMode?: H264RateControlMode | string;
2240
2484
  /**
2485
+ * @public
2241
2486
  * Sets the scan type of the output to progressive or top-field-first interlaced.
2242
2487
  */
2243
2488
  ScanType?: H264ScanType | string;
2244
2489
  /**
2490
+ * @public
2245
2491
  * Scene change detection.
2246
2492
  *
2247
2493
  * - On: inserts I-frames when scene change is detected.
@@ -2249,37 +2495,45 @@ export interface H264Settings {
2249
2495
  */
2250
2496
  SceneChangeDetect?: H264SceneChangeDetect | string;
2251
2497
  /**
2498
+ * @public
2252
2499
  * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.
2253
2500
  * This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
2254
2501
  */
2255
2502
  Slices?: number;
2256
2503
  /**
2504
+ * @public
2257
2505
  * Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15.
2258
2506
  */
2259
2507
  Softness?: number;
2260
2508
  /**
2509
+ * @public
2261
2510
  * Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.
2262
2511
  */
2263
2512
  SpatialAq?: H264SpatialAq | string;
2264
2513
  /**
2514
+ * @public
2265
2515
  * If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality.
2266
2516
  */
2267
2517
  SubgopLength?: H264SubGopLength | string;
2268
2518
  /**
2519
+ * @public
2269
2520
  * Produces a bitstream compliant with SMPTE RP-2027.
2270
2521
  */
2271
2522
  Syntax?: H264Syntax | string;
2272
2523
  /**
2524
+ * @public
2273
2525
  * Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.
2274
2526
  */
2275
2527
  TemporalAq?: H264TemporalAq | string;
2276
2528
  /**
2529
+ * @public
2277
2530
  * Determines how timecodes should be inserted into the video elementary stream.
2278
2531
  * - 'disabled': Do not include timecodes
2279
2532
  * - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
2280
2533
  */
2281
2534
  TimecodeInsertion?: H264TimecodeInsertionBehavior | string;
2282
2535
  /**
2536
+ * @public
2283
2537
  * Timecode burn-in settings
2284
2538
  */
2285
2539
  TimecodeBurninSettings?: TimecodeBurninSettings;
@@ -2337,22 +2591,27 @@ export interface DolbyVision81Settings {
2337
2591
  */
2338
2592
  export interface H265ColorSpaceSettings {
2339
2593
  /**
2594
+ * @public
2340
2595
  * Passthrough applies no color space conversion to the output
2341
2596
  */
2342
2597
  ColorSpacePassthroughSettings?: ColorSpacePassthroughSettings;
2343
2598
  /**
2599
+ * @public
2344
2600
  * Dolby Vision81 Settings
2345
2601
  */
2346
2602
  DolbyVision81Settings?: DolbyVision81Settings;
2347
2603
  /**
2604
+ * @public
2348
2605
  * Hdr10 Settings
2349
2606
  */
2350
2607
  Hdr10Settings?: Hdr10Settings;
2351
2608
  /**
2609
+ * @public
2352
2610
  * Rec601 Settings
2353
2611
  */
2354
2612
  Rec601Settings?: Rec601Settings;
2355
2613
  /**
2614
+ * @public
2356
2615
  * Rec709 Settings
2357
2616
  */
2358
2617
  Rec709Settings?: Rec709Settings;
@@ -2363,6 +2622,7 @@ export interface H265ColorSpaceSettings {
2363
2622
  */
2364
2623
  export interface H265FilterSettings {
2365
2624
  /**
2625
+ * @public
2366
2626
  * Temporal Filter Settings
2367
2627
  */
2368
2628
  TemporalFilterSettings?: TemporalFilterSettings;
@@ -2507,96 +2767,119 @@ export type H265TimecodeInsertionBehavior = (typeof H265TimecodeInsertionBehavio
2507
2767
  */
2508
2768
  export interface H265Settings {
2509
2769
  /**
2770
+ * @public
2510
2771
  * Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.
2511
2772
  */
2512
2773
  AdaptiveQuantization?: H265AdaptiveQuantization | string;
2513
2774
  /**
2775
+ * @public
2514
2776
  * Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter.
2515
2777
  */
2516
2778
  AfdSignaling?: AfdSignaling | string;
2517
2779
  /**
2780
+ * @public
2518
2781
  * Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.
2519
2782
  */
2520
2783
  AlternativeTransferFunction?: H265AlternativeTransferFunction | string;
2521
2784
  /**
2785
+ * @public
2522
2786
  * Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
2523
2787
  */
2524
2788
  Bitrate?: number;
2525
2789
  /**
2790
+ * @public
2526
2791
  * Size of buffer (HRD buffer model) in bits.
2527
2792
  */
2528
2793
  BufSize?: number;
2529
2794
  /**
2795
+ * @public
2530
2796
  * Includes colorspace metadata in the output.
2531
2797
  */
2532
2798
  ColorMetadata?: H265ColorMetadata | string;
2533
2799
  /**
2800
+ * @public
2534
2801
  * Color Space settings
2535
2802
  */
2536
2803
  ColorSpaceSettings?: H265ColorSpaceSettings;
2537
2804
  /**
2805
+ * @public
2538
2806
  * Optional filters that you can apply to an encode.
2539
2807
  */
2540
2808
  FilterSettings?: H265FilterSettings;
2541
2809
  /**
2810
+ * @public
2542
2811
  * Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.
2543
2812
  */
2544
2813
  FixedAfd?: FixedAfd | string;
2545
2814
  /**
2815
+ * @public
2546
2816
  * If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.
2547
2817
  */
2548
2818
  FlickerAq?: H265FlickerAq | string;
2549
2819
  /**
2820
+ * @public
2550
2821
  * Framerate denominator.
2551
2822
  */
2552
2823
  FramerateDenominator: number | undefined;
2553
2824
  /**
2825
+ * @public
2554
2826
  * Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
2555
2827
  */
2556
2828
  FramerateNumerator: number | undefined;
2557
2829
  /**
2830
+ * @public
2558
2831
  * Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
2559
2832
  */
2560
2833
  GopClosedCadence?: number;
2561
2834
  /**
2835
+ * @public
2562
2836
  * GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits.
2563
2837
  * If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1.
2564
2838
  * If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.
2565
2839
  */
2566
2840
  GopSize?: number;
2567
2841
  /**
2842
+ * @public
2568
2843
  * Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time.
2569
2844
  */
2570
2845
  GopSizeUnits?: H265GopSizeUnits | string;
2571
2846
  /**
2847
+ * @public
2572
2848
  * H.265 Level.
2573
2849
  */
2574
2850
  Level?: H265Level | string;
2575
2851
  /**
2852
+ * @public
2576
2853
  * Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.
2577
2854
  */
2578
2855
  LookAheadRateControl?: H265LookAheadRateControl | string;
2579
2856
  /**
2857
+ * @public
2580
2858
  * For QVBR: See the tooltip for Quality level
2581
2859
  */
2582
2860
  MaxBitrate?: number;
2583
2861
  /**
2862
+ * @public
2584
2863
  * Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
2585
2864
  */
2586
2865
  MinIInterval?: number;
2587
2866
  /**
2867
+ * @public
2588
2868
  * Pixel Aspect Ratio denominator.
2589
2869
  */
2590
2870
  ParDenominator?: number;
2591
2871
  /**
2872
+ * @public
2592
2873
  * Pixel Aspect Ratio numerator.
2593
2874
  */
2594
2875
  ParNumerator?: number;
2595
2876
  /**
2877
+ * @public
2596
2878
  * H.265 Profile.
2597
2879
  */
2598
2880
  Profile?: H265Profile | string;
2599
2881
  /**
2882
+ * @public
2600
2883
  * Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:
2601
2884
  * - Primary screen: Quality level: 8 to 10. Max bitrate: 4M
2602
2885
  * - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M
@@ -2604,6 +2887,7 @@ export interface H265Settings {
2604
2887
  */
2605
2888
  QvbrQualityLevel?: number;
2606
2889
  /**
2890
+ * @public
2607
2891
  * Rate control mode.
2608
2892
  *
2609
2893
  * QVBR: Quality will match the specified quality level except when it is constrained by the
@@ -2618,29 +2902,35 @@ export interface H265Settings {
2618
2902
  */
2619
2903
  RateControlMode?: H265RateControlMode | string;
2620
2904
  /**
2905
+ * @public
2621
2906
  * Sets the scan type of the output to progressive or top-field-first interlaced.
2622
2907
  */
2623
2908
  ScanType?: H265ScanType | string;
2624
2909
  /**
2910
+ * @public
2625
2911
  * Scene change detection.
2626
2912
  */
2627
2913
  SceneChangeDetect?: H265SceneChangeDetect | string;
2628
2914
  /**
2915
+ * @public
2629
2916
  * Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.
2630
2917
  * This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
2631
2918
  */
2632
2919
  Slices?: number;
2633
2920
  /**
2921
+ * @public
2634
2922
  * H.265 Tier.
2635
2923
  */
2636
2924
  Tier?: H265Tier | string;
2637
2925
  /**
2926
+ * @public
2638
2927
  * Determines how timecodes should be inserted into the video elementary stream.
2639
2928
  * - 'disabled': Do not include timecodes
2640
2929
  * - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config
2641
2930
  */
2642
2931
  TimecodeInsertion?: H265TimecodeInsertionBehavior | string;
2643
2932
  /**
2933
+ * @public
2644
2934
  * Timecode burn-in settings
2645
2935
  */
2646
2936
  TimecodeBurninSettings?: TimecodeBurninSettings;
@@ -2702,6 +2992,7 @@ export type Mpeg2DisplayRatio = (typeof Mpeg2DisplayRatio)[keyof typeof Mpeg2Dis
2702
2992
  */
2703
2993
  export interface Mpeg2FilterSettings {
2704
2994
  /**
2995
+ * @public
2705
2996
  * Temporal Filter Settings
2706
2997
  */
2707
2998
  TemporalFilterSettings?: TemporalFilterSettings;
@@ -2760,30 +3051,36 @@ export type Mpeg2TimecodeInsertionBehavior = (typeof Mpeg2TimecodeInsertionBehav
2760
3051
  */
2761
3052
  export interface Mpeg2Settings {
2762
3053
  /**
3054
+ * @public
2763
3055
  * Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.
2764
3056
  */
2765
3057
  AdaptiveQuantization?: Mpeg2AdaptiveQuantization | string;
2766
3058
  /**
3059
+ * @public
2767
3060
  * Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO.
2768
3061
  * AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid).
2769
3062
  * FIXED: MediaLive will use the value you specify in fixedAFD.
2770
3063
  */
2771
3064
  AfdSignaling?: AfdSignaling | string;
2772
3065
  /**
3066
+ * @public
2773
3067
  * Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.
2774
3068
  */
2775
3069
  ColorMetadata?: Mpeg2ColorMetadata | string;
2776
3070
  /**
3071
+ * @public
2777
3072
  * Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide.
2778
3073
  * PASSTHROUGH: Keep the color space of the input content - do not convert it.
2779
3074
  * AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.
2780
3075
  */
2781
3076
  ColorSpace?: Mpeg2ColorSpace | string;
2782
3077
  /**
3078
+ * @public
2783
3079
  * Sets the pixel aspect ratio for the encode.
2784
3080
  */
2785
3081
  DisplayAspectRatio?: Mpeg2DisplayRatio | string;
2786
3082
  /**
3083
+ * @public
2787
3084
  * Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied.
2788
3085
  * TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean.
2789
3086
  * When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise.
@@ -2791,52 +3088,63 @@ export interface Mpeg2Settings {
2791
3088
  */
2792
3089
  FilterSettings?: Mpeg2FilterSettings;
2793
3090
  /**
3091
+ * @public
2794
3092
  * Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.
2795
3093
  */
2796
3094
  FixedAfd?: FixedAfd | string;
2797
3095
  /**
3096
+ * @public
2798
3097
  * description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.
2799
3098
  */
2800
3099
  FramerateDenominator: number | undefined;
2801
3100
  /**
3101
+ * @public
2802
3102
  * The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS.
2803
3103
  */
2804
3104
  FramerateNumerator: number | undefined;
2805
3105
  /**
3106
+ * @public
2806
3107
  * MPEG2: default is open GOP.
2807
3108
  */
2808
3109
  GopClosedCadence?: number;
2809
3110
  /**
3111
+ * @public
2810
3112
  * Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.
2811
3113
  */
2812
3114
  GopNumBFrames?: number;
2813
3115
  /**
3116
+ * @public
2814
3117
  * Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default.
2815
3118
  * If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1.
2816
3119
  * If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.
2817
3120
  */
2818
3121
  GopSize?: number;
2819
3122
  /**
3123
+ * @public
2820
3124
  * Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.
2821
3125
  */
2822
3126
  GopSizeUnits?: Mpeg2GopSizeUnits | string;
2823
3127
  /**
3128
+ * @public
2824
3129
  * Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).
2825
3130
  */
2826
3131
  ScanType?: Mpeg2ScanType | string;
2827
3132
  /**
3133
+ * @public
2828
3134
  * Relates to the GOP structure. If you do not know what GOP is, use the default.
2829
3135
  * FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames.
2830
3136
  * DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.
2831
3137
  */
2832
3138
  SubgopLength?: Mpeg2SubGopLength | string;
2833
3139
  /**
3140
+ * @public
2834
3141
  * Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide.
2835
3142
  * DISABLED: do not include timecodes.
2836
3143
  * GOP_TIMECODE: Include timecode metadata in the GOP header.
2837
3144
  */
2838
3145
  TimecodeInsertion?: Mpeg2TimecodeInsertionBehavior | string;
2839
3146
  /**
3147
+ * @public
2840
3148
  * Timecode burn-in settings
2841
3149
  */
2842
3150
  TimecodeBurninSettings?: TimecodeBurninSettings;
@@ -2847,18 +3155,22 @@ export interface Mpeg2Settings {
2847
3155
  */
2848
3156
  export interface VideoCodecSettings {
2849
3157
  /**
3158
+ * @public
2850
3159
  * Frame Capture Settings
2851
3160
  */
2852
3161
  FrameCaptureSettings?: FrameCaptureSettings;
2853
3162
  /**
3163
+ * @public
2854
3164
  * H264 Settings
2855
3165
  */
2856
3166
  H264Settings?: H264Settings;
2857
3167
  /**
3168
+ * @public
2858
3169
  * H265 Settings
2859
3170
  */
2860
3171
  H265Settings?: H265Settings;
2861
3172
  /**
3173
+ * @public
2862
3174
  * Mpeg2 Settings
2863
3175
  */
2864
3176
  Mpeg2Settings?: Mpeg2Settings;
@@ -2894,18 +3206,22 @@ export type VideoDescriptionScalingBehavior = (typeof VideoDescriptionScalingBeh
2894
3206
  */
2895
3207
  export interface VideoDescription {
2896
3208
  /**
3209
+ * @public
2897
3210
  * Video codec settings.
2898
3211
  */
2899
3212
  CodecSettings?: VideoCodecSettings;
2900
3213
  /**
3214
+ * @public
2901
3215
  * Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
2902
3216
  */
2903
3217
  Height?: number;
2904
3218
  /**
3219
+ * @public
2905
3220
  * The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
2906
3221
  */
2907
3222
  Name: string | undefined;
2908
3223
  /**
3224
+ * @public
2909
3225
  * Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH.
2910
3226
  * RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE.
2911
3227
  * PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output.
@@ -2913,14 +3229,17 @@ export interface VideoDescription {
2913
3229
  */
2914
3230
  RespondToAfd?: VideoDescriptionRespondToAfd | string;
2915
3231
  /**
3232
+ * @public
2916
3233
  * STRETCH_TO_OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution.
2917
3234
  */
2918
3235
  ScalingBehavior?: VideoDescriptionScalingBehavior | string;
2919
3236
  /**
3237
+ * @public
2920
3238
  * Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
2921
3239
  */
2922
3240
  Sharpness?: number;
2923
3241
  /**
3242
+ * @public
2924
3243
  * Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
2925
3244
  */
2926
3245
  Width?: number;
@@ -2942,6 +3261,7 @@ export type AcceptHeader = (typeof AcceptHeader)[keyof typeof AcceptHeader];
2942
3261
  */
2943
3262
  export interface AcceptInputDeviceTransferRequest {
2944
3263
  /**
3264
+ * @public
2945
3265
  * The unique ID of the input device to accept. For example, hd-123456789abcdef.
2946
3266
  */
2947
3267
  InputDeviceId: string | undefined;
@@ -2960,6 +3280,7 @@ export declare class BadGatewayException extends __BaseException {
2960
3280
  readonly name: "BadGatewayException";
2961
3281
  readonly $fault: "server";
2962
3282
  /**
3283
+ * @public
2963
3284
  * Placeholder documentation for __string
2964
3285
  */
2965
3286
  Message?: string;
@@ -2976,6 +3297,7 @@ export declare class BadRequestException extends __BaseException {
2976
3297
  readonly name: "BadRequestException";
2977
3298
  readonly $fault: "client";
2978
3299
  /**
3300
+ * @public
2979
3301
  * Placeholder documentation for __string
2980
3302
  */
2981
3303
  Message?: string;
@@ -2992,6 +3314,7 @@ export declare class ConflictException extends __BaseException {
2992
3314
  readonly name: "ConflictException";
2993
3315
  readonly $fault: "client";
2994
3316
  /**
3317
+ * @public
2995
3318
  * Placeholder documentation for __string
2996
3319
  */
2997
3320
  Message?: string;
@@ -3008,6 +3331,7 @@ export declare class ForbiddenException extends __BaseException {
3008
3331
  readonly name: "ForbiddenException";
3009
3332
  readonly $fault: "client";
3010
3333
  /**
3334
+ * @public
3011
3335
  * Placeholder documentation for __string
3012
3336
  */
3013
3337
  Message?: string;
@@ -3024,6 +3348,7 @@ export declare class GatewayTimeoutException extends __BaseException {
3024
3348
  readonly name: "GatewayTimeoutException";
3025
3349
  readonly $fault: "server";
3026
3350
  /**
3351
+ * @public
3027
3352
  * Placeholder documentation for __string
3028
3353
  */
3029
3354
  Message?: string;
@@ -3040,6 +3365,7 @@ export declare class InternalServerErrorException extends __BaseException {
3040
3365
  readonly name: "InternalServerErrorException";
3041
3366
  readonly $fault: "server";
3042
3367
  /**
3368
+ * @public
3043
3369
  * Placeholder documentation for __string
3044
3370
  */
3045
3371
  Message?: string;
@@ -3056,6 +3382,7 @@ export declare class NotFoundException extends __BaseException {
3056
3382
  readonly name: "NotFoundException";
3057
3383
  readonly $fault: "client";
3058
3384
  /**
3385
+ * @public
3059
3386
  * Placeholder documentation for __string
3060
3387
  */
3061
3388
  Message?: string;
@@ -3072,6 +3399,7 @@ export declare class TooManyRequestsException extends __BaseException {
3072
3399
  readonly name: "TooManyRequestsException";
3073
3400
  readonly $fault: "client";
3074
3401
  /**
3402
+ * @public
3075
3403
  * Placeholder documentation for __string
3076
3404
  */
3077
3405
  Message?: string;
@@ -3088,10 +3416,12 @@ export declare class UnprocessableEntityException extends __BaseException {
3088
3416
  readonly name: "UnprocessableEntityException";
3089
3417
  readonly $fault: "client";
3090
3418
  /**
3419
+ * @public
3091
3420
  * The error message.
3092
3421
  */
3093
3422
  Message?: string;
3094
3423
  /**
3424
+ * @public
3095
3425
  * A collection of validation error responses.
3096
3426
  */
3097
3427
  ValidationErrors?: ValidationError[];
@@ -3106,6 +3436,7 @@ export declare class UnprocessableEntityException extends __BaseException {
3106
3436
  */
3107
3437
  export interface AccountConfiguration {
3108
3438
  /**
3439
+ * @public
3109
3440
  * Specifies the KMS key to use for all features that use key encryption. Specify the ARN of a KMS key that you have created. Or leave blank to use the key that MediaLive creates and manages for you.
3110
3441
  */
3111
3442
  KmsKeyId?: string;
@@ -3128,10 +3459,12 @@ export type AvailBlankingState = (typeof AvailBlankingState)[keyof typeof AvailB
3128
3459
  */
3129
3460
  export interface AvailBlanking {
3130
3461
  /**
3462
+ * @public
3131
3463
  * Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
3132
3464
  */
3133
3465
  AvailBlankingImage?: InputLocation;
3134
3466
  /**
3467
+ * @public
3135
3468
  * When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.
3136
3469
  */
3137
3470
  State?: AvailBlankingState | string;
@@ -3142,26 +3475,32 @@ export interface AvailBlanking {
3142
3475
  */
3143
3476
  export interface Esam {
3144
3477
  /**
3478
+ * @public
3145
3479
  * Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS.
3146
3480
  */
3147
3481
  AcquisitionPointId: string | undefined;
3148
3482
  /**
3483
+ * @public
3149
3484
  * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
3150
3485
  */
3151
3486
  AdAvailOffset?: number;
3152
3487
  /**
3488
+ * @public
3153
3489
  * Documentation update needed
3154
3490
  */
3155
3491
  PasswordParam?: string;
3156
3492
  /**
3493
+ * @public
3157
3494
  * The URL of the signal conditioner endpoint on the Placement Opportunity Information System (POIS). MediaLive sends SignalProcessingEvents here when SCTE-35 messages are read.
3158
3495
  */
3159
3496
  PoisEndpoint: string | undefined;
3160
3497
  /**
3498
+ * @public
3161
3499
  * Documentation update needed
3162
3500
  */
3163
3501
  Username?: string;
3164
3502
  /**
3503
+ * @public
3165
3504
  * Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS.
3166
3505
  */
3167
3506
  ZoneIdentity?: string;
@@ -3196,14 +3535,17 @@ export type Scte35SpliceInsertWebDeliveryAllowedBehavior = (typeof Scte35SpliceI
3196
3535
  */
3197
3536
  export interface Scte35SpliceInsert {
3198
3537
  /**
3538
+ * @public
3199
3539
  * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
3200
3540
  */
3201
3541
  AdAvailOffset?: number;
3202
3542
  /**
3543
+ * @public
3203
3544
  * When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
3204
3545
  */
3205
3546
  NoRegionalBlackoutFlag?: Scte35SpliceInsertNoRegionalBlackoutBehavior | string;
3206
3547
  /**
3548
+ * @public
3207
3549
  * When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
3208
3550
  */
3209
3551
  WebDeliveryAllowedFlag?: Scte35SpliceInsertWebDeliveryAllowedBehavior | string;
@@ -3238,14 +3580,17 @@ export type Scte35AposWebDeliveryAllowedBehavior = (typeof Scte35AposWebDelivery
3238
3580
  */
3239
3581
  export interface Scte35TimeSignalApos {
3240
3582
  /**
3583
+ * @public
3241
3584
  * When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
3242
3585
  */
3243
3586
  AdAvailOffset?: number;
3244
3587
  /**
3588
+ * @public
3245
3589
  * When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates
3246
3590
  */
3247
3591
  NoRegionalBlackoutFlag?: Scte35AposNoRegionalBlackoutBehavior | string;
3248
3592
  /**
3593
+ * @public
3249
3594
  * When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates
3250
3595
  */
3251
3596
  WebDeliveryAllowedFlag?: Scte35AposWebDeliveryAllowedBehavior | string;
@@ -3256,14 +3601,17 @@ export interface Scte35TimeSignalApos {
3256
3601
  */
3257
3602
  export interface AvailSettings {
3258
3603
  /**
3604
+ * @public
3259
3605
  * Esam
3260
3606
  */
3261
3607
  Esam?: Esam;
3262
3608
  /**
3609
+ * @public
3263
3610
  * Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements.
3264
3611
  */
3265
3612
  Scte35SpliceInsert?: Scte35SpliceInsert;
3266
3613
  /**
3614
+ * @public
3267
3615
  * Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks.
3268
3616
  */
3269
3617
  Scte35TimeSignalApos?: Scte35TimeSignalApos;
@@ -3274,6 +3622,7 @@ export interface AvailSettings {
3274
3622
  */
3275
3623
  export interface AvailConfiguration {
3276
3624
  /**
3625
+ * @public
3277
3626
  * Controls how SCTE-35 messages create cues. Splice Insert mode treats all segmentation signals traditionally. With Time Signal APOS mode only Time Signal Placement Opportunity and Break messages create segment breaks. With ESAM mode, signals are forwarded to an ESAM server for possible update.
3278
3627
  */
3279
3628
  AvailSettings?: AvailSettings;
@@ -3284,18 +3633,22 @@ export interface AvailConfiguration {
3284
3633
  */
3285
3634
  export interface BatchDeleteRequest {
3286
3635
  /**
3636
+ * @public
3287
3637
  * List of channel IDs
3288
3638
  */
3289
3639
  ChannelIds?: string[];
3290
3640
  /**
3641
+ * @public
3291
3642
  * List of input IDs
3292
3643
  */
3293
3644
  InputIds?: string[];
3294
3645
  /**
3646
+ * @public
3295
3647
  * List of input security group IDs
3296
3648
  */
3297
3649
  InputSecurityGroupIds?: string[];
3298
3650
  /**
3651
+ * @public
3299
3652
  * List of multiplex IDs
3300
3653
  */
3301
3654
  MultiplexIds?: string[];
@@ -3306,10 +3659,12 @@ export interface BatchDeleteRequest {
3306
3659
  */
3307
3660
  export interface BatchDeleteResponse {
3308
3661
  /**
3662
+ * @public
3309
3663
  * List of failed operations
3310
3664
  */
3311
3665
  Failed?: BatchFailedResultModel[];
3312
3666
  /**
3667
+ * @public
3313
3668
  * List of successful operations
3314
3669
  */
3315
3670
  Successful?: BatchSuccessfulResultModel[];
@@ -3320,6 +3675,7 @@ export interface BatchDeleteResponse {
3320
3675
  */
3321
3676
  export interface BatchScheduleActionCreateRequest {
3322
3677
  /**
3678
+ * @public
3323
3679
  * A list of schedule actions to create.
3324
3680
  */
3325
3681
  ScheduleActions: ScheduleAction[] | undefined;
@@ -3330,6 +3686,7 @@ export interface BatchScheduleActionCreateRequest {
3330
3686
  */
3331
3687
  export interface BatchScheduleActionCreateResult {
3332
3688
  /**
3689
+ * @public
3333
3690
  * List of actions that have been created in the schedule.
3334
3691
  */
3335
3692
  ScheduleActions: ScheduleAction[] | undefined;
@@ -3340,6 +3697,7 @@ export interface BatchScheduleActionCreateResult {
3340
3697
  */
3341
3698
  export interface BatchScheduleActionDeleteRequest {
3342
3699
  /**
3700
+ * @public
3343
3701
  * A list of schedule actions to delete.
3344
3702
  */
3345
3703
  ActionNames: string[] | undefined;
@@ -3350,6 +3708,7 @@ export interface BatchScheduleActionDeleteRequest {
3350
3708
  */
3351
3709
  export interface BatchScheduleActionDeleteResult {
3352
3710
  /**
3711
+ * @public
3353
3712
  * List of actions that have been deleted from the schedule.
3354
3713
  */
3355
3714
  ScheduleActions: ScheduleAction[] | undefined;
@@ -3360,10 +3719,12 @@ export interface BatchScheduleActionDeleteResult {
3360
3719
  */
3361
3720
  export interface BatchStartRequest {
3362
3721
  /**
3722
+ * @public
3363
3723
  * List of channel IDs
3364
3724
  */
3365
3725
  ChannelIds?: string[];
3366
3726
  /**
3727
+ * @public
3367
3728
  * List of multiplex IDs
3368
3729
  */
3369
3730
  MultiplexIds?: string[];
@@ -3374,10 +3735,12 @@ export interface BatchStartRequest {
3374
3735
  */
3375
3736
  export interface BatchStartResponse {
3376
3737
  /**
3738
+ * @public
3377
3739
  * List of failed operations
3378
3740
  */
3379
3741
  Failed?: BatchFailedResultModel[];
3380
3742
  /**
3743
+ * @public
3381
3744
  * List of successful operations
3382
3745
  */
3383
3746
  Successful?: BatchSuccessfulResultModel[];
@@ -3388,10 +3751,12 @@ export interface BatchStartResponse {
3388
3751
  */
3389
3752
  export interface BatchStopRequest {
3390
3753
  /**
3754
+ * @public
3391
3755
  * List of channel IDs
3392
3756
  */
3393
3757
  ChannelIds?: string[];
3394
3758
  /**
3759
+ * @public
3395
3760
  * List of multiplex IDs
3396
3761
  */
3397
3762
  MultiplexIds?: string[];
@@ -3402,10 +3767,12 @@ export interface BatchStopRequest {
3402
3767
  */
3403
3768
  export interface BatchStopResponse {
3404
3769
  /**
3770
+ * @public
3405
3771
  * List of failed operations
3406
3772
  */
3407
3773
  Failed?: BatchFailedResultModel[];
3408
3774
  /**
3775
+ * @public
3409
3776
  * List of successful operations
3410
3777
  */
3411
3778
  Successful?: BatchSuccessfulResultModel[];
@@ -3416,14 +3783,17 @@ export interface BatchStopResponse {
3416
3783
  */
3417
3784
  export interface BatchUpdateScheduleRequest {
3418
3785
  /**
3786
+ * @public
3419
3787
  * Id of the channel whose schedule is being updated.
3420
3788
  */
3421
3789
  ChannelId: string | undefined;
3422
3790
  /**
3791
+ * @public
3423
3792
  * Schedule actions to create in the schedule.
3424
3793
  */
3425
3794
  Creates?: BatchScheduleActionCreateRequest;
3426
3795
  /**
3796
+ * @public
3427
3797
  * Schedule actions to delete from the schedule.
3428
3798
  */
3429
3799
  Deletes?: BatchScheduleActionDeleteRequest;
@@ -3434,10 +3804,12 @@ export interface BatchUpdateScheduleRequest {
3434
3804
  */
3435
3805
  export interface BatchUpdateScheduleResponse {
3436
3806
  /**
3807
+ * @public
3437
3808
  * Schedule actions created in the schedule.
3438
3809
  */
3439
3810
  Creates?: BatchScheduleActionCreateResult;
3440
3811
  /**
3812
+ * @public
3441
3813
  * Schedule actions deleted from the schedule.
3442
3814
  */
3443
3815
  Deletes?: BatchScheduleActionDeleteResult;
@@ -3472,22 +3844,27 @@ export type BlackoutSlateState = (typeof BlackoutSlateState)[keyof typeof Blacko
3472
3844
  */
3473
3845
  export interface BlackoutSlate {
3474
3846
  /**
3847
+ * @public
3475
3848
  * Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
3476
3849
  */
3477
3850
  BlackoutSlateImage?: InputLocation;
3478
3851
  /**
3852
+ * @public
3479
3853
  * Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".
3480
3854
  */
3481
3855
  NetworkEndBlackout?: BlackoutSlateNetworkEndBlackout | string;
3482
3856
  /**
3857
+ * @public
3483
3858
  * Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
3484
3859
  */
3485
3860
  NetworkEndBlackoutImage?: InputLocation;
3486
3861
  /**
3862
+ * @public
3487
3863
  * Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
3488
3864
  */
3489
3865
  NetworkId?: string;
3490
3866
  /**
3867
+ * @public
3491
3868
  * When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
3492
3869
  */
3493
3870
  State?: BlackoutSlateState | string;
@@ -3498,6 +3875,7 @@ export interface BlackoutSlate {
3498
3875
  */
3499
3876
  export interface CancelInputDeviceTransferRequest {
3500
3877
  /**
3878
+ * @public
3501
3879
  * The unique ID of the input device to cancel. For example, hd-123456789abcdef.
3502
3880
  */
3503
3881
  InputDeviceId: string | undefined;
@@ -3526,6 +3904,7 @@ export type FeatureActivationsInputPrepareScheduleActions = (typeof FeatureActiv
3526
3904
  */
3527
3905
  export interface FeatureActivations {
3528
3906
  /**
3907
+ * @public
3529
3908
  * Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled.
3530
3909
  * If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule.
3531
3910
  */
@@ -3561,22 +3940,27 @@ export type InputLossImageType = (typeof InputLossImageType)[keyof typeof InputL
3561
3940
  */
3562
3941
  export interface InputLossBehavior {
3563
3942
  /**
3943
+ * @public
3564
3944
  * Documentation update needed
3565
3945
  */
3566
3946
  BlackFrameMsec?: number;
3567
3947
  /**
3948
+ * @public
3568
3949
  * When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
3569
3950
  */
3570
3951
  InputLossImageColor?: string;
3571
3952
  /**
3953
+ * @public
3572
3954
  * When input loss image type is "slate" these fields specify the parameters for accessing the slate.
3573
3955
  */
3574
3956
  InputLossImageSlate?: InputLocation;
3575
3957
  /**
3958
+ * @public
3576
3959
  * Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.
3577
3960
  */
3578
3961
  InputLossImageType?: InputLossImageType | string;
3579
3962
  /**
3963
+ * @public
3580
3964
  * Documentation update needed
3581
3965
  */
3582
3966
  RepeatFrameMsec?: number;
@@ -3623,18 +4007,22 @@ export type GlobalConfigurationLowFramerateInputs = (typeof GlobalConfigurationL
3623
4007
  */
3624
4008
  export interface GlobalConfiguration {
3625
4009
  /**
4010
+ * @public
3626
4011
  * Value to set the initial audio gain for the Live Event.
3627
4012
  */
3628
4013
  InitialAudioGain?: number;
3629
4014
  /**
4015
+ * @public
3630
4016
  * Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).
3631
4017
  */
3632
4018
  InputEndAction?: GlobalConfigurationInputEndAction | string;
3633
4019
  /**
4020
+ * @public
3634
4021
  * Settings for system actions when input is lost.
3635
4022
  */
3636
4023
  InputLossBehavior?: InputLossBehavior;
3637
4024
  /**
4025
+ * @public
3638
4026
  * Indicates how MediaLive pipelines are synchronized.
3639
4027
  *
3640
4028
  * PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other.
@@ -3642,10 +4030,12 @@ export interface GlobalConfiguration {
3642
4030
  */
3643
4031
  OutputLockingMode?: GlobalConfigurationOutputLockingMode | string;
3644
4032
  /**
4033
+ * @public
3645
4034
  * Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream.
3646
4035
  */
3647
4036
  OutputTimingSource?: GlobalConfigurationOutputTimingSource | string;
3648
4037
  /**
4038
+ * @public
3649
4039
  * Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second.
3650
4040
  */
3651
4041
  SupportLowFramerateInputs?: GlobalConfigurationLowFramerateInputs | string;
@@ -3674,6 +4064,7 @@ export interface HtmlMotionGraphicsSettings {
3674
4064
  */
3675
4065
  export interface MotionGraphicsSettings {
3676
4066
  /**
4067
+ * @public
3677
4068
  * Html Motion Graphics Settings
3678
4069
  */
3679
4070
  HtmlMotionGraphicsSettings?: HtmlMotionGraphicsSettings;
@@ -3684,10 +4075,12 @@ export interface MotionGraphicsSettings {
3684
4075
  */
3685
4076
  export interface MotionGraphicsConfiguration {
3686
4077
  /**
4078
+ * @public
3687
4079
  * Motion Graphics Insertion
3688
4080
  */
3689
4081
  MotionGraphicsInsertion?: MotionGraphicsInsertion | string;
3690
4082
  /**
4083
+ * @public
3691
4084
  * Motion Graphics Settings
3692
4085
  */
3693
4086
  MotionGraphicsSettings: MotionGraphicsSettings | undefined;
@@ -3710,10 +4103,12 @@ export type NielsenPcmToId3TaggingState = (typeof NielsenPcmToId3TaggingState)[k
3710
4103
  */
3711
4104
  export interface NielsenConfiguration {
3712
4105
  /**
4106
+ * @public
3713
4107
  * Enter the Distributor ID assigned to your organization by Nielsen.
3714
4108
  */
3715
4109
  DistributorId?: string;
3716
4110
  /**
4111
+ * @public
3717
4112
  * Enables Nielsen PCM to ID3 tagging
3718
4113
  */
3719
4114
  NielsenPcmToId3Tagging?: NielsenPcmToId3TaggingState | string;
@@ -3736,6 +4131,7 @@ export type ThumbnailState = (typeof ThumbnailState)[keyof typeof ThumbnailState
3736
4131
  */
3737
4132
  export interface ThumbnailConfiguration {
3738
4133
  /**
4134
+ * @public
3739
4135
  * Whether Thumbnail is enabled.
3740
4136
  */
3741
4137
  State: ThumbnailState | string | undefined;
@@ -3759,6 +4155,7 @@ export type TimecodeConfigSource = (typeof TimecodeConfigSource)[keyof typeof Ti
3759
4155
  */
3760
4156
  export interface TimecodeConfig {
3761
4157
  /**
4158
+ * @public
3762
4159
  * Identifies the source for the timecode that will be associated with the events outputs.
3763
4160
  * -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased).
3764
4161
  * -System Clock (systemclock): Use the UTC time.
@@ -3766,6 +4163,7 @@ export interface TimecodeConfig {
3766
4163
  */
3767
4164
  Source: TimecodeConfigSource | string | undefined;
3768
4165
  /**
4166
+ * @public
3769
4167
  * Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
3770
4168
  */
3771
4169
  SyncThreshold?: number;
@@ -3776,54 +4174,67 @@ export interface TimecodeConfig {
3776
4174
  */
3777
4175
  export interface EncoderSettings {
3778
4176
  /**
4177
+ * @public
3779
4178
  * Placeholder documentation for __listOfAudioDescription
3780
4179
  */
3781
4180
  AudioDescriptions: AudioDescription[] | undefined;
3782
4181
  /**
4182
+ * @public
3783
4183
  * Settings for ad avail blanking.
3784
4184
  */
3785
4185
  AvailBlanking?: AvailBlanking;
3786
4186
  /**
4187
+ * @public
3787
4188
  * Event-wide configuration settings for ad avail insertion.
3788
4189
  */
3789
4190
  AvailConfiguration?: AvailConfiguration;
3790
4191
  /**
4192
+ * @public
3791
4193
  * Settings for blackout slate.
3792
4194
  */
3793
4195
  BlackoutSlate?: BlackoutSlate;
3794
4196
  /**
4197
+ * @public
3795
4198
  * Settings for caption decriptions
3796
4199
  */
3797
4200
  CaptionDescriptions?: CaptionDescription[];
3798
4201
  /**
4202
+ * @public
3799
4203
  * Feature Activations
3800
4204
  */
3801
4205
  FeatureActivations?: FeatureActivations;
3802
4206
  /**
4207
+ * @public
3803
4208
  * Configuration settings that apply to the event as a whole.
3804
4209
  */
3805
4210
  GlobalConfiguration?: GlobalConfiguration;
3806
4211
  /**
4212
+ * @public
3807
4213
  * Settings for motion graphics.
3808
4214
  */
3809
4215
  MotionGraphicsConfiguration?: MotionGraphicsConfiguration;
3810
4216
  /**
4217
+ * @public
3811
4218
  * Nielsen configuration settings.
3812
4219
  */
3813
4220
  NielsenConfiguration?: NielsenConfiguration;
3814
4221
  /**
4222
+ * @public
3815
4223
  * Placeholder documentation for __listOfOutputGroup
3816
4224
  */
3817
4225
  OutputGroups: OutputGroup[] | undefined;
3818
4226
  /**
4227
+ * @public
3819
4228
  * Contains settings used to acquire and adjust timecode information from inputs.
3820
4229
  */
3821
4230
  TimecodeConfig: TimecodeConfig | undefined;
3822
4231
  /**
4232
+ * @public
3823
4233
  * Placeholder documentation for __listOfVideoDescription
3824
4234
  */
3825
4235
  VideoDescriptions: VideoDescription[] | undefined;
3826
4236
  /**
4237
+ * @public
3827
4238
  * Thumbnail configuration settings.
3828
4239
  */
3829
4240
  ThumbnailConfiguration?: ThumbnailConfiguration;
@@ -3834,76 +4245,94 @@ export interface EncoderSettings {
3834
4245
  */
3835
4246
  export interface Channel {
3836
4247
  /**
4248
+ * @public
3837
4249
  * The unique arn of the channel.
3838
4250
  */
3839
4251
  Arn?: string;
3840
4252
  /**
4253
+ * @public
3841
4254
  * Specification of CDI inputs for this channel
3842
4255
  */
3843
4256
  CdiInputSpecification?: CdiInputSpecification;
3844
4257
  /**
4258
+ * @public
3845
4259
  * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
3846
4260
  */
3847
4261
  ChannelClass?: ChannelClass | string;
3848
4262
  /**
4263
+ * @public
3849
4264
  * A list of destinations of the channel. For UDP outputs, there is one
3850
4265
  * destination per output. For other types (HLS, for example), there is
3851
4266
  * one destination per packager.
3852
4267
  */
3853
4268
  Destinations?: OutputDestination[];
3854
4269
  /**
4270
+ * @public
3855
4271
  * The endpoints where outgoing connections initiate from
3856
4272
  */
3857
4273
  EgressEndpoints?: ChannelEgressEndpoint[];
3858
4274
  /**
4275
+ * @public
3859
4276
  * Encoder Settings
3860
4277
  */
3861
4278
  EncoderSettings?: EncoderSettings;
3862
4279
  /**
4280
+ * @public
3863
4281
  * The unique id of the channel.
3864
4282
  */
3865
4283
  Id?: string;
3866
4284
  /**
4285
+ * @public
3867
4286
  * List of input attachments for channel.
3868
4287
  */
3869
4288
  InputAttachments?: InputAttachment[];
3870
4289
  /**
4290
+ * @public
3871
4291
  * Specification of network and file inputs for this channel
3872
4292
  */
3873
4293
  InputSpecification?: InputSpecification;
3874
4294
  /**
4295
+ * @public
3875
4296
  * The log level being written to CloudWatch Logs.
3876
4297
  */
3877
4298
  LogLevel?: LogLevel | string;
3878
4299
  /**
4300
+ * @public
3879
4301
  * Maintenance settings for this channel.
3880
4302
  */
3881
4303
  Maintenance?: MaintenanceStatus;
3882
4304
  /**
4305
+ * @public
3883
4306
  * The name of the channel. (user-mutable)
3884
4307
  */
3885
4308
  Name?: string;
3886
4309
  /**
4310
+ * @public
3887
4311
  * Runtime details for the pipelines of a running channel.
3888
4312
  */
3889
4313
  PipelineDetails?: PipelineDetail[];
3890
4314
  /**
4315
+ * @public
3891
4316
  * The number of currently healthy pipelines.
3892
4317
  */
3893
4318
  PipelinesRunningCount?: number;
3894
4319
  /**
4320
+ * @public
3895
4321
  * The Amazon Resource Name (ARN) of the role assumed when running the Channel.
3896
4322
  */
3897
4323
  RoleArn?: string;
3898
4324
  /**
4325
+ * @public
3899
4326
  * Placeholder documentation for ChannelState
3900
4327
  */
3901
4328
  State?: ChannelState | string;
3902
4329
  /**
4330
+ * @public
3903
4331
  * A collection of key-value pairs.
3904
4332
  */
3905
4333
  Tags?: Record<string, string>;
3906
4334
  /**
4335
+ * @public
3907
4336
  * Settings for VPC output
3908
4337
  */
3909
4338
  Vpc?: VpcOutputSettingsDescription;
@@ -3914,6 +4343,7 @@ export interface Channel {
3914
4343
  */
3915
4344
  export interface ClaimDeviceRequest {
3916
4345
  /**
4346
+ * @public
3917
4347
  * The id of the device you want to claim.
3918
4348
  */
3919
4349
  Id?: string;
@@ -3941,10 +4371,12 @@ export type ContentType = (typeof ContentType)[keyof typeof ContentType];
3941
4371
  */
3942
4372
  export interface MaintenanceCreateSettings {
3943
4373
  /**
4374
+ * @public
3944
4375
  * Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.
3945
4376
  */
3946
4377
  MaintenanceDay?: MaintenanceDay | string;
3947
4378
  /**
4379
+ * @public
3948
4380
  * Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.
3949
4381
  */
3950
4382
  MaintenanceStartTime?: string;
@@ -3956,16 +4388,19 @@ export interface MaintenanceCreateSettings {
3956
4388
  */
3957
4389
  export interface VpcOutputSettings {
3958
4390
  /**
4391
+ * @public
3959
4392
  * List of public address allocation ids to associate with ENIs that will be created in Output VPC.
3960
4393
  * Must specify one for SINGLE_PIPELINE, two for STANDARD channels
3961
4394
  */
3962
4395
  PublicAddressAllocationIds?: string[];
3963
4396
  /**
4397
+ * @public
3964
4398
  * A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces.
3965
4399
  * If none are specified then the VPC default security group will be used
3966
4400
  */
3967
4401
  SecurityGroupIds?: string[];
3968
4402
  /**
4403
+ * @public
3969
4404
  * A list of VPC subnet IDs from the same VPC.
3970
4405
  * If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).
3971
4406
  */
@@ -3977,61 +4412,75 @@ export interface VpcOutputSettings {
3977
4412
  */
3978
4413
  export interface CreateChannelRequest {
3979
4414
  /**
4415
+ * @public
3980
4416
  * Specification of CDI inputs for this channel
3981
4417
  */
3982
4418
  CdiInputSpecification?: CdiInputSpecification;
3983
4419
  /**
4420
+ * @public
3984
4421
  * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
3985
4422
  */
3986
4423
  ChannelClass?: ChannelClass | string;
3987
4424
  /**
4425
+ * @public
3988
4426
  * Placeholder documentation for __listOfOutputDestination
3989
4427
  */
3990
4428
  Destinations?: OutputDestination[];
3991
4429
  /**
4430
+ * @public
3992
4431
  * Encoder Settings
3993
4432
  */
3994
4433
  EncoderSettings?: EncoderSettings;
3995
4434
  /**
4435
+ * @public
3996
4436
  * List of input attachments for channel.
3997
4437
  */
3998
4438
  InputAttachments?: InputAttachment[];
3999
4439
  /**
4440
+ * @public
4000
4441
  * Specification of network and file inputs for this channel
4001
4442
  */
4002
4443
  InputSpecification?: InputSpecification;
4003
4444
  /**
4445
+ * @public
4004
4446
  * The log level to write to CloudWatch Logs.
4005
4447
  */
4006
4448
  LogLevel?: LogLevel | string;
4007
4449
  /**
4450
+ * @public
4008
4451
  * Maintenance settings for this channel.
4009
4452
  */
4010
4453
  Maintenance?: MaintenanceCreateSettings;
4011
4454
  /**
4455
+ * @public
4012
4456
  * Name of channel.
4013
4457
  */
4014
4458
  Name?: string;
4015
4459
  /**
4460
+ * @public
4016
4461
  * Unique request ID to be specified. This is needed to prevent retries from
4017
4462
  * creating multiple resources.
4018
4463
  */
4019
4464
  RequestId?: string;
4020
4465
  /**
4466
+ * @public
4021
4467
  * @deprecated
4022
4468
  *
4023
4469
  * Deprecated field that's only usable by whitelisted customers.
4024
4470
  */
4025
4471
  Reserved?: string;
4026
4472
  /**
4473
+ * @public
4027
4474
  * An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
4028
4475
  */
4029
4476
  RoleArn?: string;
4030
4477
  /**
4478
+ * @public
4031
4479
  * A collection of key-value pairs.
4032
4480
  */
4033
4481
  Tags?: Record<string, string>;
4034
4482
  /**
4483
+ * @public
4035
4484
  * Settings for the VPC outputs
4036
4485
  */
4037
4486
  Vpc?: VpcOutputSettings;
@@ -4042,6 +4491,7 @@ export interface CreateChannelRequest {
4042
4491
  */
4043
4492
  export interface CreateChannelResponse {
4044
4493
  /**
4494
+ * @public
4045
4495
  * Placeholder documentation for Channel
4046
4496
  */
4047
4497
  Channel?: Channel;
@@ -4055,11 +4505,13 @@ export interface CreateChannelResponse {
4055
4505
  */
4056
4506
  export interface InputVpcRequest {
4057
4507
  /**
4508
+ * @public
4058
4509
  * A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.
4059
4510
  * Requires subnetIds. If none are specified then the VPC default security group will be used.
4060
4511
  */
4061
4512
  SecurityGroupIds?: string[];
4062
4513
  /**
4514
+ * @public
4063
4515
  * A list of 2 VPC subnet IDs from the same VPC.
4064
4516
  * Subnet IDs must be mapped to two unique availability zones (AZ).
4065
4517
  */
@@ -4071,51 +4523,62 @@ export interface InputVpcRequest {
4071
4523
  */
4072
4524
  export interface CreateInputRequest {
4073
4525
  /**
4526
+ * @public
4074
4527
  * Destination settings for PUSH type inputs.
4075
4528
  */
4076
4529
  Destinations?: InputDestinationRequest[];
4077
4530
  /**
4531
+ * @public
4078
4532
  * Settings for the devices.
4079
4533
  */
4080
4534
  InputDevices?: InputDeviceSettings[];
4081
4535
  /**
4536
+ * @public
4082
4537
  * A list of security groups referenced by IDs to attach to the input.
4083
4538
  */
4084
4539
  InputSecurityGroups?: string[];
4085
4540
  /**
4541
+ * @public
4086
4542
  * A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one
4087
4543
  * Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a
4088
4544
  * separate Availability Zone as this ensures your EML input is redundant to AZ issues.
4089
4545
  */
4090
4546
  MediaConnectFlows?: MediaConnectFlowRequest[];
4091
4547
  /**
4548
+ * @public
4092
4549
  * Name of the input.
4093
4550
  */
4094
4551
  Name?: string;
4095
4552
  /**
4553
+ * @public
4096
4554
  * Unique identifier of the request to ensure the request is handled
4097
4555
  * exactly once in case of retries.
4098
4556
  */
4099
4557
  RequestId?: string;
4100
4558
  /**
4559
+ * @public
4101
4560
  * The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
4102
4561
  */
4103
4562
  RoleArn?: string;
4104
4563
  /**
4564
+ * @public
4105
4565
  * The source URLs for a PULL-type input. Every PULL type input needs
4106
4566
  * exactly two source URLs for redundancy.
4107
4567
  * Only specify sources for PULL type Inputs. Leave Destinations empty.
4108
4568
  */
4109
4569
  Sources?: InputSourceRequest[];
4110
4570
  /**
4571
+ * @public
4111
4572
  * A collection of key-value pairs.
4112
4573
  */
4113
4574
  Tags?: Record<string, string>;
4114
4575
  /**
4576
+ * @public
4115
4577
  * The different types of inputs that AWS Elemental MediaLive supports.
4116
4578
  */
4117
4579
  Type?: InputType | string;
4118
4580
  /**
4581
+ * @public
4119
4582
  * Settings for a private VPC Input.
4120
4583
  * When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.
4121
4584
  * This property requires setting the roleArn property on Input creation.
@@ -4129,6 +4592,7 @@ export interface CreateInputRequest {
4129
4592
  */
4130
4593
  export interface CreateInputResponse {
4131
4594
  /**
4595
+ * @public
4132
4596
  * Placeholder documentation for Input
4133
4597
  */
4134
4598
  Input?: Input;
@@ -4139,10 +4603,12 @@ export interface CreateInputResponse {
4139
4603
  */
4140
4604
  export interface CreateInputSecurityGroupRequest {
4141
4605
  /**
4606
+ * @public
4142
4607
  * A collection of key-value pairs.
4143
4608
  */
4144
4609
  Tags?: Record<string, string>;
4145
4610
  /**
4611
+ * @public
4146
4612
  * List of IPv4 CIDR addresses to whitelist
4147
4613
  */
4148
4614
  WhitelistRules?: InputWhitelistRuleCidr[];
@@ -4153,6 +4619,7 @@ export interface CreateInputSecurityGroupRequest {
4153
4619
  */
4154
4620
  export interface CreateInputSecurityGroupResponse {
4155
4621
  /**
4622
+ * @public
4156
4623
  * An Input Security Group
4157
4624
  */
4158
4625
  SecurityGroup?: InputSecurityGroup;
@@ -4163,18 +4630,22 @@ export interface CreateInputSecurityGroupResponse {
4163
4630
  */
4164
4631
  export interface MultiplexSettings {
4165
4632
  /**
4633
+ * @public
4166
4634
  * Maximum video buffer delay in milliseconds.
4167
4635
  */
4168
4636
  MaximumVideoBufferDelayMilliseconds?: number;
4169
4637
  /**
4638
+ * @public
4170
4639
  * Transport stream bit rate.
4171
4640
  */
4172
4641
  TransportStreamBitrate: number | undefined;
4173
4642
  /**
4643
+ * @public
4174
4644
  * Transport stream ID.
4175
4645
  */
4176
4646
  TransportStreamId: number | undefined;
4177
4647
  /**
4648
+ * @public
4178
4649
  * Transport stream reserved bit rate.
4179
4650
  */
4180
4651
  TransportStreamReservedBitrate?: number;
@@ -4185,23 +4656,28 @@ export interface MultiplexSettings {
4185
4656
  */
4186
4657
  export interface CreateMultiplexRequest {
4187
4658
  /**
4659
+ * @public
4188
4660
  * A list of availability zones for the multiplex. You must specify exactly two.
4189
4661
  */
4190
4662
  AvailabilityZones: string[] | undefined;
4191
4663
  /**
4664
+ * @public
4192
4665
  * Configuration for a multiplex event.
4193
4666
  */
4194
4667
  MultiplexSettings: MultiplexSettings | undefined;
4195
4668
  /**
4669
+ * @public
4196
4670
  * Name of multiplex.
4197
4671
  */
4198
4672
  Name: string | undefined;
4199
4673
  /**
4674
+ * @public
4200
4675
  * Unique request ID. This prevents retries from creating multiple
4201
4676
  * resources.
4202
4677
  */
4203
4678
  RequestId?: string;
4204
4679
  /**
4680
+ * @public
4205
4681
  * A collection of key-value pairs.
4206
4682
  */
4207
4683
  Tags?: Record<string, string>;
@@ -4212,42 +4688,52 @@ export interface CreateMultiplexRequest {
4212
4688
  */
4213
4689
  export interface Multiplex {
4214
4690
  /**
4691
+ * @public
4215
4692
  * The unique arn of the multiplex.
4216
4693
  */
4217
4694
  Arn?: string;
4218
4695
  /**
4696
+ * @public
4219
4697
  * A list of availability zones for the multiplex.
4220
4698
  */
4221
4699
  AvailabilityZones?: string[];
4222
4700
  /**
4701
+ * @public
4223
4702
  * A list of the multiplex output destinations.
4224
4703
  */
4225
4704
  Destinations?: MultiplexOutputDestination[];
4226
4705
  /**
4706
+ * @public
4227
4707
  * The unique id of the multiplex.
4228
4708
  */
4229
4709
  Id?: string;
4230
4710
  /**
4711
+ * @public
4231
4712
  * Configuration for a multiplex event.
4232
4713
  */
4233
4714
  MultiplexSettings?: MultiplexSettings;
4234
4715
  /**
4716
+ * @public
4235
4717
  * The name of the multiplex.
4236
4718
  */
4237
4719
  Name?: string;
4238
4720
  /**
4721
+ * @public
4239
4722
  * The number of currently healthy pipelines.
4240
4723
  */
4241
4724
  PipelinesRunningCount?: number;
4242
4725
  /**
4726
+ * @public
4243
4727
  * The number of programs in the multiplex.
4244
4728
  */
4245
4729
  ProgramCount?: number;
4246
4730
  /**
4731
+ * @public
4247
4732
  * The current state of the multiplex.
4248
4733
  */
4249
4734
  State?: MultiplexState | string;
4250
4735
  /**
4736
+ * @public
4251
4737
  * A collection of key-value pairs.
4252
4738
  */
4253
4739
  Tags?: Record<string, string>;
@@ -4258,6 +4744,7 @@ export interface Multiplex {
4258
4744
  */
4259
4745
  export interface CreateMultiplexResponse {
4260
4746
  /**
4747
+ * @public
4261
4748
  * The newly created multiplex.
4262
4749
  */
4263
4750
  Multiplex?: Multiplex;
@@ -4281,10 +4768,12 @@ export type PreferredChannelPipeline = (typeof PreferredChannelPipeline)[keyof t
4281
4768
  */
4282
4769
  export interface MultiplexProgramServiceDescriptor {
4283
4770
  /**
4771
+ * @public
4284
4772
  * Name of the provider.
4285
4773
  */
4286
4774
  ProviderName: string | undefined;
4287
4775
  /**
4776
+ * @public
4288
4777
  * Name of the service.
4289
4778
  */
4290
4779
  ServiceName: string | undefined;
@@ -4295,14 +4784,17 @@ export interface MultiplexProgramServiceDescriptor {
4295
4784
  */
4296
4785
  export interface MultiplexStatmuxVideoSettings {
4297
4786
  /**
4787
+ * @public
4298
4788
  * Maximum statmux bitrate.
4299
4789
  */
4300
4790
  MaximumBitrate?: number;
4301
4791
  /**
4792
+ * @public
4302
4793
  * Minimum statmux bitrate.
4303
4794
  */
4304
4795
  MinimumBitrate?: number;
4305
4796
  /**
4797
+ * @public
4306
4798
  * The purpose of the priority is to use a combination of the\nmultiplex rate control algorithm and the QVBR capability of the\nencoder to prioritize the video quality of some channels in a\nmultiplex over others. Channels that have a higher priority will\nget higher video quality at the expense of the video quality of\nother channels in the multiplex with lower priority.
4307
4799
  */
4308
4800
  Priority?: number;
@@ -4313,11 +4805,13 @@ export interface MultiplexStatmuxVideoSettings {
4313
4805
  */
4314
4806
  export interface MultiplexVideoSettings {
4315
4807
  /**
4808
+ * @public
4316
4809
  * The constant bitrate configuration for the video encode.
4317
4810
  * When this field is defined, StatmuxSettings must be undefined.
4318
4811
  */
4319
4812
  ConstantBitrate?: number;
4320
4813
  /**
4814
+ * @public
4321
4815
  * Statmux rate control settings.
4322
4816
  * When this field is defined, ConstantBitrate must be undefined.
4323
4817
  */
@@ -4329,18 +4823,22 @@ export interface MultiplexVideoSettings {
4329
4823
  */
4330
4824
  export interface MultiplexProgramSettings {
4331
4825
  /**
4826
+ * @public
4332
4827
  * Indicates which pipeline is preferred by the multiplex for program ingest.
4333
4828
  */
4334
4829
  PreferredChannelPipeline?: PreferredChannelPipeline | string;
4335
4830
  /**
4831
+ * @public
4336
4832
  * Unique program number.
4337
4833
  */
4338
4834
  ProgramNumber: number | undefined;
4339
4835
  /**
4836
+ * @public
4340
4837
  * Transport stream service descriptor configuration for the Multiplex program.
4341
4838
  */
4342
4839
  ServiceDescriptor?: MultiplexProgramServiceDescriptor;
4343
4840
  /**
4841
+ * @public
4344
4842
  * Program video settings configuration.
4345
4843
  */
4346
4844
  VideoSettings?: MultiplexVideoSettings;
@@ -4351,18 +4849,22 @@ export interface MultiplexProgramSettings {
4351
4849
  */
4352
4850
  export interface CreateMultiplexProgramRequest {
4353
4851
  /**
4852
+ * @public
4354
4853
  * ID of the multiplex where the program is to be created.
4355
4854
  */
4356
4855
  MultiplexId: string | undefined;
4357
4856
  /**
4857
+ * @public
4358
4858
  * The settings for this multiplex program.
4359
4859
  */
4360
4860
  MultiplexProgramSettings: MultiplexProgramSettings | undefined;
4361
4861
  /**
4862
+ * @public
4362
4863
  * Name of multiplex program.
4363
4864
  */
4364
4865
  ProgramName: string | undefined;
4365
4866
  /**
4867
+ * @public
4366
4868
  * Unique request ID. This prevents retries from creating multiple
4367
4869
  * resources.
4368
4870
  */
@@ -4374,54 +4876,67 @@ export interface CreateMultiplexProgramRequest {
4374
4876
  */
4375
4877
  export interface MultiplexProgramPacketIdentifiersMap {
4376
4878
  /**
4879
+ * @public
4377
4880
  * Placeholder documentation for __listOf__integer
4378
4881
  */
4379
4882
  AudioPids?: number[];
4380
4883
  /**
4884
+ * @public
4381
4885
  * Placeholder documentation for __listOf__integer
4382
4886
  */
4383
4887
  DvbSubPids?: number[];
4384
4888
  /**
4889
+ * @public
4385
4890
  * Placeholder documentation for __integer
4386
4891
  */
4387
4892
  DvbTeletextPid?: number;
4388
4893
  /**
4894
+ * @public
4389
4895
  * Placeholder documentation for __integer
4390
4896
  */
4391
4897
  EtvPlatformPid?: number;
4392
4898
  /**
4899
+ * @public
4393
4900
  * Placeholder documentation for __integer
4394
4901
  */
4395
4902
  EtvSignalPid?: number;
4396
4903
  /**
4904
+ * @public
4397
4905
  * Placeholder documentation for __listOf__integer
4398
4906
  */
4399
4907
  KlvDataPids?: number[];
4400
4908
  /**
4909
+ * @public
4401
4910
  * Placeholder documentation for __integer
4402
4911
  */
4403
4912
  PcrPid?: number;
4404
4913
  /**
4914
+ * @public
4405
4915
  * Placeholder documentation for __integer
4406
4916
  */
4407
4917
  PmtPid?: number;
4408
4918
  /**
4919
+ * @public
4409
4920
  * Placeholder documentation for __integer
4410
4921
  */
4411
4922
  PrivateMetadataPid?: number;
4412
4923
  /**
4924
+ * @public
4413
4925
  * Placeholder documentation for __listOf__integer
4414
4926
  */
4415
4927
  Scte27Pids?: number[];
4416
4928
  /**
4929
+ * @public
4417
4930
  * Placeholder documentation for __integer
4418
4931
  */
4419
4932
  Scte35Pid?: number;
4420
4933
  /**
4934
+ * @public
4421
4935
  * Placeholder documentation for __integer
4422
4936
  */
4423
4937
  TimedMetadataPid?: number;
4424
4938
  /**
4939
+ * @public
4425
4940
  * Placeholder documentation for __integer
4426
4941
  */
4427
4942
  VideoPid?: number;
@@ -4432,22 +4947,27 @@ export interface MultiplexProgramPacketIdentifiersMap {
4432
4947
  */
4433
4948
  export interface MultiplexProgram {
4434
4949
  /**
4950
+ * @public
4435
4951
  * The MediaLive channel associated with the program.
4436
4952
  */
4437
4953
  ChannelId?: string;
4438
4954
  /**
4955
+ * @public
4439
4956
  * The settings for this multiplex program.
4440
4957
  */
4441
4958
  MultiplexProgramSettings?: MultiplexProgramSettings;
4442
4959
  /**
4960
+ * @public
4443
4961
  * The packet identifier map for this multiplex program.
4444
4962
  */
4445
4963
  PacketIdentifiersMap?: MultiplexProgramPacketIdentifiersMap;
4446
4964
  /**
4965
+ * @public
4447
4966
  * Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
4448
4967
  */
4449
4968
  PipelineDetails?: MultiplexProgramPipelineDetail[];
4450
4969
  /**
4970
+ * @public
4451
4971
  * The name of the multiplex program.
4452
4972
  */
4453
4973
  ProgramName?: string;
@@ -4458,6 +4978,7 @@ export interface MultiplexProgram {
4458
4978
  */
4459
4979
  export interface CreateMultiplexProgramResponse {
4460
4980
  /**
4981
+ * @public
4461
4982
  * The newly created multiplex program.
4462
4983
  */
4463
4984
  MultiplexProgram?: MultiplexProgram;
@@ -4468,15 +4989,18 @@ export interface CreateMultiplexProgramResponse {
4468
4989
  */
4469
4990
  export interface CreatePartnerInputRequest {
4470
4991
  /**
4992
+ * @public
4471
4993
  * Unique ID of the input.
4472
4994
  */
4473
4995
  InputId: string | undefined;
4474
4996
  /**
4997
+ * @public
4475
4998
  * Unique identifier of the request to ensure the request is handled
4476
4999
  * exactly once in case of retries.
4477
5000
  */
4478
5001
  RequestId?: string;
4479
5002
  /**
5003
+ * @public
4480
5004
  * A collection of key-value pairs.
4481
5005
  */
4482
5006
  Tags?: Record<string, string>;
@@ -4487,6 +5011,7 @@ export interface CreatePartnerInputRequest {
4487
5011
  */
4488
5012
  export interface CreatePartnerInputResponse {
4489
5013
  /**
5014
+ * @public
4490
5015
  * Placeholder documentation for Input
4491
5016
  */
4492
5017
  Input?: Input;
@@ -4497,10 +5022,12 @@ export interface CreatePartnerInputResponse {
4497
5022
  */
4498
5023
  export interface CreateTagsRequest {
4499
5024
  /**
5025
+ * @public
4500
5026
  * Placeholder documentation for __string
4501
5027
  */
4502
5028
  ResourceArn: string | undefined;
4503
5029
  /**
5030
+ * @public
4504
5031
  * Placeholder documentation for Tags
4505
5032
  */
4506
5033
  Tags?: Record<string, string>;
@@ -4511,6 +5038,7 @@ export interface CreateTagsRequest {
4511
5038
  */
4512
5039
  export interface DeleteChannelRequest {
4513
5040
  /**
5041
+ * @public
4514
5042
  * Unique ID of the channel.
4515
5043
  */
4516
5044
  ChannelId: string | undefined;
@@ -4521,76 +5049,94 @@ export interface DeleteChannelRequest {
4521
5049
  */
4522
5050
  export interface DeleteChannelResponse {
4523
5051
  /**
5052
+ * @public
4524
5053
  * The unique arn of the channel.
4525
5054
  */
4526
5055
  Arn?: string;
4527
5056
  /**
5057
+ * @public
4528
5058
  * Specification of CDI inputs for this channel
4529
5059
  */
4530
5060
  CdiInputSpecification?: CdiInputSpecification;
4531
5061
  /**
5062
+ * @public
4532
5063
  * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
4533
5064
  */
4534
5065
  ChannelClass?: ChannelClass | string;
4535
5066
  /**
5067
+ * @public
4536
5068
  * A list of destinations of the channel. For UDP outputs, there is one
4537
5069
  * destination per output. For other types (HLS, for example), there is
4538
5070
  * one destination per packager.
4539
5071
  */
4540
5072
  Destinations?: OutputDestination[];
4541
5073
  /**
5074
+ * @public
4542
5075
  * The endpoints where outgoing connections initiate from
4543
5076
  */
4544
5077
  EgressEndpoints?: ChannelEgressEndpoint[];
4545
5078
  /**
5079
+ * @public
4546
5080
  * Encoder Settings
4547
5081
  */
4548
5082
  EncoderSettings?: EncoderSettings;
4549
5083
  /**
5084
+ * @public
4550
5085
  * The unique id of the channel.
4551
5086
  */
4552
5087
  Id?: string;
4553
5088
  /**
5089
+ * @public
4554
5090
  * List of input attachments for channel.
4555
5091
  */
4556
5092
  InputAttachments?: InputAttachment[];
4557
5093
  /**
5094
+ * @public
4558
5095
  * Specification of network and file inputs for this channel
4559
5096
  */
4560
5097
  InputSpecification?: InputSpecification;
4561
5098
  /**
5099
+ * @public
4562
5100
  * The log level being written to CloudWatch Logs.
4563
5101
  */
4564
5102
  LogLevel?: LogLevel | string;
4565
5103
  /**
5104
+ * @public
4566
5105
  * Maintenance settings for this channel.
4567
5106
  */
4568
5107
  Maintenance?: MaintenanceStatus;
4569
5108
  /**
5109
+ * @public
4570
5110
  * The name of the channel. (user-mutable)
4571
5111
  */
4572
5112
  Name?: string;
4573
5113
  /**
5114
+ * @public
4574
5115
  * Runtime details for the pipelines of a running channel.
4575
5116
  */
4576
5117
  PipelineDetails?: PipelineDetail[];
4577
5118
  /**
5119
+ * @public
4578
5120
  * The number of currently healthy pipelines.
4579
5121
  */
4580
5122
  PipelinesRunningCount?: number;
4581
5123
  /**
5124
+ * @public
4582
5125
  * The Amazon Resource Name (ARN) of the role assumed when running the Channel.
4583
5126
  */
4584
5127
  RoleArn?: string;
4585
5128
  /**
5129
+ * @public
4586
5130
  * Placeholder documentation for ChannelState
4587
5131
  */
4588
5132
  State?: ChannelState | string;
4589
5133
  /**
5134
+ * @public
4590
5135
  * A collection of key-value pairs.
4591
5136
  */
4592
5137
  Tags?: Record<string, string>;
4593
5138
  /**
5139
+ * @public
4594
5140
  * Settings for VPC output
4595
5141
  */
4596
5142
  Vpc?: VpcOutputSettingsDescription;
@@ -4601,6 +5147,7 @@ export interface DeleteChannelResponse {
4601
5147
  */
4602
5148
  export interface DeleteInputRequest {
4603
5149
  /**
5150
+ * @public
4604
5151
  * Unique ID of the input
4605
5152
  */
4606
5153
  InputId: string | undefined;
@@ -4617,6 +5164,7 @@ export interface DeleteInputResponse {
4617
5164
  */
4618
5165
  export interface DeleteInputSecurityGroupRequest {
4619
5166
  /**
5167
+ * @public
4620
5168
  * The Input Security Group to delete
4621
5169
  */
4622
5170
  InputSecurityGroupId: string | undefined;
@@ -4633,6 +5181,7 @@ export interface DeleteInputSecurityGroupResponse {
4633
5181
  */
4634
5182
  export interface DeleteMultiplexRequest {
4635
5183
  /**
5184
+ * @public
4636
5185
  * The ID of the multiplex.
4637
5186
  */
4638
5187
  MultiplexId: string | undefined;
@@ -4643,42 +5192,52 @@ export interface DeleteMultiplexRequest {
4643
5192
  */
4644
5193
  export interface DeleteMultiplexResponse {
4645
5194
  /**
5195
+ * @public
4646
5196
  * The unique arn of the multiplex.
4647
5197
  */
4648
5198
  Arn?: string;
4649
5199
  /**
5200
+ * @public
4650
5201
  * A list of availability zones for the multiplex.
4651
5202
  */
4652
5203
  AvailabilityZones?: string[];
4653
5204
  /**
5205
+ * @public
4654
5206
  * A list of the multiplex output destinations.
4655
5207
  */
4656
5208
  Destinations?: MultiplexOutputDestination[];
4657
5209
  /**
5210
+ * @public
4658
5211
  * The unique id of the multiplex.
4659
5212
  */
4660
5213
  Id?: string;
4661
5214
  /**
5215
+ * @public
4662
5216
  * Configuration for a multiplex event.
4663
5217
  */
4664
5218
  MultiplexSettings?: MultiplexSettings;
4665
5219
  /**
5220
+ * @public
4666
5221
  * The name of the multiplex.
4667
5222
  */
4668
5223
  Name?: string;
4669
5224
  /**
5225
+ * @public
4670
5226
  * The number of currently healthy pipelines.
4671
5227
  */
4672
5228
  PipelinesRunningCount?: number;
4673
5229
  /**
5230
+ * @public
4674
5231
  * The number of programs in the multiplex.
4675
5232
  */
4676
5233
  ProgramCount?: number;
4677
5234
  /**
5235
+ * @public
4678
5236
  * The current state of the multiplex.
4679
5237
  */
4680
5238
  State?: MultiplexState | string;
4681
5239
  /**
5240
+ * @public
4682
5241
  * A collection of key-value pairs.
4683
5242
  */
4684
5243
  Tags?: Record<string, string>;
@@ -4689,10 +5248,12 @@ export interface DeleteMultiplexResponse {
4689
5248
  */
4690
5249
  export interface DeleteMultiplexProgramRequest {
4691
5250
  /**
5251
+ * @public
4692
5252
  * The ID of the multiplex that the program belongs to.
4693
5253
  */
4694
5254
  MultiplexId: string | undefined;
4695
5255
  /**
5256
+ * @public
4696
5257
  * The multiplex program name.
4697
5258
  */
4698
5259
  ProgramName: string | undefined;
@@ -4703,22 +5264,27 @@ export interface DeleteMultiplexProgramRequest {
4703
5264
  */
4704
5265
  export interface DeleteMultiplexProgramResponse {
4705
5266
  /**
5267
+ * @public
4706
5268
  * The MediaLive channel associated with the program.
4707
5269
  */
4708
5270
  ChannelId?: string;
4709
5271
  /**
5272
+ * @public
4710
5273
  * The settings for this multiplex program.
4711
5274
  */
4712
5275
  MultiplexProgramSettings?: MultiplexProgramSettings;
4713
5276
  /**
5277
+ * @public
4714
5278
  * The packet identifier map for this multiplex program.
4715
5279
  */
4716
5280
  PacketIdentifiersMap?: MultiplexProgramPacketIdentifiersMap;
4717
5281
  /**
5282
+ * @public
4718
5283
  * Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
4719
5284
  */
4720
5285
  PipelineDetails?: MultiplexProgramPipelineDetail[];
4721
5286
  /**
5287
+ * @public
4722
5288
  * The name of the multiplex program.
4723
5289
  */
4724
5290
  ProgramName?: string;
@@ -4729,6 +5295,7 @@ export interface DeleteMultiplexProgramResponse {
4729
5295
  */
4730
5296
  export interface DeleteReservationRequest {
4731
5297
  /**
5298
+ * @public
4732
5299
  * Unique reservation ID, e.g. '1234567'
4733
5300
  */
4734
5301
  ReservationId: string | undefined;
@@ -4739,78 +5306,97 @@ export interface DeleteReservationRequest {
4739
5306
  */
4740
5307
  export interface DeleteReservationResponse {
4741
5308
  /**
5309
+ * @public
4742
5310
  * Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
4743
5311
  */
4744
5312
  Arn?: string;
4745
5313
  /**
5314
+ * @public
4746
5315
  * Number of reserved resources
4747
5316
  */
4748
5317
  Count?: number;
4749
5318
  /**
5319
+ * @public
4750
5320
  * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
4751
5321
  */
4752
5322
  CurrencyCode?: string;
4753
5323
  /**
5324
+ * @public
4754
5325
  * Lease duration, e.g. '12'
4755
5326
  */
4756
5327
  Duration?: number;
4757
5328
  /**
5329
+ * @public
4758
5330
  * Units for duration, e.g. 'MONTHS'
4759
5331
  */
4760
5332
  DurationUnits?: OfferingDurationUnits | string;
4761
5333
  /**
5334
+ * @public
4762
5335
  * Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
4763
5336
  */
4764
5337
  End?: string;
4765
5338
  /**
5339
+ * @public
4766
5340
  * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
4767
5341
  */
4768
5342
  FixedPrice?: number;
4769
5343
  /**
5344
+ * @public
4770
5345
  * User specified reservation name
4771
5346
  */
4772
5347
  Name?: string;
4773
5348
  /**
5349
+ * @public
4774
5350
  * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
4775
5351
  */
4776
5352
  OfferingDescription?: string;
4777
5353
  /**
5354
+ * @public
4778
5355
  * Unique offering ID, e.g. '87654321'
4779
5356
  */
4780
5357
  OfferingId?: string;
4781
5358
  /**
5359
+ * @public
4782
5360
  * Offering type, e.g. 'NO_UPFRONT'
4783
5361
  */
4784
5362
  OfferingType?: OfferingType | string;
4785
5363
  /**
5364
+ * @public
4786
5365
  * AWS region, e.g. 'us-west-2'
4787
5366
  */
4788
5367
  Region?: string;
4789
5368
  /**
5369
+ * @public
4790
5370
  * Renewal settings for the reservation
4791
5371
  */
4792
5372
  RenewalSettings?: RenewalSettings;
4793
5373
  /**
5374
+ * @public
4794
5375
  * Unique reservation ID, e.g. '1234567'
4795
5376
  */
4796
5377
  ReservationId?: string;
4797
5378
  /**
5379
+ * @public
4798
5380
  * Resource configuration details
4799
5381
  */
4800
5382
  ResourceSpecification?: ReservationResourceSpecification;
4801
5383
  /**
5384
+ * @public
4802
5385
  * Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
4803
5386
  */
4804
5387
  Start?: string;
4805
5388
  /**
5389
+ * @public
4806
5390
  * Current state of reservation, e.g. 'ACTIVE'
4807
5391
  */
4808
5392
  State?: ReservationState | string;
4809
5393
  /**
5394
+ * @public
4810
5395
  * A collection of key-value pairs
4811
5396
  */
4812
5397
  Tags?: Record<string, string>;
4813
5398
  /**
5399
+ * @public
4814
5400
  * Recurring usage charge for each reserved resource, e.g. '157.0'
4815
5401
  */
4816
5402
  UsagePrice?: number;
@@ -4821,6 +5407,7 @@ export interface DeleteReservationResponse {
4821
5407
  */
4822
5408
  export interface DeleteScheduleRequest {
4823
5409
  /**
5410
+ * @public
4824
5411
  * Id of the channel whose schedule is being deleted.
4825
5412
  */
4826
5413
  ChannelId: string | undefined;
@@ -4837,10 +5424,12 @@ export interface DeleteScheduleResponse {
4837
5424
  */
4838
5425
  export interface DeleteTagsRequest {
4839
5426
  /**
5427
+ * @public
4840
5428
  * Placeholder documentation for __string
4841
5429
  */
4842
5430
  ResourceArn: string | undefined;
4843
5431
  /**
5432
+ * @public
4844
5433
  * An array of tag keys to delete
4845
5434
  */
4846
5435
  TagKeys: string[] | undefined;
@@ -4857,6 +5446,7 @@ export interface DescribeAccountConfigurationRequest {
4857
5446
  */
4858
5447
  export interface DescribeAccountConfigurationResponse {
4859
5448
  /**
5449
+ * @public
4860
5450
  * Placeholder documentation for AccountConfiguration
4861
5451
  */
4862
5452
  AccountConfiguration?: AccountConfiguration;
@@ -4867,6 +5457,7 @@ export interface DescribeAccountConfigurationResponse {
4867
5457
  */
4868
5458
  export interface DescribeChannelRequest {
4869
5459
  /**
5460
+ * @public
4870
5461
  * channel ID
4871
5462
  */
4872
5463
  ChannelId: string | undefined;
@@ -4877,76 +5468,94 @@ export interface DescribeChannelRequest {
4877
5468
  */
4878
5469
  export interface DescribeChannelResponse {
4879
5470
  /**
5471
+ * @public
4880
5472
  * The unique arn of the channel.
4881
5473
  */
4882
5474
  Arn?: string;
4883
5475
  /**
5476
+ * @public
4884
5477
  * Specification of CDI inputs for this channel
4885
5478
  */
4886
5479
  CdiInputSpecification?: CdiInputSpecification;
4887
5480
  /**
5481
+ * @public
4888
5482
  * The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
4889
5483
  */
4890
5484
  ChannelClass?: ChannelClass | string;
4891
5485
  /**
5486
+ * @public
4892
5487
  * A list of destinations of the channel. For UDP outputs, there is one
4893
5488
  * destination per output. For other types (HLS, for example), there is
4894
5489
  * one destination per packager.
4895
5490
  */
4896
5491
  Destinations?: OutputDestination[];
4897
5492
  /**
5493
+ * @public
4898
5494
  * The endpoints where outgoing connections initiate from
4899
5495
  */
4900
5496
  EgressEndpoints?: ChannelEgressEndpoint[];
4901
5497
  /**
5498
+ * @public
4902
5499
  * Encoder Settings
4903
5500
  */
4904
5501
  EncoderSettings?: EncoderSettings;
4905
5502
  /**
5503
+ * @public
4906
5504
  * The unique id of the channel.
4907
5505
  */
4908
5506
  Id?: string;
4909
5507
  /**
5508
+ * @public
4910
5509
  * List of input attachments for channel.
4911
5510
  */
4912
5511
  InputAttachments?: InputAttachment[];
4913
5512
  /**
5513
+ * @public
4914
5514
  * Specification of network and file inputs for this channel
4915
5515
  */
4916
5516
  InputSpecification?: InputSpecification;
4917
5517
  /**
5518
+ * @public
4918
5519
  * The log level being written to CloudWatch Logs.
4919
5520
  */
4920
5521
  LogLevel?: LogLevel | string;
4921
5522
  /**
5523
+ * @public
4922
5524
  * Maintenance settings for this channel.
4923
5525
  */
4924
5526
  Maintenance?: MaintenanceStatus;
4925
5527
  /**
5528
+ * @public
4926
5529
  * The name of the channel. (user-mutable)
4927
5530
  */
4928
5531
  Name?: string;
4929
5532
  /**
5533
+ * @public
4930
5534
  * Runtime details for the pipelines of a running channel.
4931
5535
  */
4932
5536
  PipelineDetails?: PipelineDetail[];
4933
5537
  /**
5538
+ * @public
4934
5539
  * The number of currently healthy pipelines.
4935
5540
  */
4936
5541
  PipelinesRunningCount?: number;
4937
5542
  /**
5543
+ * @public
4938
5544
  * The Amazon Resource Name (ARN) of the role assumed when running the Channel.
4939
5545
  */
4940
5546
  RoleArn?: string;
4941
5547
  /**
5548
+ * @public
4942
5549
  * Placeholder documentation for ChannelState
4943
5550
  */
4944
5551
  State?: ChannelState | string;
4945
5552
  /**
5553
+ * @public
4946
5554
  * A collection of key-value pairs.
4947
5555
  */
4948
5556
  Tags?: Record<string, string>;
4949
5557
  /**
5558
+ * @public
4950
5559
  * Settings for VPC output
4951
5560
  */
4952
5561
  Vpc?: VpcOutputSettingsDescription;
@@ -4957,6 +5566,7 @@ export interface DescribeChannelResponse {
4957
5566
  */
4958
5567
  export interface DescribeInputRequest {
4959
5568
  /**
5569
+ * @public
4960
5570
  * Unique ID of the input
4961
5571
  */
4962
5572
  InputId: string | undefined;
@@ -4967,68 +5577,84 @@ export interface DescribeInputRequest {
4967
5577
  */
4968
5578
  export interface DescribeInputResponse {
4969
5579
  /**
5580
+ * @public
4970
5581
  * The Unique ARN of the input (generated, immutable).
4971
5582
  */
4972
5583
  Arn?: string;
4973
5584
  /**
5585
+ * @public
4974
5586
  * A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
4975
5587
  */
4976
5588
  AttachedChannels?: string[];
4977
5589
  /**
5590
+ * @public
4978
5591
  * A list of the destinations of the input (PUSH-type).
4979
5592
  */
4980
5593
  Destinations?: InputDestination[];
4981
5594
  /**
5595
+ * @public
4982
5596
  * The generated ID of the input (unique for user account, immutable).
4983
5597
  */
4984
5598
  Id?: string;
4985
5599
  /**
5600
+ * @public
4986
5601
  * STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.
4987
5602
  * SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.
4988
5603
  */
4989
5604
  InputClass?: InputClass | string;
4990
5605
  /**
5606
+ * @public
4991
5607
  * Settings for the input devices.
4992
5608
  */
4993
5609
  InputDevices?: InputDeviceSettings[];
4994
5610
  /**
5611
+ * @public
4995
5612
  * A list of IDs for all Inputs which are partners of this one.
4996
5613
  */
4997
5614
  InputPartnerIds?: string[];
4998
5615
  /**
5616
+ * @public
4999
5617
  * Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes
5000
5618
  * during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.
5001
5619
  */
5002
5620
  InputSourceType?: InputSourceType | string;
5003
5621
  /**
5622
+ * @public
5004
5623
  * A list of MediaConnect Flows for this input.
5005
5624
  */
5006
5625
  MediaConnectFlows?: MediaConnectFlow[];
5007
5626
  /**
5627
+ * @public
5008
5628
  * The user-assigned name (This is a mutable value).
5009
5629
  */
5010
5630
  Name?: string;
5011
5631
  /**
5632
+ * @public
5012
5633
  * The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
5013
5634
  */
5014
5635
  RoleArn?: string;
5015
5636
  /**
5637
+ * @public
5016
5638
  * A list of IDs for all the Input Security Groups attached to the input.
5017
5639
  */
5018
5640
  SecurityGroups?: string[];
5019
5641
  /**
5642
+ * @public
5020
5643
  * A list of the sources of the input (PULL-type).
5021
5644
  */
5022
5645
  Sources?: InputSource[];
5023
5646
  /**
5647
+ * @public
5024
5648
  * Placeholder documentation for InputState
5025
5649
  */
5026
5650
  State?: InputState | string;
5027
5651
  /**
5652
+ * @public
5028
5653
  * A collection of key-value pairs.
5029
5654
  */
5030
5655
  Tags?: Record<string, string>;
5031
5656
  /**
5657
+ * @public
5032
5658
  * The different types of inputs that AWS Elemental MediaLive supports.
5033
5659
  */
5034
5660
  Type?: InputType | string;
@@ -5039,6 +5665,7 @@ export interface DescribeInputResponse {
5039
5665
  */
5040
5666
  export interface DescribeInputDeviceRequest {
5041
5667
  /**
5668
+ * @public
5042
5669
  * The unique ID of this input device. For example, hd-123456789abcdef.
5043
5670
  */
5044
5671
  InputDeviceId: string | undefined;
@@ -5049,57 +5676,75 @@ export interface DescribeInputDeviceRequest {
5049
5676
  */
5050
5677
  export interface DescribeInputDeviceResponse {
5051
5678
  /**
5679
+ * @public
5052
5680
  * The unique ARN of the input device.
5053
5681
  */
5054
5682
  Arn?: string;
5055
5683
  /**
5684
+ * @public
5056
5685
  * The state of the connection between the input device and AWS.
5057
5686
  */
5058
5687
  ConnectionState?: InputDeviceConnectionState | string;
5059
5688
  /**
5689
+ * @public
5060
5690
  * The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
5061
5691
  */
5062
5692
  DeviceSettingsSyncState?: DeviceSettingsSyncState | string;
5063
5693
  /**
5694
+ * @public
5064
5695
  * The status of software on the input device.
5065
5696
  */
5066
5697
  DeviceUpdateStatus?: DeviceUpdateStatus | string;
5067
5698
  /**
5699
+ * @public
5068
5700
  * Settings that describe an input device that is type HD.
5069
5701
  */
5070
5702
  HdDeviceSettings?: InputDeviceHdSettings;
5071
5703
  /**
5704
+ * @public
5072
5705
  * The unique ID of the input device.
5073
5706
  */
5074
5707
  Id?: string;
5075
5708
  /**
5709
+ * @public
5076
5710
  * The network MAC address of the input device.
5077
5711
  */
5078
5712
  MacAddress?: string;
5079
5713
  /**
5714
+ * @public
5080
5715
  * A name that you specify for the input device.
5081
5716
  */
5082
5717
  Name?: string;
5083
5718
  /**
5719
+ * @public
5084
5720
  * The network settings for the input device.
5085
5721
  */
5086
5722
  NetworkSettings?: InputDeviceNetworkSettings;
5087
5723
  /**
5724
+ * @public
5088
5725
  * The unique serial number of the input device.
5089
5726
  */
5090
5727
  SerialNumber?: string;
5091
5728
  /**
5729
+ * @public
5092
5730
  * The type of the input device.
5093
5731
  */
5094
5732
  Type?: InputDeviceType | string;
5095
5733
  /**
5734
+ * @public
5096
5735
  * Settings that describe an input device that is type UHD.
5097
5736
  */
5098
5737
  UhdDeviceSettings?: InputDeviceUhdSettings;
5099
5738
  /**
5739
+ * @public
5100
5740
  * A collection of key-value pairs.
5101
5741
  */
5102
5742
  Tags?: Record<string, string>;
5743
+ /**
5744
+ * @public
5745
+ * The Availability Zone associated with this input device.
5746
+ */
5747
+ AvailabilityZone?: string;
5103
5748
  }
5104
5749
  /**
5105
5750
  * @public
@@ -5107,10 +5752,12 @@ export interface DescribeInputDeviceResponse {
5107
5752
  */
5108
5753
  export interface DescribeInputDeviceThumbnailRequest {
5109
5754
  /**
5755
+ * @public
5110
5756
  * The unique ID of this input device. For example, hd-123456789abcdef.
5111
5757
  */
5112
5758
  InputDeviceId: string | undefined;
5113
5759
  /**
5760
+ * @public
5114
5761
  * The HTTP Accept header. Indicates the requested type for the thumbnail.
5115
5762
  */
5116
5763
  Accept: AcceptHeader | string | undefined;
@@ -5121,22 +5768,27 @@ export interface DescribeInputDeviceThumbnailRequest {
5121
5768
  */
5122
5769
  export interface DescribeInputDeviceThumbnailResponse {
5123
5770
  /**
5771
+ * @public
5124
5772
  * The binary data for the thumbnail that the Link device has most recently sent to MediaLive.
5125
5773
  */
5126
5774
  Body?: StreamingBlobTypes;
5127
5775
  /**
5776
+ * @public
5128
5777
  * Specifies the media type of the thumbnail.
5129
5778
  */
5130
5779
  ContentType?: ContentType | string;
5131
5780
  /**
5781
+ * @public
5132
5782
  * The length of the content.
5133
5783
  */
5134
5784
  ContentLength?: number;
5135
5785
  /**
5786
+ * @public
5136
5787
  * The unique, cacheable version of this thumbnail.
5137
5788
  */
5138
5789
  ETag?: string;
5139
5790
  /**
5791
+ * @public
5140
5792
  * The date and time the thumbnail was last updated at the device.
5141
5793
  */
5142
5794
  LastModified?: Date;
@@ -5147,6 +5799,7 @@ export interface DescribeInputDeviceThumbnailResponse {
5147
5799
  */
5148
5800
  export interface DescribeInputSecurityGroupRequest {
5149
5801
  /**
5802
+ * @public
5150
5803
  * The id of the Input Security Group to describe
5151
5804
  */
5152
5805
  InputSecurityGroupId: string | undefined;
@@ -5157,26 +5810,32 @@ export interface DescribeInputSecurityGroupRequest {
5157
5810
  */
5158
5811
  export interface DescribeInputSecurityGroupResponse {
5159
5812
  /**
5813
+ * @public
5160
5814
  * Unique ARN of Input Security Group
5161
5815
  */
5162
5816
  Arn?: string;
5163
5817
  /**
5818
+ * @public
5164
5819
  * The Id of the Input Security Group
5165
5820
  */
5166
5821
  Id?: string;
5167
5822
  /**
5823
+ * @public
5168
5824
  * The list of inputs currently using this Input Security Group.
5169
5825
  */
5170
5826
  Inputs?: string[];
5171
5827
  /**
5828
+ * @public
5172
5829
  * The current state of the Input Security Group.
5173
5830
  */
5174
5831
  State?: InputSecurityGroupState | string;
5175
5832
  /**
5833
+ * @public
5176
5834
  * A collection of key-value pairs.
5177
5835
  */
5178
5836
  Tags?: Record<string, string>;
5179
5837
  /**
5838
+ * @public
5180
5839
  * Whitelist rules and their sync status
5181
5840
  */
5182
5841
  WhitelistRules?: InputWhitelistRule[];
@@ -5187,6 +5846,7 @@ export interface DescribeInputSecurityGroupResponse {
5187
5846
  */
5188
5847
  export interface DescribeMultiplexRequest {
5189
5848
  /**
5849
+ * @public
5190
5850
  * The ID of the multiplex.
5191
5851
  */
5192
5852
  MultiplexId: string | undefined;
@@ -5197,42 +5857,52 @@ export interface DescribeMultiplexRequest {
5197
5857
  */
5198
5858
  export interface DescribeMultiplexResponse {
5199
5859
  /**
5860
+ * @public
5200
5861
  * The unique arn of the multiplex.
5201
5862
  */
5202
5863
  Arn?: string;
5203
5864
  /**
5865
+ * @public
5204
5866
  * A list of availability zones for the multiplex.
5205
5867
  */
5206
5868
  AvailabilityZones?: string[];
5207
5869
  /**
5870
+ * @public
5208
5871
  * A list of the multiplex output destinations.
5209
5872
  */
5210
5873
  Destinations?: MultiplexOutputDestination[];
5211
5874
  /**
5875
+ * @public
5212
5876
  * The unique id of the multiplex.
5213
5877
  */
5214
5878
  Id?: string;
5215
5879
  /**
5880
+ * @public
5216
5881
  * Configuration for a multiplex event.
5217
5882
  */
5218
5883
  MultiplexSettings?: MultiplexSettings;
5219
5884
  /**
5885
+ * @public
5220
5886
  * The name of the multiplex.
5221
5887
  */
5222
5888
  Name?: string;
5223
5889
  /**
5890
+ * @public
5224
5891
  * The number of currently healthy pipelines.
5225
5892
  */
5226
5893
  PipelinesRunningCount?: number;
5227
5894
  /**
5895
+ * @public
5228
5896
  * The number of programs in the multiplex.
5229
5897
  */
5230
5898
  ProgramCount?: number;
5231
5899
  /**
5900
+ * @public
5232
5901
  * The current state of the multiplex.
5233
5902
  */
5234
5903
  State?: MultiplexState | string;
5235
5904
  /**
5905
+ * @public
5236
5906
  * A collection of key-value pairs.
5237
5907
  */
5238
5908
  Tags?: Record<string, string>;
@@ -5243,10 +5913,12 @@ export interface DescribeMultiplexResponse {
5243
5913
  */
5244
5914
  export interface DescribeMultiplexProgramRequest {
5245
5915
  /**
5916
+ * @public
5246
5917
  * The ID of the multiplex that the program belongs to.
5247
5918
  */
5248
5919
  MultiplexId: string | undefined;
5249
5920
  /**
5921
+ * @public
5250
5922
  * The name of the program.
5251
5923
  */
5252
5924
  ProgramName: string | undefined;
@@ -5257,22 +5929,27 @@ export interface DescribeMultiplexProgramRequest {
5257
5929
  */
5258
5930
  export interface DescribeMultiplexProgramResponse {
5259
5931
  /**
5932
+ * @public
5260
5933
  * The MediaLive channel associated with the program.
5261
5934
  */
5262
5935
  ChannelId?: string;
5263
5936
  /**
5937
+ * @public
5264
5938
  * The settings for this multiplex program.
5265
5939
  */
5266
5940
  MultiplexProgramSettings?: MultiplexProgramSettings;
5267
5941
  /**
5942
+ * @public
5268
5943
  * The packet identifier map for this multiplex program.
5269
5944
  */
5270
5945
  PacketIdentifiersMap?: MultiplexProgramPacketIdentifiersMap;
5271
5946
  /**
5947
+ * @public
5272
5948
  * Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time.
5273
5949
  */
5274
5950
  PipelineDetails?: MultiplexProgramPipelineDetail[];
5275
5951
  /**
5952
+ * @public
5276
5953
  * The name of the multiplex program.
5277
5954
  */
5278
5955
  ProgramName?: string;
@@ -5283,6 +5960,7 @@ export interface DescribeMultiplexProgramResponse {
5283
5960
  */
5284
5961
  export interface DescribeOfferingRequest {
5285
5962
  /**
5963
+ * @public
5286
5964
  * Unique offering ID, e.g. '87654321'
5287
5965
  */
5288
5966
  OfferingId: string | undefined;
@@ -5293,46 +5971,57 @@ export interface DescribeOfferingRequest {
5293
5971
  */
5294
5972
  export interface DescribeOfferingResponse {
5295
5973
  /**
5974
+ * @public
5296
5975
  * Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
5297
5976
  */
5298
5977
  Arn?: string;
5299
5978
  /**
5979
+ * @public
5300
5980
  * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
5301
5981
  */
5302
5982
  CurrencyCode?: string;
5303
5983
  /**
5984
+ * @public
5304
5985
  * Lease duration, e.g. '12'
5305
5986
  */
5306
5987
  Duration?: number;
5307
5988
  /**
5989
+ * @public
5308
5990
  * Units for duration, e.g. 'MONTHS'
5309
5991
  */
5310
5992
  DurationUnits?: OfferingDurationUnits | string;
5311
5993
  /**
5994
+ * @public
5312
5995
  * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
5313
5996
  */
5314
5997
  FixedPrice?: number;
5315
5998
  /**
5999
+ * @public
5316
6000
  * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
5317
6001
  */
5318
6002
  OfferingDescription?: string;
5319
6003
  /**
6004
+ * @public
5320
6005
  * Unique offering ID, e.g. '87654321'
5321
6006
  */
5322
6007
  OfferingId?: string;
5323
6008
  /**
6009
+ * @public
5324
6010
  * Offering type, e.g. 'NO_UPFRONT'
5325
6011
  */
5326
6012
  OfferingType?: OfferingType | string;
5327
6013
  /**
6014
+ * @public
5328
6015
  * AWS region, e.g. 'us-west-2'
5329
6016
  */
5330
6017
  Region?: string;
5331
6018
  /**
6019
+ * @public
5332
6020
  * Resource configuration details
5333
6021
  */
5334
6022
  ResourceSpecification?: ReservationResourceSpecification;
5335
6023
  /**
6024
+ * @public
5336
6025
  * Recurring usage charge for each reserved resource, e.g. '157.0'
5337
6026
  */
5338
6027
  UsagePrice?: number;
@@ -5343,6 +6032,7 @@ export interface DescribeOfferingResponse {
5343
6032
  */
5344
6033
  export interface DescribeReservationRequest {
5345
6034
  /**
6035
+ * @public
5346
6036
  * Unique reservation ID, e.g. '1234567'
5347
6037
  */
5348
6038
  ReservationId: string | undefined;
@@ -5353,78 +6043,97 @@ export interface DescribeReservationRequest {
5353
6043
  */
5354
6044
  export interface DescribeReservationResponse {
5355
6045
  /**
6046
+ * @public
5356
6047
  * Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
5357
6048
  */
5358
6049
  Arn?: string;
5359
6050
  /**
6051
+ * @public
5360
6052
  * Number of reserved resources
5361
6053
  */
5362
6054
  Count?: number;
5363
6055
  /**
6056
+ * @public
5364
6057
  * Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
5365
6058
  */
5366
6059
  CurrencyCode?: string;
5367
6060
  /**
6061
+ * @public
5368
6062
  * Lease duration, e.g. '12'
5369
6063
  */
5370
6064
  Duration?: number;
5371
6065
  /**
6066
+ * @public
5372
6067
  * Units for duration, e.g. 'MONTHS'
5373
6068
  */
5374
6069
  DurationUnits?: OfferingDurationUnits | string;
5375
6070
  /**
6071
+ * @public
5376
6072
  * Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
5377
6073
  */
5378
6074
  End?: string;
5379
6075
  /**
6076
+ * @public
5380
6077
  * One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
5381
6078
  */
5382
6079
  FixedPrice?: number;
5383
6080
  /**
6081
+ * @public
5384
6082
  * User specified reservation name
5385
6083
  */
5386
6084
  Name?: string;
5387
6085
  /**
6086
+ * @public
5388
6087
  * Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
5389
6088
  */
5390
6089
  OfferingDescription?: string;
5391
6090
  /**
6091
+ * @public
5392
6092
  * Unique offering ID, e.g. '87654321'
5393
6093
  */
5394
6094
  OfferingId?: string;
5395
6095
  /**
6096
+ * @public
5396
6097
  * Offering type, e.g. 'NO_UPFRONT'
5397
6098
  */
5398
6099
  OfferingType?: OfferingType | string;
5399
6100
  /**
6101
+ * @public
5400
6102
  * AWS region, e.g. 'us-west-2'
5401
6103
  */
5402
6104
  Region?: string;
5403
6105
  /**
6106
+ * @public
5404
6107
  * Renewal settings for the reservation
5405
6108
  */
5406
6109
  RenewalSettings?: RenewalSettings;
5407
6110
  /**
6111
+ * @public
5408
6112
  * Unique reservation ID, e.g. '1234567'
5409
6113
  */
5410
6114
  ReservationId?: string;
5411
6115
  /**
6116
+ * @public
5412
6117
  * Resource configuration details
5413
6118
  */
5414
6119
  ResourceSpecification?: ReservationResourceSpecification;
5415
6120
  /**
6121
+ * @public
5416
6122
  * Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
5417
6123
  */
5418
6124
  Start?: string;
5419
6125
  /**
6126
+ * @public
5420
6127
  * Current state of reservation, e.g. 'ACTIVE'
5421
6128
  */
5422
6129
  State?: ReservationState | string;
5423
6130
  /**
6131
+ * @public
5424
6132
  * A collection of key-value pairs
5425
6133
  */
5426
6134
  Tags?: Record<string, string>;
5427
6135
  /**
6136
+ * @public
5428
6137
  * Recurring usage charge for each reserved resource, e.g. '157.0'
5429
6138
  */
5430
6139
  UsagePrice?: number;
@@ -5435,14 +6144,17 @@ export interface DescribeReservationResponse {
5435
6144
  */
5436
6145
  export interface DescribeScheduleRequest {
5437
6146
  /**
6147
+ * @public
5438
6148
  * Id of the channel whose schedule is being updated.
5439
6149
  */
5440
6150
  ChannelId: string | undefined;
5441
6151
  /**
6152
+ * @public
5442
6153
  * Placeholder documentation for MaxResults
5443
6154
  */
5444
6155
  MaxResults?: number;
5445
6156
  /**
6157
+ * @public
5446
6158
  * Placeholder documentation for __string
5447
6159
  */
5448
6160
  NextToken?: string;
@@ -5453,10 +6165,12 @@ export interface DescribeScheduleRequest {
5453
6165
  */
5454
6166
  export interface DescribeScheduleResponse {
5455
6167
  /**
6168
+ * @public
5456
6169
  * The next token; for use in pagination.
5457
6170
  */
5458
6171
  NextToken?: string;
5459
6172
  /**
6173
+ * @public
5460
6174
  * The list of actions in the schedule.
5461
6175
  */
5462
6176
  ScheduleActions?: ScheduleAction[];
@@ -5467,14 +6181,17 @@ export interface DescribeScheduleResponse {
5467
6181
  */
5468
6182
  export interface DescribeThumbnailsRequest {
5469
6183
  /**
6184
+ * @public
5470
6185
  * Unique ID of the channel
5471
6186
  */
5472
6187
  ChannelId: string | undefined;
5473
6188
  /**
6189
+ * @public
5474
6190
  * Pipeline ID ("0" or "1")
5475
6191
  */
5476
6192
  PipelineId: string | undefined;
5477
6193
  /**
6194
+ * @public
5478
6195
  * thumbnail type
5479
6196
  */
5480
6197
  ThumbnailType: string | undefined;
@@ -5485,6 +6202,7 @@ export interface DescribeThumbnailsRequest {
5485
6202
  */
5486
6203
  export interface DescribeThumbnailsResponse {
5487
6204
  /**
6205
+ * @public
5488
6206
  * Placeholder documentation for __listOfThumbnailDetail
5489
6207
  */
5490
6208
  ThumbnailDetails?: ThumbnailDetail[];
@@ -5495,14 +6213,17 @@ export interface DescribeThumbnailsResponse {
5495
6213
  */
5496
6214
  export interface InputDeviceConfigurableSettings {
5497
6215
  /**
6216
+ * @public
5498
6217
  * The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source.
5499
6218
  */
5500
6219
  ConfiguredInput?: InputDeviceConfiguredInput | string;
5501
6220
  /**
6221
+ * @public
5502
6222
  * The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.
5503
6223
  */
5504
6224
  MaxBitrate?: number;
5505
6225
  /**
6226
+ * @public
5506
6227
  * The Link device's buffer size (latency) in milliseconds (ms).
5507
6228
  */
5508
6229
  LatencyMs?: number;
@@ -5513,10 +6234,12 @@ export interface InputDeviceConfigurableSettings {
5513
6234
  */
5514
6235
  export interface ListChannelsRequest {
5515
6236
  /**
6237
+ * @public
5516
6238
  * Placeholder documentation for MaxResults
5517
6239
  */
5518
6240
  MaxResults?: number;
5519
6241
  /**
6242
+ * @public
5520
6243
  * Placeholder documentation for __string
5521
6244
  */
5522
6245
  NextToken?: string;
@@ -5527,10 +6250,12 @@ export interface ListChannelsRequest {
5527
6250
  */
5528
6251
  export interface ListChannelsResponse {
5529
6252
  /**
6253
+ * @public
5530
6254
  * Placeholder documentation for __listOfChannelSummary
5531
6255
  */
5532
6256
  Channels?: ChannelSummary[];
5533
6257
  /**
6258
+ * @public
5534
6259
  * Placeholder documentation for __string
5535
6260
  */
5536
6261
  NextToken?: string;
@@ -5541,10 +6266,12 @@ export interface ListChannelsResponse {
5541
6266
  */
5542
6267
  export interface ListInputDevicesRequest {
5543
6268
  /**
6269
+ * @public
5544
6270
  * Placeholder documentation for MaxResults
5545
6271
  */
5546
6272
  MaxResults?: number;
5547
6273
  /**
6274
+ * @public
5548
6275
  * Placeholder documentation for __string
5549
6276
  */
5550
6277
  NextToken?: string;
@@ -5555,10 +6282,12 @@ export interface ListInputDevicesRequest {
5555
6282
  */
5556
6283
  export interface ListInputDevicesResponse {
5557
6284
  /**
6285
+ * @public
5558
6286
  * The list of input devices.
5559
6287
  */
5560
6288
  InputDevices?: InputDeviceSummary[];
5561
6289
  /**
6290
+ * @public
5562
6291
  * A token to get additional list results.
5563
6292
  */
5564
6293
  NextToken?: string;
@@ -5569,14 +6298,17 @@ export interface ListInputDevicesResponse {
5569
6298
  */
5570
6299
  export interface ListInputDeviceTransfersRequest {
5571
6300
  /**
6301
+ * @public
5572
6302
  * Placeholder documentation for MaxResults
5573
6303
  */
5574
6304
  MaxResults?: number;
5575
6305
  /**
6306
+ * @public
5576
6307
  * Placeholder documentation for __string
5577
6308
  */
5578
6309
  NextToken?: string;
5579
6310
  /**
6311
+ * @public
5580
6312
  * Placeholder documentation for __string
5581
6313
  */
5582
6314
  TransferType: string | undefined;
@@ -5587,10 +6319,12 @@ export interface ListInputDeviceTransfersRequest {
5587
6319
  */
5588
6320
  export interface ListInputDeviceTransfersResponse {
5589
6321
  /**
6322
+ * @public
5590
6323
  * The list of devices that you are transferring or are being transferred to you.
5591
6324
  */
5592
6325
  InputDeviceTransfers?: TransferringInputDeviceSummary[];
5593
6326
  /**
6327
+ * @public
5594
6328
  * A token to get additional list results.
5595
6329
  */
5596
6330
  NextToken?: string;
@@ -5601,10 +6335,12 @@ export interface ListInputDeviceTransfersResponse {
5601
6335
  */
5602
6336
  export interface ListInputsRequest {
5603
6337
  /**
6338
+ * @public
5604
6339
  * Placeholder documentation for MaxResults
5605
6340
  */
5606
6341
  MaxResults?: number;
5607
6342
  /**
6343
+ * @public
5608
6344
  * Placeholder documentation for __string
5609
6345
  */
5610
6346
  NextToken?: string;
@@ -5615,10 +6351,12 @@ export interface ListInputsRequest {
5615
6351
  */
5616
6352
  export interface ListInputsResponse {
5617
6353
  /**
6354
+ * @public
5618
6355
  * Placeholder documentation for __listOfInput
5619
6356
  */
5620
6357
  Inputs?: Input[];
5621
6358
  /**
6359
+ * @public
5622
6360
  * Placeholder documentation for __string
5623
6361
  */
5624
6362
  NextToken?: string;
@@ -5629,10 +6367,12 @@ export interface ListInputsResponse {
5629
6367
  */
5630
6368
  export interface ListInputSecurityGroupsRequest {
5631
6369
  /**
6370
+ * @public
5632
6371
  * Placeholder documentation for MaxResults
5633
6372
  */
5634
6373
  MaxResults?: number;
5635
6374
  /**
6375
+ * @public
5636
6376
  * Placeholder documentation for __string
5637
6377
  */
5638
6378
  NextToken?: string;
@@ -5643,10 +6383,12 @@ export interface ListInputSecurityGroupsRequest {
5643
6383
  */
5644
6384
  export interface ListInputSecurityGroupsResponse {
5645
6385
  /**
6386
+ * @public
5646
6387
  * List of input security groups
5647
6388
  */
5648
6389
  InputSecurityGroups?: InputSecurityGroup[];
5649
6390
  /**
6391
+ * @public
5650
6392
  * Placeholder documentation for __string
5651
6393
  */
5652
6394
  NextToken?: string;
@@ -5657,10 +6399,12 @@ export interface ListInputSecurityGroupsResponse {
5657
6399
  */
5658
6400
  export interface ListMultiplexesRequest {
5659
6401
  /**
6402
+ * @public
5660
6403
  * The maximum number of items to return.
5661
6404
  */
5662
6405
  MaxResults?: number;
5663
6406
  /**
6407
+ * @public
5664
6408
  * The token to retrieve the next page of results.
5665
6409
  */
5666
6410
  NextToken?: string;
@@ -5671,10 +6415,12 @@ export interface ListMultiplexesRequest {
5671
6415
  */
5672
6416
  export interface ListMultiplexesResponse {
5673
6417
  /**
6418
+ * @public
5674
6419
  * List of multiplexes.
5675
6420
  */
5676
6421
  Multiplexes?: MultiplexSummary[];
5677
6422
  /**
6423
+ * @public
5678
6424
  * Token for the next ListMultiplexes request.
5679
6425
  */
5680
6426
  NextToken?: string;
@@ -5685,14 +6431,17 @@ export interface ListMultiplexesResponse {
5685
6431
  */
5686
6432
  export interface ListMultiplexProgramsRequest {
5687
6433
  /**
6434
+ * @public
5688
6435
  * The maximum number of items to return.
5689
6436
  */
5690
6437
  MaxResults?: number;
5691
6438
  /**
6439
+ * @public
5692
6440
  * The ID of the multiplex that the programs belong to.
5693
6441
  */
5694
6442
  MultiplexId: string | undefined;
5695
6443
  /**
6444
+ * @public
5696
6445
  * The token to retrieve the next page of results.
5697
6446
  */
5698
6447
  NextToken?: string;
@@ -5703,10 +6452,12 @@ export interface ListMultiplexProgramsRequest {
5703
6452
  */
5704
6453
  export interface ListMultiplexProgramsResponse {
5705
6454
  /**
6455
+ * @public
5706
6456
  * List of multiplex programs.
5707
6457
  */
5708
6458
  MultiplexPrograms?: MultiplexProgramSummary[];
5709
6459
  /**
6460
+ * @public
5710
6461
  * Token for the next ListMultiplexProgram request.
5711
6462
  */
5712
6463
  NextToken?: string;
@@ -5717,50 +6468,62 @@ export interface ListMultiplexProgramsResponse {
5717
6468
  */
5718
6469
  export interface ListOfferingsRequest {
5719
6470
  /**
6471
+ * @public
5720
6472
  * Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
5721
6473
  */
5722
6474
  ChannelClass?: string;
5723
6475
  /**
6476
+ * @public
5724
6477
  * Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
5725
6478
  */
5726
6479
  ChannelConfiguration?: string;
5727
6480
  /**
6481
+ * @public
5728
6482
  * Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
5729
6483
  */
5730
6484
  Codec?: string;
5731
6485
  /**
6486
+ * @public
5732
6487
  * Filter by offering duration, e.g. '12'
5733
6488
  */
5734
6489
  Duration?: string;
5735
6490
  /**
6491
+ * @public
5736
6492
  * Placeholder documentation for MaxResults
5737
6493
  */
5738
6494
  MaxResults?: number;
5739
6495
  /**
6496
+ * @public
5740
6497
  * Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
5741
6498
  */
5742
6499
  MaximumBitrate?: string;
5743
6500
  /**
6501
+ * @public
5744
6502
  * Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
5745
6503
  */
5746
6504
  MaximumFramerate?: string;
5747
6505
  /**
6506
+ * @public
5748
6507
  * Placeholder documentation for __string
5749
6508
  */
5750
6509
  NextToken?: string;
5751
6510
  /**
6511
+ * @public
5752
6512
  * Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
5753
6513
  */
5754
6514
  Resolution?: string;
5755
6515
  /**
6516
+ * @public
5756
6517
  * Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
5757
6518
  */
5758
6519
  ResourceType?: string;
5759
6520
  /**
6521
+ * @public
5760
6522
  * Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
5761
6523
  */
5762
6524
  SpecialFeature?: string;
5763
6525
  /**
6526
+ * @public
5764
6527
  * Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
5765
6528
  */
5766
6529
  VideoQuality?: string;
@@ -5771,10 +6534,12 @@ export interface ListOfferingsRequest {
5771
6534
  */
5772
6535
  export interface ListOfferingsResponse {
5773
6536
  /**
6537
+ * @public
5774
6538
  * Token to retrieve the next page of results
5775
6539
  */
5776
6540
  NextToken?: string;
5777
6541
  /**
6542
+ * @public
5778
6543
  * List of offerings
5779
6544
  */
5780
6545
  Offerings?: Offering[];
@@ -5785,42 +6550,52 @@ export interface ListOfferingsResponse {
5785
6550
  */
5786
6551
  export interface ListReservationsRequest {
5787
6552
  /**
6553
+ * @public
5788
6554
  * Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
5789
6555
  */
5790
6556
  ChannelClass?: string;
5791
6557
  /**
6558
+ * @public
5792
6559
  * Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
5793
6560
  */
5794
6561
  Codec?: string;
5795
6562
  /**
6563
+ * @public
5796
6564
  * Placeholder documentation for MaxResults
5797
6565
  */
5798
6566
  MaxResults?: number;
5799
6567
  /**
6568
+ * @public
5800
6569
  * Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
5801
6570
  */
5802
6571
  MaximumBitrate?: string;
5803
6572
  /**
6573
+ * @public
5804
6574
  * Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
5805
6575
  */
5806
6576
  MaximumFramerate?: string;
5807
6577
  /**
6578
+ * @public
5808
6579
  * Placeholder documentation for __string
5809
6580
  */
5810
6581
  NextToken?: string;
5811
6582
  /**
6583
+ * @public
5812
6584
  * Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
5813
6585
  */
5814
6586
  Resolution?: string;
5815
6587
  /**
6588
+ * @public
5816
6589
  * Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
5817
6590
  */
5818
6591
  ResourceType?: string;
5819
6592
  /**
6593
+ * @public
5820
6594
  * Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
5821
6595
  */
5822
6596
  SpecialFeature?: string;
5823
6597
  /**
6598
+ * @public
5824
6599
  * Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
5825
6600
  */
5826
6601
  VideoQuality?: string;
@@ -5831,10 +6606,12 @@ export interface ListReservationsRequest {
5831
6606
  */
5832
6607
  export interface ListReservationsResponse {
5833
6608
  /**
6609
+ * @public
5834
6610
  * Token to retrieve the next page of results
5835
6611
  */
5836
6612
  NextToken?: string;
5837
6613
  /**
6614
+ * @public
5838
6615
  * List of reservations
5839
6616
  */
5840
6617
  Reservations?: Reservation[];
@@ -5845,6 +6622,7 @@ export interface ListReservationsResponse {
5845
6622
  */
5846
6623
  export interface ListTagsForResourceRequest {
5847
6624
  /**
6625
+ * @public
5848
6626
  * Placeholder documentation for __string
5849
6627
  */
5850
6628
  ResourceArn: string | undefined;
@@ -5855,6 +6633,7 @@ export interface ListTagsForResourceRequest {
5855
6633
  */
5856
6634
  export interface ListTagsForResourceResponse {
5857
6635
  /**
6636
+ * @public
5858
6637
  * Placeholder documentation for Tags
5859
6638
  */
5860
6639
  Tags?: Record<string, string>;
@@ -5865,14 +6644,17 @@ export interface ListTagsForResourceResponse {
5865
6644
  */
5866
6645
  export interface MaintenanceUpdateSettings {
5867
6646
  /**
6647
+ * @public
5868
6648
  * Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows.
5869
6649
  */
5870
6650
  MaintenanceDay?: MaintenanceDay | string;
5871
6651
  /**
6652
+ * @public
5872
6653
  * Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only.
5873
6654
  */
5874
6655
  MaintenanceScheduledDate?: string;
5875
6656
  /**
6657
+ * @public
5876
6658
  * Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows.
5877
6659
  */
5878
6660
  MaintenanceStartTime?: string;