-
Notifications
You must be signed in to change notification settings - Fork 573
/
models_0.ts
2519 lines (2133 loc) · 63.1 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { MediaPackageServiceException as __BaseException } from "./MediaPackageServiceException";
export enum __AdTriggersElement {
BREAK = "BREAK",
DISTRIBUTOR_ADVERTISEMENT = "DISTRIBUTOR_ADVERTISEMENT",
DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY = "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY",
DISTRIBUTOR_PLACEMENT_OPPORTUNITY = "DISTRIBUTOR_PLACEMENT_OPPORTUNITY",
PROVIDER_ADVERTISEMENT = "PROVIDER_ADVERTISEMENT",
PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY = "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY",
PROVIDER_PLACEMENT_OPPORTUNITY = "PROVIDER_PLACEMENT_OPPORTUNITY",
SPLICE_INSERT = "SPLICE_INSERT",
}
export enum __PeriodTriggersElement {
ADS = "ADS",
}
/**
* Configure egress access logging.
*/
export interface EgressAccessLogs {
/**
* Customize the log group name.
*/
LogGroupName?: string;
}
/**
* An endpoint for ingesting source content for a Channel.
*/
export interface IngestEndpoint {
/**
* The system generated unique identifier for the IngestEndpoint
*/
Id?: string;
/**
* The system generated password for ingest authentication.
*/
Password?: string;
/**
* The ingest URL to which the source stream should be sent.
*/
Url?: string;
/**
* The system generated username for ingest authentication.
*/
Username?: string;
}
/**
* An HTTP Live Streaming (HLS) ingest resource configuration.
*/
export interface HlsIngest {
/**
* A list of endpoints to which the source stream should be sent.
*/
IngestEndpoints?: IngestEndpoint[];
}
/**
* Configure ingress access logging.
*/
export interface IngressAccessLogs {
/**
* Customize the log group name.
*/
LogGroupName?: string;
}
/**
* A Channel resource configuration.
*/
export interface Channel {
/**
* The Amazon Resource Name (ARN) assigned to the Channel.
*/
Arn?: string;
/**
* A short text description of the Channel.
*/
Description?: string;
/**
* Configure egress access logging.
*/
EgressAccessLogs?: EgressAccessLogs;
/**
* An HTTP Live Streaming (HLS) ingest resource configuration.
*/
HlsIngest?: HlsIngest;
/**
* The ID of the Channel.
*/
Id?: string;
/**
* Configure ingress access logging.
*/
IngressAccessLogs?: IngressAccessLogs;
/**
* A collection of tags associated with a resource
*/
Tags?: Record<string, string>;
}
/**
* Configuration parameters for where in an S3 bucket to place the harvested content
*/
export interface S3Destination {
/**
* The name of an S3 bucket within which harvested content will be exported
*/
BucketName: string | undefined;
/**
* The key in the specified S3 bucket where the harvested top-level manifest will be placed.
*/
ManifestKey: string | undefined;
/**
* The IAM role used to write to the specified S3 bucket
*/
RoleArn: string | undefined;
}
export enum Status {
FAILED = "FAILED",
IN_PROGRESS = "IN_PROGRESS",
SUCCEEDED = "SUCCEEDED",
}
/**
* A HarvestJob resource configuration
*/
export interface HarvestJob {
/**
* The Amazon Resource Name (ARN) assigned to the HarvestJob.
*/
Arn?: string;
/**
* The ID of the Channel that the HarvestJob will harvest from.
*/
ChannelId?: string;
/**
* The time the HarvestJob was submitted
*/
CreatedAt?: string;
/**
* The end of the time-window which will be harvested.
*/
EndTime?: string;
/**
* The ID of the HarvestJob. The ID must be unique within the region
* and it cannot be changed after the HarvestJob is submitted.
*/
Id?: string;
/**
* The ID of the OriginEndpoint that the HarvestJob will harvest from.
* This cannot be changed after the HarvestJob is submitted.
*/
OriginEndpointId?: string;
/**
* Configuration parameters for where in an S3 bucket to place the harvested content
*/
S3Destination?: S3Destination;
/**
* The start of the time-window which will be harvested.
*/
StartTime?: string;
/**
* The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for
* HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will
* include an explanation of why the HarvestJob failed.
*/
Status?: Status | string;
}
export enum AdMarkers {
DATERANGE = "DATERANGE",
NONE = "NONE",
PASSTHROUGH = "PASSTHROUGH",
SCTE35_ENHANCED = "SCTE35_ENHANCED",
}
export enum AdsOnDeliveryRestrictions {
BOTH = "BOTH",
NONE = "NONE",
RESTRICTED = "RESTRICTED",
UNRESTRICTED = "UNRESTRICTED",
}
export enum PlaylistType {
EVENT = "EVENT",
NONE = "NONE",
VOD = "VOD",
}
/**
* A HTTP Live Streaming (HLS) manifest configuration.
*/
export interface HlsManifest {
/**
* This setting controls how ad markers are included in the packaged OriginEndpoint.
* "NONE" will omit all SCTE-35 ad markers from the output.
* "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
* markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.
* "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35
* messages in the input source.
* "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events
* in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value
* that is greater than 0.
*/
AdMarkers?: AdMarkers | string;
/**
* The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
*/
Id: string | undefined;
/**
* When enabled, an I-Frame only stream will be included in the output.
*/
IncludeIframeOnlyStream?: boolean;
/**
* An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
*/
ManifestName?: string;
/**
* The HTTP Live Streaming (HLS) playlist type.
* When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
* entry will be included in the media playlist.
*/
PlaylistType?: PlaylistType | string;
/**
* Time window (in seconds) contained in each parent manifest.
*/
PlaylistWindowSeconds?: number;
/**
* The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
* inserted into manifests. Additionally, when an interval is specified
* ID3Timed Metadata messages will be generated every 5 seconds using the
* ingest time of the content.
* If the interval is not specified, or set to 0, then
* no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
* ID3Timed Metadata messages will be generated. Note that irrespective
* of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
* it will be passed through to HLS output.
*/
ProgramDateTimeIntervalSeconds?: number;
/**
* The URL of the packaged OriginEndpoint for consumption.
*/
Url?: string;
/**
* A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
* ad markers are output. Specify multiple items to create ad markers for all of the included
* message types.
*/
AdTriggers?: (__AdTriggersElement | string)[];
/**
* This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
* determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
* ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
* contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35
* messages of the types specified in AdTriggers that do not contain delivery restrictions will
* be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in
* AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags
* and are always treated as ads if specified in AdTriggers.
*/
AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
}
/**
* A HTTP Live Streaming (HLS) manifest configuration.
*/
export interface HlsManifestCreateOrUpdateParameters {
/**
* This setting controls how ad markers are included in the packaged OriginEndpoint.
* "NONE" will omit all SCTE-35 ad markers from the output.
* "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
* markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.
* "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35
* messages in the input source.
* "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events
* in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value
* that is greater than 0.
*/
AdMarkers?: AdMarkers | string;
/**
* A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
* ad markers are output. Specify multiple items to create ad markers for all of the included
* message types.
*/
AdTriggers?: (__AdTriggersElement | string)[];
/**
* This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
* determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
* ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
* contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35
* messages of the types specified in AdTriggers that do not contain delivery restrictions will
* be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in
* AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags
* and are always treated as ads if specified in AdTriggers.
*/
AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
/**
* The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
*/
Id: string | undefined;
/**
* When enabled, an I-Frame only stream will be included in the output.
*/
IncludeIframeOnlyStream?: boolean;
/**
* An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
*/
ManifestName?: string;
/**
* The HTTP Live Streaming (HLS) playlist type.
* When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
* entry will be included in the media playlist.
*/
PlaylistType?: PlaylistType | string;
/**
* Time window (in seconds) contained in each parent manifest.
*/
PlaylistWindowSeconds?: number;
/**
* The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
* inserted into manifests. Additionally, when an interval is specified
* ID3Timed Metadata messages will be generated every 5 seconds using the
* ingest time of the content.
* If the interval is not specified, or set to 0, then
* no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
* ID3Timed Metadata messages will be generated. Note that irrespective
* of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
* it will be passed through to HLS output.
*/
ProgramDateTimeIntervalSeconds?: number;
}
/**
* CDN Authorization credentials
*/
export interface Authorization {
/**
* The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.
*/
CdnIdentifierSecret: string | undefined;
/**
* The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
*/
SecretsRoleArn: string | undefined;
}
export enum CmafEncryptionMethod {
AES_CTR = "AES_CTR",
SAMPLE_AES = "SAMPLE_AES",
}
export enum PresetSpeke20Audio {
PRESET_AUDIO_1 = "PRESET-AUDIO-1",
PRESET_AUDIO_2 = "PRESET-AUDIO-2",
PRESET_AUDIO_3 = "PRESET-AUDIO-3",
SHARED = "SHARED",
UNENCRYPTED = "UNENCRYPTED",
}
export enum PresetSpeke20Video {
PRESET_VIDEO_1 = "PRESET-VIDEO-1",
PRESET_VIDEO_2 = "PRESET-VIDEO-2",
PRESET_VIDEO_3 = "PRESET-VIDEO-3",
PRESET_VIDEO_4 = "PRESET-VIDEO-4",
PRESET_VIDEO_5 = "PRESET-VIDEO-5",
PRESET_VIDEO_6 = "PRESET-VIDEO-6",
PRESET_VIDEO_7 = "PRESET-VIDEO-7",
PRESET_VIDEO_8 = "PRESET-VIDEO-8",
SHARED = "SHARED",
UNENCRYPTED = "UNENCRYPTED",
}
/**
* Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 2.0.
* The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream.
* To configure the encryption contract, specify which audio and video encryption presets to use.
* Note the following considerations when using encryptionContractConfiguration:
* encryptionContractConfiguration can be used for DASH or CMAF endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification.
* You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
*/
export interface EncryptionContractConfiguration {
/**
* A collection of audio encryption presets.
*/
PresetSpeke20Audio: PresetSpeke20Audio | string | undefined;
/**
* A collection of video encryption presets.
*/
PresetSpeke20Video: PresetSpeke20Video | string | undefined;
}
/**
* A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
*/
export interface SpekeKeyProvider {
/**
* An Amazon Resource Name (ARN) of a Certificate Manager certificate
* that MediaPackage will use for enforcing secure end-to-end data
* transfer with the key provider service.
*/
CertificateArn?: string;
/**
* Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 2.0.
* The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream.
* To configure the encryption contract, specify which audio and video encryption presets to use.
* Note the following considerations when using encryptionContractConfiguration:
* encryptionContractConfiguration can be used for DASH or CMAF endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification.
* You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
*/
EncryptionContractConfiguration?: EncryptionContractConfiguration;
/**
* The resource ID to include in key requests.
*/
ResourceId: string | undefined;
/**
* An Amazon Resource Name (ARN) of an IAM role that AWS Elemental
* MediaPackage will assume when accessing the key provider service.
*/
RoleArn: string | undefined;
/**
* The system IDs to include in key requests.
*/
SystemIds: string[] | undefined;
/**
* The URL of the external key provider service.
*/
Url: string | undefined;
}
/**
* A Common Media Application Format (CMAF) encryption configuration.
*/
export interface CmafEncryption {
/**
* An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
*/
ConstantInitializationVector?: string;
/**
* The encryption method to use.
*/
EncryptionMethod?: CmafEncryptionMethod | string;
/**
* Time (in seconds) between each encryption key rotation.
*/
KeyRotationIntervalSeconds?: number;
/**
* A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
*/
SpekeKeyProvider: SpekeKeyProvider | undefined;
}
export enum StreamOrder {
ORIGINAL = "ORIGINAL",
VIDEO_BITRATE_ASCENDING = "VIDEO_BITRATE_ASCENDING",
VIDEO_BITRATE_DESCENDING = "VIDEO_BITRATE_DESCENDING",
}
/**
* A StreamSelection configuration.
*/
export interface StreamSelection {
/**
* The maximum video bitrate (bps) to include in output.
*/
MaxVideoBitsPerSecond?: number;
/**
* The minimum video bitrate (bps) to include in output.
*/
MinVideoBitsPerSecond?: number;
/**
* A directive that determines the order of streams in the output.
*/
StreamOrder?: StreamOrder | string;
}
/**
* A Common Media Application Format (CMAF) packaging configuration.
*/
export interface CmafPackage {
/**
* A Common Media Application Format (CMAF) encryption configuration.
*/
Encryption?: CmafEncryption;
/**
* A list of HLS manifest configurations
*/
HlsManifests?: HlsManifest[];
/**
* Duration (in seconds) of each segment. Actual segments will be
* rounded to the nearest multiple of the source segment duration.
*/
SegmentDurationSeconds?: number;
/**
* An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
*/
SegmentPrefix?: string;
/**
* A StreamSelection configuration.
*/
StreamSelection?: StreamSelection;
}
/**
* A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
*/
export interface DashEncryption {
/**
* Time (in seconds) between each encryption key rotation.
*/
KeyRotationIntervalSeconds?: number;
/**
* A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
*/
SpekeKeyProvider: SpekeKeyProvider | undefined;
}
export enum ManifestLayout {
COMPACT = "COMPACT",
FULL = "FULL",
}
export enum Profile {
DVB_DASH_2014 = "DVB_DASH_2014",
HBBTV_1_5 = "HBBTV_1_5",
HYBRIDCAST = "HYBRIDCAST",
NONE = "NONE",
}
export enum SegmentTemplateFormat {
NUMBER_WITH_DURATION = "NUMBER_WITH_DURATION",
NUMBER_WITH_TIMELINE = "NUMBER_WITH_TIMELINE",
TIME_WITH_TIMELINE = "TIME_WITH_TIMELINE",
}
export enum UtcTiming {
HTTP_HEAD = "HTTP-HEAD",
HTTP_ISO = "HTTP-ISO",
HTTP_XSDATE = "HTTP-XSDATE",
NONE = "NONE",
}
/**
* A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
*/
export interface DashPackage {
/**
* A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
* ad markers are output. Specify multiple items to create ad markers for all of the included
* message types.
*/
AdTriggers?: (__AdTriggersElement | string)[];
/**
* This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
* determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
* ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
* contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35
* messages of the types specified in AdTriggers that do not contain delivery restrictions will
* be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in
* AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags
* and are always treated as ads if specified in AdTriggers.
*/
AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
/**
* A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
*/
Encryption?: DashEncryption;
/**
* When enabled, an I-Frame only stream will be included in the output.
*/
IncludeIframeOnlyStream?: boolean;
/**
* Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
*/
ManifestLayout?: ManifestLayout | string;
/**
* Time window (in seconds) contained in each manifest.
*/
ManifestWindowSeconds?: number;
/**
* Minimum duration (in seconds) that a player will buffer media before starting the presentation.
*/
MinBufferTimeSeconds?: number;
/**
* Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
*/
MinUpdatePeriodSeconds?: number;
/**
* A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)
* Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not
* be partitioned into more than one period. If the list contains "ADS", new periods will be created where
* the Channel source contains SCTE-35 ad markers.
*/
PeriodTriggers?: (__PeriodTriggersElement | string)[];
/**
* The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled.
*/
Profile?: Profile | string;
/**
* Duration (in seconds) of each segment. Actual segments will be
* rounded to the nearest multiple of the source segment duration.
*/
SegmentDurationSeconds?: number;
/**
* Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
*/
SegmentTemplateFormat?: SegmentTemplateFormat | string;
/**
* A StreamSelection configuration.
*/
StreamSelection?: StreamSelection;
/**
* Duration (in seconds) to delay live content before presentation.
*/
SuggestedPresentationDelaySeconds?: number;
/**
* Determines the type of UTCTiming included in the Media Presentation Description (MPD)
*/
UtcTiming?: UtcTiming | string;
/**
* Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
*/
UtcTimingUri?: string;
}
export enum EncryptionMethod {
AES_128 = "AES_128",
SAMPLE_AES = "SAMPLE_AES",
}
/**
* An HTTP Live Streaming (HLS) encryption configuration.
*/
export interface HlsEncryption {
/**
* A constant initialization vector for encryption (optional).
* When not specified the initialization vector will be periodically rotated.
*/
ConstantInitializationVector?: string;
/**
* The encryption method to use.
*/
EncryptionMethod?: EncryptionMethod | string;
/**
* Interval (in seconds) between each encryption key rotation.
*/
KeyRotationIntervalSeconds?: number;
/**
* When enabled, the EXT-X-KEY tag will be repeated in output manifests.
*/
RepeatExtXKey?: boolean;
/**
* A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
*/
SpekeKeyProvider: SpekeKeyProvider | undefined;
}
/**
* An HTTP Live Streaming (HLS) packaging configuration.
*/
export interface HlsPackage {
/**
* This setting controls how ad markers are included in the packaged OriginEndpoint.
* "NONE" will omit all SCTE-35 ad markers from the output.
* "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
* markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.
* "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35
* messages in the input source.
* "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events
* in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value
* that is greater than 0.
*/
AdMarkers?: AdMarkers | string;
/**
* A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
* ad markers are output. Specify multiple items to create ad markers for all of the included
* message types.
*/
AdTriggers?: (__AdTriggersElement | string)[];
/**
* This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
* determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
* ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
* contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35
* messages of the types specified in AdTriggers that do not contain delivery restrictions will
* be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in
* AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags
* and are always treated as ads if specified in AdTriggers.
*/
AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
/**
* An HTTP Live Streaming (HLS) encryption configuration.
*/
Encryption?: HlsEncryption;
/**
* When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
*/
IncludeDvbSubtitles?: boolean;
/**
* When enabled, an I-Frame only stream will be included in the output.
*/
IncludeIframeOnlyStream?: boolean;
/**
* The HTTP Live Streaming (HLS) playlist type.
* When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
* entry will be included in the media playlist.
*/
PlaylistType?: PlaylistType | string;
/**
* Time window (in seconds) contained in each parent manifest.
*/
PlaylistWindowSeconds?: number;
/**
* The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
* inserted into manifests. Additionally, when an interval is specified
* ID3Timed Metadata messages will be generated every 5 seconds using the
* ingest time of the content.
* If the interval is not specified, or set to 0, then
* no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
* ID3Timed Metadata messages will be generated. Note that irrespective
* of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
* it will be passed through to HLS output.
*/
ProgramDateTimeIntervalSeconds?: number;
/**
* Duration (in seconds) of each fragment. Actual fragments will be
* rounded to the nearest multiple of the source fragment duration.
*/
SegmentDurationSeconds?: number;
/**
* A StreamSelection configuration.
*/
StreamSelection?: StreamSelection;
/**
* When enabled, audio streams will be placed in rendition groups in the output.
*/
UseAudioRenditionGroup?: boolean;
}
/**
* A Microsoft Smooth Streaming (MSS) encryption configuration.
*/
export interface MssEncryption {
/**
* A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
*/
SpekeKeyProvider: SpekeKeyProvider | undefined;
}
/**
* A Microsoft Smooth Streaming (MSS) packaging configuration.
*/
export interface MssPackage {
/**
* A Microsoft Smooth Streaming (MSS) encryption configuration.
*/
Encryption?: MssEncryption;
/**
* The time window (in seconds) contained in each manifest.
*/
ManifestWindowSeconds?: number;
/**
* The duration (in seconds) of each segment.
*/
SegmentDurationSeconds?: number;
/**
* A StreamSelection configuration.
*/
StreamSelection?: StreamSelection;
}
export enum Origination {
ALLOW = "ALLOW",
DENY = "DENY",
}
/**
* An OriginEndpoint resource configuration.
*/
export interface OriginEndpoint {
/**
* The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
*/
Arn?: string;
/**
* CDN Authorization credentials
*/
Authorization?: Authorization;
/**
* The ID of the Channel the OriginEndpoint is associated with.
*/
ChannelId?: string;
/**
* A Common Media Application Format (CMAF) packaging configuration.
*/
CmafPackage?: CmafPackage;
/**
* A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
*/
DashPackage?: DashPackage;
/**
* A short text description of the OriginEndpoint.
*/
Description?: string;
/**
* An HTTP Live Streaming (HLS) packaging configuration.
*/
HlsPackage?: HlsPackage;
/**
* The ID of the OriginEndpoint.
*/
Id?: string;
/**
* A short string appended to the end of the OriginEndpoint URL.
*/
ManifestName?: string;
/**
* A Microsoft Smooth Streaming (MSS) packaging configuration.
*/
MssPackage?: MssPackage;
/**
* Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
* may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
* requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
*/
Origination?: Origination | string;
/**
* Maximum duration (seconds) of content to retain for startover playback.
* If not specified, startover playback will be disabled for the OriginEndpoint.
*/
StartoverWindowSeconds?: number;
/**
* A collection of tags associated with a resource
*/
Tags?: Record<string, string>;
/**
* Amount of delay (seconds) to enforce on the playback of live content.
* If not specified, there will be no time delay in effect for the OriginEndpoint.
*/
TimeDelaySeconds?: number;
/**
* The URL of the packaged OriginEndpoint for consumption.
*/
Url?: string;
/**
* A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
*/
Whitelist?: string[];
}
/**
* A Common Media Application Format (CMAF) packaging configuration.
*/
export interface CmafPackageCreateOrUpdateParameters {
/**
* A Common Media Application Format (CMAF) encryption configuration.
*/
Encryption?: CmafEncryption;
/**
* A list of HLS manifest configurations
*/
HlsManifests?: HlsManifestCreateOrUpdateParameters[];
/**
* Duration (in seconds) of each segment. Actual segments will be
* rounded to the nearest multiple of the source segment duration.
*/
SegmentDurationSeconds?: number;
/**
* An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
*/
SegmentPrefix?: string;
/**
* A StreamSelection configuration.
*/
StreamSelection?: StreamSelection;
}
/**
* the option to configure log subscription.
*/
export interface ConfigureLogsRequest {
/**
* Configure egress access logging.
*/
EgressAccessLogs?: EgressAccessLogs;
/**
* The ID of the channel to log subscription.
*/
Id: string | undefined;