@aws-sdk/client-mediapackage 3.379.1 → 3.385.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.
@@ -35,6 +35,7 @@ export type __PeriodTriggersElement = (typeof __PeriodTriggersElement)[keyof typ
35
35
  */
36
36
  export interface EgressAccessLogs {
37
37
  /**
38
+ * @public
38
39
  * Customize the log group name.
39
40
  */
40
41
  LogGroupName?: string;
@@ -45,18 +46,22 @@ export interface EgressAccessLogs {
45
46
  */
46
47
  export interface IngestEndpoint {
47
48
  /**
49
+ * @public
48
50
  * The system generated unique identifier for the IngestEndpoint
49
51
  */
50
52
  Id?: string;
51
53
  /**
54
+ * @public
52
55
  * The system generated password for ingest authentication.
53
56
  */
54
57
  Password?: string;
55
58
  /**
59
+ * @public
56
60
  * The ingest URL to which the source stream should be sent.
57
61
  */
58
62
  Url?: string;
59
63
  /**
64
+ * @public
60
65
  * The system generated username for ingest authentication.
61
66
  */
62
67
  Username?: string;
@@ -67,6 +72,7 @@ export interface IngestEndpoint {
67
72
  */
68
73
  export interface HlsIngest {
69
74
  /**
75
+ * @public
70
76
  * A list of endpoints to which the source stream should be sent.
71
77
  */
72
78
  IngestEndpoints?: IngestEndpoint[];
@@ -77,6 +83,7 @@ export interface HlsIngest {
77
83
  */
78
84
  export interface IngressAccessLogs {
79
85
  /**
86
+ * @public
80
87
  * Customize the log group name.
81
88
  */
82
89
  LogGroupName?: string;
@@ -87,34 +94,42 @@ export interface IngressAccessLogs {
87
94
  */
88
95
  export interface Channel {
89
96
  /**
97
+ * @public
90
98
  * The Amazon Resource Name (ARN) assigned to the Channel.
91
99
  */
92
100
  Arn?: string;
93
101
  /**
102
+ * @public
94
103
  * The date and time the Channel was created.
95
104
  */
96
105
  CreatedAt?: string;
97
106
  /**
107
+ * @public
98
108
  * A short text description of the Channel.
99
109
  */
100
110
  Description?: string;
101
111
  /**
112
+ * @public
102
113
  * Configure egress access logging.
103
114
  */
104
115
  EgressAccessLogs?: EgressAccessLogs;
105
116
  /**
117
+ * @public
106
118
  * An HTTP Live Streaming (HLS) ingest resource configuration.
107
119
  */
108
120
  HlsIngest?: HlsIngest;
109
121
  /**
122
+ * @public
110
123
  * The ID of the Channel.
111
124
  */
112
125
  Id?: string;
113
126
  /**
127
+ * @public
114
128
  * Configure ingress access logging.
115
129
  */
116
130
  IngressAccessLogs?: IngressAccessLogs;
117
131
  /**
132
+ * @public
118
133
  * A collection of tags associated with a resource
119
134
  */
120
135
  Tags?: Record<string, string>;
@@ -125,14 +140,17 @@ export interface Channel {
125
140
  */
126
141
  export interface S3Destination {
127
142
  /**
143
+ * @public
128
144
  * The name of an S3 bucket within which harvested content will be exported
129
145
  */
130
146
  BucketName: string | undefined;
131
147
  /**
148
+ * @public
132
149
  * The key in the specified S3 bucket where the harvested top-level manifest will be placed.
133
150
  */
134
151
  ManifestKey: string | undefined;
135
152
  /**
153
+ * @public
136
154
  * The IAM role used to write to the specified S3 bucket
137
155
  */
138
156
  RoleArn: string | undefined;
@@ -156,40 +174,49 @@ export type Status = (typeof Status)[keyof typeof Status];
156
174
  */
157
175
  export interface HarvestJob {
158
176
  /**
177
+ * @public
159
178
  * The Amazon Resource Name (ARN) assigned to the HarvestJob.
160
179
  */
161
180
  Arn?: string;
162
181
  /**
182
+ * @public
163
183
  * The ID of the Channel that the HarvestJob will harvest from.
164
184
  */
165
185
  ChannelId?: string;
166
186
  /**
187
+ * @public
167
188
  * The date and time the HarvestJob was submitted.
168
189
  */
169
190
  CreatedAt?: string;
170
191
  /**
192
+ * @public
171
193
  * The end of the time-window which will be harvested.
172
194
  */
173
195
  EndTime?: string;
174
196
  /**
197
+ * @public
175
198
  * The ID of the HarvestJob. The ID must be unique within the region
176
199
  * and it cannot be changed after the HarvestJob is submitted.
177
200
  */
178
201
  Id?: string;
179
202
  /**
203
+ * @public
180
204
  * The ID of the OriginEndpoint that the HarvestJob will harvest from.
181
205
  * This cannot be changed after the HarvestJob is submitted.
182
206
  */
183
207
  OriginEndpointId?: string;
184
208
  /**
209
+ * @public
185
210
  * Configuration parameters for where in an S3 bucket to place the harvested content
186
211
  */
187
212
  S3Destination?: S3Destination;
188
213
  /**
214
+ * @public
189
215
  * The start of the time-window which will be harvested.
190
216
  */
191
217
  StartTime?: string;
192
218
  /**
219
+ * @public
193
220
  * The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for
194
221
  * HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will
195
222
  * include an explanation of why the HarvestJob failed.
@@ -243,6 +270,7 @@ export type PlaylistType = (typeof PlaylistType)[keyof typeof PlaylistType];
243
270
  */
244
271
  export interface HlsManifest {
245
272
  /**
273
+ * @public
246
274
  * This setting controls how ad markers are included in the packaged OriginEndpoint.
247
275
  * "NONE" will omit all SCTE-35 ad markers from the output.
248
276
  * "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
@@ -255,28 +283,34 @@ export interface HlsManifest {
255
283
  */
256
284
  AdMarkers?: AdMarkers | string;
257
285
  /**
286
+ * @public
258
287
  * The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
259
288
  */
260
289
  Id: string | undefined;
261
290
  /**
291
+ * @public
262
292
  * When enabled, an I-Frame only stream will be included in the output.
263
293
  */
264
294
  IncludeIframeOnlyStream?: boolean;
265
295
  /**
296
+ * @public
266
297
  * An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
267
298
  */
268
299
  ManifestName?: string;
269
300
  /**
301
+ * @public
270
302
  * The HTTP Live Streaming (HLS) playlist type.
271
303
  * When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
272
304
  * entry will be included in the media playlist.
273
305
  */
274
306
  PlaylistType?: PlaylistType | string;
275
307
  /**
308
+ * @public
276
309
  * Time window (in seconds) contained in each parent manifest.
277
310
  */
278
311
  PlaylistWindowSeconds?: number;
279
312
  /**
313
+ * @public
280
314
  * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
281
315
  * inserted into manifests. Additionally, when an interval is specified
282
316
  * ID3Timed Metadata messages will be generated every 5 seconds using the
@@ -289,16 +323,19 @@ export interface HlsManifest {
289
323
  */
290
324
  ProgramDateTimeIntervalSeconds?: number;
291
325
  /**
326
+ * @public
292
327
  * The URL of the packaged OriginEndpoint for consumption.
293
328
  */
294
329
  Url?: string;
295
330
  /**
331
+ * @public
296
332
  * A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
297
333
  * ad markers are output. Specify multiple items to create ad markers for all of the included
298
334
  * message types.
299
335
  */
300
336
  AdTriggers?: (__AdTriggersElement | string)[];
301
337
  /**
338
+ * @public
302
339
  * This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
303
340
  * determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
304
341
  * ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
@@ -316,6 +353,7 @@ export interface HlsManifest {
316
353
  */
317
354
  export interface HlsManifestCreateOrUpdateParameters {
318
355
  /**
356
+ * @public
319
357
  * This setting controls how ad markers are included in the packaged OriginEndpoint.
320
358
  * "NONE" will omit all SCTE-35 ad markers from the output.
321
359
  * "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
@@ -328,12 +366,14 @@ export interface HlsManifestCreateOrUpdateParameters {
328
366
  */
329
367
  AdMarkers?: AdMarkers | string;
330
368
  /**
369
+ * @public
331
370
  * A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
332
371
  * ad markers are output. Specify multiple items to create ad markers for all of the included
333
372
  * message types.
334
373
  */
335
374
  AdTriggers?: (__AdTriggersElement | string)[];
336
375
  /**
376
+ * @public
337
377
  * This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
338
378
  * determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
339
379
  * ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
@@ -345,28 +385,34 @@ export interface HlsManifestCreateOrUpdateParameters {
345
385
  */
346
386
  AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
347
387
  /**
388
+ * @public
348
389
  * The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
349
390
  */
350
391
  Id: string | undefined;
351
392
  /**
393
+ * @public
352
394
  * When enabled, an I-Frame only stream will be included in the output.
353
395
  */
354
396
  IncludeIframeOnlyStream?: boolean;
355
397
  /**
398
+ * @public
356
399
  * An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
357
400
  */
358
401
  ManifestName?: string;
359
402
  /**
403
+ * @public
360
404
  * The HTTP Live Streaming (HLS) playlist type.
361
405
  * When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
362
406
  * entry will be included in the media playlist.
363
407
  */
364
408
  PlaylistType?: PlaylistType | string;
365
409
  /**
410
+ * @public
366
411
  * Time window (in seconds) contained in each parent manifest.
367
412
  */
368
413
  PlaylistWindowSeconds?: number;
369
414
  /**
415
+ * @public
370
416
  * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
371
417
  * inserted into manifests. Additionally, when an interval is specified
372
418
  * ID3Timed Metadata messages will be generated every 5 seconds using the
@@ -385,10 +431,12 @@ export interface HlsManifestCreateOrUpdateParameters {
385
431
  */
386
432
  export interface Authorization {
387
433
  /**
434
+ * @public
388
435
  * The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.
389
436
  */
390
437
  CdnIdentifierSecret: string | undefined;
391
438
  /**
439
+ * @public
392
440
  * The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
393
441
  */
394
442
  SecretsRoleArn: string | undefined;
@@ -451,10 +499,12 @@ export type PresetSpeke20Video = (typeof PresetSpeke20Video)[keyof typeof Preset
451
499
  */
452
500
  export interface EncryptionContractConfiguration {
453
501
  /**
502
+ * @public
454
503
  * A collection of audio encryption presets.
455
504
  */
456
505
  PresetSpeke20Audio: PresetSpeke20Audio | string | undefined;
457
506
  /**
507
+ * @public
458
508
  * A collection of video encryption presets.
459
509
  */
460
510
  PresetSpeke20Video: PresetSpeke20Video | string | undefined;
@@ -465,12 +515,14 @@ export interface EncryptionContractConfiguration {
465
515
  */
466
516
  export interface SpekeKeyProvider {
467
517
  /**
518
+ * @public
468
519
  * An Amazon Resource Name (ARN) of a Certificate Manager certificate
469
520
  * that MediaPackage will use for enforcing secure end-to-end data
470
521
  * transfer with the key provider service.
471
522
  */
472
523
  CertificateArn?: string;
473
524
  /**
525
+ * @public
474
526
  * Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 2.0.
475
527
  * The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream.
476
528
  * To configure the encryption contract, specify which audio and video encryption presets to use.
@@ -480,19 +532,23 @@ export interface SpekeKeyProvider {
480
532
  */
481
533
  EncryptionContractConfiguration?: EncryptionContractConfiguration;
482
534
  /**
535
+ * @public
483
536
  * The resource ID to include in key requests.
484
537
  */
485
538
  ResourceId: string | undefined;
486
539
  /**
540
+ * @public
487
541
  * An Amazon Resource Name (ARN) of an IAM role that AWS Elemental
488
542
  * MediaPackage will assume when accessing the key provider service.
489
543
  */
490
544
  RoleArn: string | undefined;
491
545
  /**
546
+ * @public
492
547
  * The system IDs to include in key requests.
493
548
  */
494
549
  SystemIds: string[] | undefined;
495
550
  /**
551
+ * @public
496
552
  * The URL of the external key provider service.
497
553
  */
498
554
  Url: string | undefined;
@@ -503,18 +559,22 @@ export interface SpekeKeyProvider {
503
559
  */
504
560
  export interface CmafEncryption {
505
561
  /**
562
+ * @public
506
563
  * 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).
507
564
  */
508
565
  ConstantInitializationVector?: string;
509
566
  /**
567
+ * @public
510
568
  * The encryption method to use.
511
569
  */
512
570
  EncryptionMethod?: CmafEncryptionMethod | string;
513
571
  /**
572
+ * @public
514
573
  * Time (in seconds) between each encryption key rotation.
515
574
  */
516
575
  KeyRotationIntervalSeconds?: number;
517
576
  /**
577
+ * @public
518
578
  * A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
519
579
  */
520
580
  SpekeKeyProvider: SpekeKeyProvider | undefined;
@@ -538,14 +598,17 @@ export type StreamOrder = (typeof StreamOrder)[keyof typeof StreamOrder];
538
598
  */
539
599
  export interface StreamSelection {
540
600
  /**
601
+ * @public
541
602
  * The maximum video bitrate (bps) to include in output.
542
603
  */
543
604
  MaxVideoBitsPerSecond?: number;
544
605
  /**
606
+ * @public
545
607
  * The minimum video bitrate (bps) to include in output.
546
608
  */
547
609
  MinVideoBitsPerSecond?: number;
548
610
  /**
611
+ * @public
549
612
  * A directive that determines the order of streams in the output.
550
613
  */
551
614
  StreamOrder?: StreamOrder | string;
@@ -556,23 +619,28 @@ export interface StreamSelection {
556
619
  */
557
620
  export interface CmafPackage {
558
621
  /**
622
+ * @public
559
623
  * A Common Media Application Format (CMAF) encryption configuration.
560
624
  */
561
625
  Encryption?: CmafEncryption;
562
626
  /**
627
+ * @public
563
628
  * A list of HLS manifest configurations
564
629
  */
565
630
  HlsManifests?: HlsManifest[];
566
631
  /**
632
+ * @public
567
633
  * Duration (in seconds) of each segment. Actual segments will be
568
634
  * rounded to the nearest multiple of the source segment duration.
569
635
  */
570
636
  SegmentDurationSeconds?: number;
571
637
  /**
638
+ * @public
572
639
  * An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
573
640
  */
574
641
  SegmentPrefix?: string;
575
642
  /**
643
+ * @public
576
644
  * A StreamSelection configuration.
577
645
  */
578
646
  StreamSelection?: StreamSelection;
@@ -583,10 +651,12 @@ export interface CmafPackage {
583
651
  */
584
652
  export interface DashEncryption {
585
653
  /**
654
+ * @public
586
655
  * Time (in seconds) between each encryption key rotation.
587
656
  */
588
657
  KeyRotationIntervalSeconds?: number;
589
658
  /**
659
+ * @public
590
660
  * A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
591
661
  */
592
662
  SpekeKeyProvider: SpekeKeyProvider | undefined;
@@ -650,12 +720,14 @@ export type UtcTiming = (typeof UtcTiming)[keyof typeof UtcTiming];
650
720
  */
651
721
  export interface DashPackage {
652
722
  /**
723
+ * @public
653
724
  * A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
654
725
  * ad markers are output. Specify multiple items to create ad markers for all of the included
655
726
  * message types.
656
727
  */
657
728
  AdTriggers?: (__AdTriggersElement | string)[];
658
729
  /**
730
+ * @public
659
731
  * This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
660
732
  * determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
661
733
  * ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
@@ -667,30 +739,37 @@ export interface DashPackage {
667
739
  */
668
740
  AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
669
741
  /**
742
+ * @public
670
743
  * A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
671
744
  */
672
745
  Encryption?: DashEncryption;
673
746
  /**
747
+ * @public
674
748
  * When enabled, an I-Frame only stream will be included in the output.
675
749
  */
676
750
  IncludeIframeOnlyStream?: boolean;
677
751
  /**
752
+ * @public
678
753
  * 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.
679
754
  */
680
755
  ManifestLayout?: ManifestLayout | string;
681
756
  /**
757
+ * @public
682
758
  * Time window (in seconds) contained in each manifest.
683
759
  */
684
760
  ManifestWindowSeconds?: number;
685
761
  /**
762
+ * @public
686
763
  * Minimum duration (in seconds) that a player will buffer media before starting the presentation.
687
764
  */
688
765
  MinBufferTimeSeconds?: number;
689
766
  /**
767
+ * @public
690
768
  * Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
691
769
  */
692
770
  MinUpdatePeriodSeconds?: number;
693
771
  /**
772
+ * @public
694
773
  * A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)
695
774
  * Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not
696
775
  * be partitioned into more than one period. If the list contains "ADS", new periods will be created where
@@ -698,31 +777,38 @@ export interface DashPackage {
698
777
  */
699
778
  PeriodTriggers?: (__PeriodTriggersElement | string)[];
700
779
  /**
780
+ * @public
701
781
  * 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.
702
782
  */
703
783
  Profile?: Profile | string;
704
784
  /**
785
+ * @public
705
786
  * Duration (in seconds) of each segment. Actual segments will be
706
787
  * rounded to the nearest multiple of the source segment duration.
707
788
  */
708
789
  SegmentDurationSeconds?: number;
709
790
  /**
791
+ * @public
710
792
  * 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.
711
793
  */
712
794
  SegmentTemplateFormat?: SegmentTemplateFormat | string;
713
795
  /**
796
+ * @public
714
797
  * A StreamSelection configuration.
715
798
  */
716
799
  StreamSelection?: StreamSelection;
717
800
  /**
801
+ * @public
718
802
  * Duration (in seconds) to delay live content before presentation.
719
803
  */
720
804
  SuggestedPresentationDelaySeconds?: number;
721
805
  /**
806
+ * @public
722
807
  * Determines the type of UTCTiming included in the Media Presentation Description (MPD)
723
808
  */
724
809
  UtcTiming?: UtcTiming | string;
725
810
  /**
811
+ * @public
726
812
  * Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE
727
813
  */
728
814
  UtcTimingUri?: string;
@@ -745,23 +831,28 @@ export type EncryptionMethod = (typeof EncryptionMethod)[keyof typeof Encryption
745
831
  */
746
832
  export interface HlsEncryption {
747
833
  /**
834
+ * @public
748
835
  * A constant initialization vector for encryption (optional).
749
836
  * When not specified the initialization vector will be periodically rotated.
750
837
  */
751
838
  ConstantInitializationVector?: string;
752
839
  /**
840
+ * @public
753
841
  * The encryption method to use.
754
842
  */
755
843
  EncryptionMethod?: EncryptionMethod | string;
756
844
  /**
845
+ * @public
757
846
  * Interval (in seconds) between each encryption key rotation.
758
847
  */
759
848
  KeyRotationIntervalSeconds?: number;
760
849
  /**
850
+ * @public
761
851
  * When enabled, the EXT-X-KEY tag will be repeated in output manifests.
762
852
  */
763
853
  RepeatExtXKey?: boolean;
764
854
  /**
855
+ * @public
765
856
  * A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
766
857
  */
767
858
  SpekeKeyProvider: SpekeKeyProvider | undefined;
@@ -772,6 +863,7 @@ export interface HlsEncryption {
772
863
  */
773
864
  export interface HlsPackage {
774
865
  /**
866
+ * @public
775
867
  * This setting controls how ad markers are included in the packaged OriginEndpoint.
776
868
  * "NONE" will omit all SCTE-35 ad markers from the output.
777
869
  * "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
@@ -784,12 +876,14 @@ export interface HlsPackage {
784
876
  */
785
877
  AdMarkers?: AdMarkers | string;
786
878
  /**
879
+ * @public
787
880
  * A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no
788
881
  * ad markers are output. Specify multiple items to create ad markers for all of the included
789
882
  * message types.
790
883
  */
791
884
  AdTriggers?: (__AdTriggersElement | string)[];
792
885
  /**
886
+ * @public
793
887
  * This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to
794
888
  * determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become
795
889
  * ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that
@@ -801,28 +895,34 @@ export interface HlsPackage {
801
895
  */
802
896
  AdsOnDeliveryRestrictions?: AdsOnDeliveryRestrictions | string;
803
897
  /**
898
+ * @public
804
899
  * An HTTP Live Streaming (HLS) encryption configuration.
805
900
  */
806
901
  Encryption?: HlsEncryption;
807
902
  /**
903
+ * @public
808
904
  * When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
809
905
  */
810
906
  IncludeDvbSubtitles?: boolean;
811
907
  /**
908
+ * @public
812
909
  * When enabled, an I-Frame only stream will be included in the output.
813
910
  */
814
911
  IncludeIframeOnlyStream?: boolean;
815
912
  /**
913
+ * @public
816
914
  * The HTTP Live Streaming (HLS) playlist type.
817
915
  * When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
818
916
  * entry will be included in the media playlist.
819
917
  */
820
918
  PlaylistType?: PlaylistType | string;
821
919
  /**
920
+ * @public
822
921
  * Time window (in seconds) contained in each parent manifest.
823
922
  */
824
923
  PlaylistWindowSeconds?: number;
825
924
  /**
925
+ * @public
826
926
  * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
827
927
  * inserted into manifests. Additionally, when an interval is specified
828
928
  * ID3Timed Metadata messages will be generated every 5 seconds using the
@@ -835,15 +935,18 @@ export interface HlsPackage {
835
935
  */
836
936
  ProgramDateTimeIntervalSeconds?: number;
837
937
  /**
938
+ * @public
838
939
  * Duration (in seconds) of each fragment. Actual fragments will be
839
940
  * rounded to the nearest multiple of the source fragment duration.
840
941
  */
841
942
  SegmentDurationSeconds?: number;
842
943
  /**
944
+ * @public
843
945
  * A StreamSelection configuration.
844
946
  */
845
947
  StreamSelection?: StreamSelection;
846
948
  /**
949
+ * @public
847
950
  * When enabled, audio streams will be placed in rendition groups in the output.
848
951
  */
849
952
  UseAudioRenditionGroup?: boolean;
@@ -854,6 +957,7 @@ export interface HlsPackage {
854
957
  */
855
958
  export interface MssEncryption {
856
959
  /**
960
+ * @public
857
961
  * A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
858
962
  */
859
963
  SpekeKeyProvider: SpekeKeyProvider | undefined;
@@ -864,18 +968,22 @@ export interface MssEncryption {
864
968
  */
865
969
  export interface MssPackage {
866
970
  /**
971
+ * @public
867
972
  * A Microsoft Smooth Streaming (MSS) encryption configuration.
868
973
  */
869
974
  Encryption?: MssEncryption;
870
975
  /**
976
+ * @public
871
977
  * The time window (in seconds) contained in each manifest.
872
978
  */
873
979
  ManifestWindowSeconds?: number;
874
980
  /**
981
+ * @public
875
982
  * The duration (in seconds) of each segment.
876
983
  */
877
984
  SegmentDurationSeconds?: number;
878
985
  /**
986
+ * @public
879
987
  * A StreamSelection configuration.
880
988
  */
881
989
  StreamSelection?: StreamSelection;
@@ -898,74 +1006,91 @@ export type Origination = (typeof Origination)[keyof typeof Origination];
898
1006
  */
899
1007
  export interface OriginEndpoint {
900
1008
  /**
1009
+ * @public
901
1010
  * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
902
1011
  */
903
1012
  Arn?: string;
904
1013
  /**
1014
+ * @public
905
1015
  * CDN Authorization credentials
906
1016
  */
907
1017
  Authorization?: Authorization;
908
1018
  /**
1019
+ * @public
909
1020
  * The ID of the Channel the OriginEndpoint is associated with.
910
1021
  */
911
1022
  ChannelId?: string;
912
1023
  /**
1024
+ * @public
913
1025
  * A Common Media Application Format (CMAF) packaging configuration.
914
1026
  */
915
1027
  CmafPackage?: CmafPackage;
916
1028
  /**
1029
+ * @public
917
1030
  * The date and time the OriginEndpoint was created.
918
1031
  */
919
1032
  CreatedAt?: string;
920
1033
  /**
1034
+ * @public
921
1035
  * A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
922
1036
  */
923
1037
  DashPackage?: DashPackage;
924
1038
  /**
1039
+ * @public
925
1040
  * A short text description of the OriginEndpoint.
926
1041
  */
927
1042
  Description?: string;
928
1043
  /**
1044
+ * @public
929
1045
  * An HTTP Live Streaming (HLS) packaging configuration.
930
1046
  */
931
1047
  HlsPackage?: HlsPackage;
932
1048
  /**
1049
+ * @public
933
1050
  * The ID of the OriginEndpoint.
934
1051
  */
935
1052
  Id?: string;
936
1053
  /**
1054
+ * @public
937
1055
  * A short string appended to the end of the OriginEndpoint URL.
938
1056
  */
939
1057
  ManifestName?: string;
940
1058
  /**
1059
+ * @public
941
1060
  * A Microsoft Smooth Streaming (MSS) packaging configuration.
942
1061
  */
943
1062
  MssPackage?: MssPackage;
944
1063
  /**
1064
+ * @public
945
1065
  * Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
946
1066
  * may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
947
1067
  * requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
948
1068
  */
949
1069
  Origination?: Origination | string;
950
1070
  /**
1071
+ * @public
951
1072
  * Maximum duration (seconds) of content to retain for startover playback.
952
1073
  * If not specified, startover playback will be disabled for the OriginEndpoint.
953
1074
  */
954
1075
  StartoverWindowSeconds?: number;
955
1076
  /**
1077
+ * @public
956
1078
  * A collection of tags associated with a resource
957
1079
  */
958
1080
  Tags?: Record<string, string>;
959
1081
  /**
1082
+ * @public
960
1083
  * Amount of delay (seconds) to enforce on the playback of live content.
961
1084
  * If not specified, there will be no time delay in effect for the OriginEndpoint.
962
1085
  */
963
1086
  TimeDelaySeconds?: number;
964
1087
  /**
1088
+ * @public
965
1089
  * The URL of the packaged OriginEndpoint for consumption.
966
1090
  */
967
1091
  Url?: string;
968
1092
  /**
1093
+ * @public
969
1094
  * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
970
1095
  */
971
1096
  Whitelist?: string[];
@@ -976,23 +1101,28 @@ export interface OriginEndpoint {
976
1101
  */
977
1102
  export interface CmafPackageCreateOrUpdateParameters {
978
1103
  /**
1104
+ * @public
979
1105
  * A Common Media Application Format (CMAF) encryption configuration.
980
1106
  */
981
1107
  Encryption?: CmafEncryption;
982
1108
  /**
1109
+ * @public
983
1110
  * A list of HLS manifest configurations
984
1111
  */
985
1112
  HlsManifests?: HlsManifestCreateOrUpdateParameters[];
986
1113
  /**
1114
+ * @public
987
1115
  * Duration (in seconds) of each segment. Actual segments will be
988
1116
  * rounded to the nearest multiple of the source segment duration.
989
1117
  */
990
1118
  SegmentDurationSeconds?: number;
991
1119
  /**
1120
+ * @public
992
1121
  * An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
993
1122
  */
994
1123
  SegmentPrefix?: string;
995
1124
  /**
1125
+ * @public
996
1126
  * A StreamSelection configuration.
997
1127
  */
998
1128
  StreamSelection?: StreamSelection;
@@ -1003,14 +1133,17 @@ export interface CmafPackageCreateOrUpdateParameters {
1003
1133
  */
1004
1134
  export interface ConfigureLogsRequest {
1005
1135
  /**
1136
+ * @public
1006
1137
  * Configure egress access logging.
1007
1138
  */
1008
1139
  EgressAccessLogs?: EgressAccessLogs;
1009
1140
  /**
1141
+ * @public
1010
1142
  * The ID of the channel to log subscription.
1011
1143
  */
1012
1144
  Id: string | undefined;
1013
1145
  /**
1146
+ * @public
1014
1147
  * Configure ingress access logging.
1015
1148
  */
1016
1149
  IngressAccessLogs?: IngressAccessLogs;
@@ -1020,34 +1153,42 @@ export interface ConfigureLogsRequest {
1020
1153
  */
1021
1154
  export interface ConfigureLogsResponse {
1022
1155
  /**
1156
+ * @public
1023
1157
  * The Amazon Resource Name (ARN) assigned to the Channel.
1024
1158
  */
1025
1159
  Arn?: string;
1026
1160
  /**
1161
+ * @public
1027
1162
  * The date and time the Channel was created.
1028
1163
  */
1029
1164
  CreatedAt?: string;
1030
1165
  /**
1166
+ * @public
1031
1167
  * A short text description of the Channel.
1032
1168
  */
1033
1169
  Description?: string;
1034
1170
  /**
1171
+ * @public
1035
1172
  * Configure egress access logging.
1036
1173
  */
1037
1174
  EgressAccessLogs?: EgressAccessLogs;
1038
1175
  /**
1176
+ * @public
1039
1177
  * An HTTP Live Streaming (HLS) ingest resource configuration.
1040
1178
  */
1041
1179
  HlsIngest?: HlsIngest;
1042
1180
  /**
1181
+ * @public
1043
1182
  * The ID of the Channel.
1044
1183
  */
1045
1184
  Id?: string;
1046
1185
  /**
1186
+ * @public
1047
1187
  * Configure ingress access logging.
1048
1188
  */
1049
1189
  IngressAccessLogs?: IngressAccessLogs;
1050
1190
  /**
1191
+ * @public
1051
1192
  * A collection of tags associated with a resource
1052
1193
  */
1053
1194
  Tags?: Record<string, string>;
@@ -1136,15 +1277,18 @@ export declare class UnprocessableEntityException extends __BaseException {
1136
1277
  */
1137
1278
  export interface CreateChannelRequest {
1138
1279
  /**
1280
+ * @public
1139
1281
  * A short text description of the Channel.
1140
1282
  */
1141
1283
  Description?: string;
1142
1284
  /**
1285
+ * @public
1143
1286
  * The ID of the Channel. The ID must be unique within the region and it
1144
1287
  * cannot be changed after a Channel is created.
1145
1288
  */
1146
1289
  Id: string | undefined;
1147
1290
  /**
1291
+ * @public
1148
1292
  * A collection of tags associated with a resource
1149
1293
  */
1150
1294
  Tags?: Record<string, string>;
@@ -1154,34 +1298,42 @@ export interface CreateChannelRequest {
1154
1298
  */
1155
1299
  export interface CreateChannelResponse {
1156
1300
  /**
1301
+ * @public
1157
1302
  * The Amazon Resource Name (ARN) assigned to the Channel.
1158
1303
  */
1159
1304
  Arn?: string;
1160
1305
  /**
1306
+ * @public
1161
1307
  * The date and time the Channel was created.
1162
1308
  */
1163
1309
  CreatedAt?: string;
1164
1310
  /**
1311
+ * @public
1165
1312
  * A short text description of the Channel.
1166
1313
  */
1167
1314
  Description?: string;
1168
1315
  /**
1316
+ * @public
1169
1317
  * Configure egress access logging.
1170
1318
  */
1171
1319
  EgressAccessLogs?: EgressAccessLogs;
1172
1320
  /**
1321
+ * @public
1173
1322
  * An HTTP Live Streaming (HLS) ingest resource configuration.
1174
1323
  */
1175
1324
  HlsIngest?: HlsIngest;
1176
1325
  /**
1326
+ * @public
1177
1327
  * The ID of the Channel.
1178
1328
  */
1179
1329
  Id?: string;
1180
1330
  /**
1331
+ * @public
1181
1332
  * Configure ingress access logging.
1182
1333
  */
1183
1334
  IngressAccessLogs?: IngressAccessLogs;
1184
1335
  /**
1336
+ * @public
1185
1337
  * A collection of tags associated with a resource
1186
1338
  */
1187
1339
  Tags?: Record<string, string>;
@@ -1192,24 +1344,29 @@ export interface CreateChannelResponse {
1192
1344
  */
1193
1345
  export interface CreateHarvestJobRequest {
1194
1346
  /**
1347
+ * @public
1195
1348
  * The end of the time-window which will be harvested
1196
1349
  */
1197
1350
  EndTime: string | undefined;
1198
1351
  /**
1352
+ * @public
1199
1353
  * The ID of the HarvestJob. The ID must be unique within the region
1200
1354
  * and it cannot be changed after the HarvestJob is submitted
1201
1355
  */
1202
1356
  Id: string | undefined;
1203
1357
  /**
1358
+ * @public
1204
1359
  * The ID of the OriginEndpoint that the HarvestJob will harvest from.
1205
1360
  * This cannot be changed after the HarvestJob is submitted.
1206
1361
  */
1207
1362
  OriginEndpointId: string | undefined;
1208
1363
  /**
1364
+ * @public
1209
1365
  * Configuration parameters for where in an S3 bucket to place the harvested content
1210
1366
  */
1211
1367
  S3Destination: S3Destination | undefined;
1212
1368
  /**
1369
+ * @public
1213
1370
  * The start of the time-window which will be harvested
1214
1371
  */
1215
1372
  StartTime: string | undefined;
@@ -1219,40 +1376,49 @@ export interface CreateHarvestJobRequest {
1219
1376
  */
1220
1377
  export interface CreateHarvestJobResponse {
1221
1378
  /**
1379
+ * @public
1222
1380
  * The Amazon Resource Name (ARN) assigned to the HarvestJob.
1223
1381
  */
1224
1382
  Arn?: string;
1225
1383
  /**
1384
+ * @public
1226
1385
  * The ID of the Channel that the HarvestJob will harvest from.
1227
1386
  */
1228
1387
  ChannelId?: string;
1229
1388
  /**
1389
+ * @public
1230
1390
  * The date and time the HarvestJob was submitted.
1231
1391
  */
1232
1392
  CreatedAt?: string;
1233
1393
  /**
1394
+ * @public
1234
1395
  * The end of the time-window which will be harvested.
1235
1396
  */
1236
1397
  EndTime?: string;
1237
1398
  /**
1399
+ * @public
1238
1400
  * The ID of the HarvestJob. The ID must be unique within the region
1239
1401
  * and it cannot be changed after the HarvestJob is submitted.
1240
1402
  */
1241
1403
  Id?: string;
1242
1404
  /**
1405
+ * @public
1243
1406
  * The ID of the OriginEndpoint that the HarvestJob will harvest from.
1244
1407
  * This cannot be changed after the HarvestJob is submitted.
1245
1408
  */
1246
1409
  OriginEndpointId?: string;
1247
1410
  /**
1411
+ * @public
1248
1412
  * Configuration parameters for where in an S3 bucket to place the harvested content
1249
1413
  */
1250
1414
  S3Destination?: S3Destination;
1251
1415
  /**
1416
+ * @public
1252
1417
  * The start of the time-window which will be harvested.
1253
1418
  */
1254
1419
  StartTime?: string;
1255
1420
  /**
1421
+ * @public
1256
1422
  * The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for
1257
1423
  * HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will
1258
1424
  * include an explanation of why the HarvestJob failed.
@@ -1265,64 +1431,78 @@ export interface CreateHarvestJobResponse {
1265
1431
  */
1266
1432
  export interface CreateOriginEndpointRequest {
1267
1433
  /**
1434
+ * @public
1268
1435
  * CDN Authorization credentials
1269
1436
  */
1270
1437
  Authorization?: Authorization;
1271
1438
  /**
1439
+ * @public
1272
1440
  * The ID of the Channel that the OriginEndpoint will be associated with.
1273
1441
  * This cannot be changed after the OriginEndpoint is created.
1274
1442
  */
1275
1443
  ChannelId: string | undefined;
1276
1444
  /**
1445
+ * @public
1277
1446
  * A Common Media Application Format (CMAF) packaging configuration.
1278
1447
  */
1279
1448
  CmafPackage?: CmafPackageCreateOrUpdateParameters;
1280
1449
  /**
1450
+ * @public
1281
1451
  * A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
1282
1452
  */
1283
1453
  DashPackage?: DashPackage;
1284
1454
  /**
1455
+ * @public
1285
1456
  * A short text description of the OriginEndpoint.
1286
1457
  */
1287
1458
  Description?: string;
1288
1459
  /**
1460
+ * @public
1289
1461
  * An HTTP Live Streaming (HLS) packaging configuration.
1290
1462
  */
1291
1463
  HlsPackage?: HlsPackage;
1292
1464
  /**
1465
+ * @public
1293
1466
  * The ID of the OriginEndpoint. The ID must be unique within the region
1294
1467
  * and it cannot be changed after the OriginEndpoint is created.
1295
1468
  */
1296
1469
  Id: string | undefined;
1297
1470
  /**
1471
+ * @public
1298
1472
  * A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
1299
1473
  */
1300
1474
  ManifestName?: string;
1301
1475
  /**
1476
+ * @public
1302
1477
  * A Microsoft Smooth Streaming (MSS) packaging configuration.
1303
1478
  */
1304
1479
  MssPackage?: MssPackage;
1305
1480
  /**
1481
+ * @public
1306
1482
  * Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
1307
1483
  * may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
1308
1484
  * requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
1309
1485
  */
1310
1486
  Origination?: Origination | string;
1311
1487
  /**
1488
+ * @public
1312
1489
  * Maximum duration (seconds) of content to retain for startover playback.
1313
1490
  * If not specified, startover playback will be disabled for the OriginEndpoint.
1314
1491
  */
1315
1492
  StartoverWindowSeconds?: number;
1316
1493
  /**
1494
+ * @public
1317
1495
  * A collection of tags associated with a resource
1318
1496
  */
1319
1497
  Tags?: Record<string, string>;
1320
1498
  /**
1499
+ * @public
1321
1500
  * Amount of delay (seconds) to enforce on the playback of live content.
1322
1501
  * If not specified, there will be no time delay in effect for the OriginEndpoint.
1323
1502
  */
1324
1503
  TimeDelaySeconds?: number;
1325
1504
  /**
1505
+ * @public
1326
1506
  * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
1327
1507
  */
1328
1508
  Whitelist?: string[];
@@ -1332,74 +1512,91 @@ export interface CreateOriginEndpointRequest {
1332
1512
  */
1333
1513
  export interface CreateOriginEndpointResponse {
1334
1514
  /**
1515
+ * @public
1335
1516
  * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
1336
1517
  */
1337
1518
  Arn?: string;
1338
1519
  /**
1520
+ * @public
1339
1521
  * CDN Authorization credentials
1340
1522
  */
1341
1523
  Authorization?: Authorization;
1342
1524
  /**
1525
+ * @public
1343
1526
  * The ID of the Channel the OriginEndpoint is associated with.
1344
1527
  */
1345
1528
  ChannelId?: string;
1346
1529
  /**
1530
+ * @public
1347
1531
  * A Common Media Application Format (CMAF) packaging configuration.
1348
1532
  */
1349
1533
  CmafPackage?: CmafPackage;
1350
1534
  /**
1535
+ * @public
1351
1536
  * The date and time the OriginEndpoint was created.
1352
1537
  */
1353
1538
  CreatedAt?: string;
1354
1539
  /**
1540
+ * @public
1355
1541
  * A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
1356
1542
  */
1357
1543
  DashPackage?: DashPackage;
1358
1544
  /**
1545
+ * @public
1359
1546
  * A short text description of the OriginEndpoint.
1360
1547
  */
1361
1548
  Description?: string;
1362
1549
  /**
1550
+ * @public
1363
1551
  * An HTTP Live Streaming (HLS) packaging configuration.
1364
1552
  */
1365
1553
  HlsPackage?: HlsPackage;
1366
1554
  /**
1555
+ * @public
1367
1556
  * The ID of the OriginEndpoint.
1368
1557
  */
1369
1558
  Id?: string;
1370
1559
  /**
1560
+ * @public
1371
1561
  * A short string appended to the end of the OriginEndpoint URL.
1372
1562
  */
1373
1563
  ManifestName?: string;
1374
1564
  /**
1565
+ * @public
1375
1566
  * A Microsoft Smooth Streaming (MSS) packaging configuration.
1376
1567
  */
1377
1568
  MssPackage?: MssPackage;
1378
1569
  /**
1570
+ * @public
1379
1571
  * Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
1380
1572
  * may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
1381
1573
  * requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
1382
1574
  */
1383
1575
  Origination?: Origination | string;
1384
1576
  /**
1577
+ * @public
1385
1578
  * Maximum duration (seconds) of content to retain for startover playback.
1386
1579
  * If not specified, startover playback will be disabled for the OriginEndpoint.
1387
1580
  */
1388
1581
  StartoverWindowSeconds?: number;
1389
1582
  /**
1583
+ * @public
1390
1584
  * A collection of tags associated with a resource
1391
1585
  */
1392
1586
  Tags?: Record<string, string>;
1393
1587
  /**
1588
+ * @public
1394
1589
  * Amount of delay (seconds) to enforce on the playback of live content.
1395
1590
  * If not specified, there will be no time delay in effect for the OriginEndpoint.
1396
1591
  */
1397
1592
  TimeDelaySeconds?: number;
1398
1593
  /**
1594
+ * @public
1399
1595
  * The URL of the packaged OriginEndpoint for consumption.
1400
1596
  */
1401
1597
  Url?: string;
1402
1598
  /**
1599
+ * @public
1403
1600
  * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
1404
1601
  */
1405
1602
  Whitelist?: string[];
@@ -1409,6 +1606,7 @@ export interface CreateOriginEndpointResponse {
1409
1606
  */
1410
1607
  export interface DeleteChannelRequest {
1411
1608
  /**
1609
+ * @public
1412
1610
  * The ID of the Channel to delete.
1413
1611
  */
1414
1612
  Id: string | undefined;
@@ -1423,6 +1621,7 @@ export interface DeleteChannelResponse {
1423
1621
  */
1424
1622
  export interface DeleteOriginEndpointRequest {
1425
1623
  /**
1624
+ * @public
1426
1625
  * The ID of the OriginEndpoint to delete.
1427
1626
  */
1428
1627
  Id: string | undefined;
@@ -1437,6 +1636,7 @@ export interface DeleteOriginEndpointResponse {
1437
1636
  */
1438
1637
  export interface DescribeChannelRequest {
1439
1638
  /**
1639
+ * @public
1440
1640
  * The ID of a Channel.
1441
1641
  */
1442
1642
  Id: string | undefined;
@@ -1446,34 +1646,42 @@ export interface DescribeChannelRequest {
1446
1646
  */
1447
1647
  export interface DescribeChannelResponse {
1448
1648
  /**
1649
+ * @public
1449
1650
  * The Amazon Resource Name (ARN) assigned to the Channel.
1450
1651
  */
1451
1652
  Arn?: string;
1452
1653
  /**
1654
+ * @public
1453
1655
  * The date and time the Channel was created.
1454
1656
  */
1455
1657
  CreatedAt?: string;
1456
1658
  /**
1659
+ * @public
1457
1660
  * A short text description of the Channel.
1458
1661
  */
1459
1662
  Description?: string;
1460
1663
  /**
1664
+ * @public
1461
1665
  * Configure egress access logging.
1462
1666
  */
1463
1667
  EgressAccessLogs?: EgressAccessLogs;
1464
1668
  /**
1669
+ * @public
1465
1670
  * An HTTP Live Streaming (HLS) ingest resource configuration.
1466
1671
  */
1467
1672
  HlsIngest?: HlsIngest;
1468
1673
  /**
1674
+ * @public
1469
1675
  * The ID of the Channel.
1470
1676
  */
1471
1677
  Id?: string;
1472
1678
  /**
1679
+ * @public
1473
1680
  * Configure ingress access logging.
1474
1681
  */
1475
1682
  IngressAccessLogs?: IngressAccessLogs;
1476
1683
  /**
1684
+ * @public
1477
1685
  * A collection of tags associated with a resource
1478
1686
  */
1479
1687
  Tags?: Record<string, string>;
@@ -1483,6 +1691,7 @@ export interface DescribeChannelResponse {
1483
1691
  */
1484
1692
  export interface DescribeHarvestJobRequest {
1485
1693
  /**
1694
+ * @public
1486
1695
  * The ID of the HarvestJob.
1487
1696
  */
1488
1697
  Id: string | undefined;
@@ -1492,40 +1701,49 @@ export interface DescribeHarvestJobRequest {
1492
1701
  */
1493
1702
  export interface DescribeHarvestJobResponse {
1494
1703
  /**
1704
+ * @public
1495
1705
  * The Amazon Resource Name (ARN) assigned to the HarvestJob.
1496
1706
  */
1497
1707
  Arn?: string;
1498
1708
  /**
1709
+ * @public
1499
1710
  * The ID of the Channel that the HarvestJob will harvest from.
1500
1711
  */
1501
1712
  ChannelId?: string;
1502
1713
  /**
1714
+ * @public
1503
1715
  * The date and time the HarvestJob was submitted.
1504
1716
  */
1505
1717
  CreatedAt?: string;
1506
1718
  /**
1719
+ * @public
1507
1720
  * The end of the time-window which will be harvested.
1508
1721
  */
1509
1722
  EndTime?: string;
1510
1723
  /**
1724
+ * @public
1511
1725
  * The ID of the HarvestJob. The ID must be unique within the region
1512
1726
  * and it cannot be changed after the HarvestJob is submitted.
1513
1727
  */
1514
1728
  Id?: string;
1515
1729
  /**
1730
+ * @public
1516
1731
  * The ID of the OriginEndpoint that the HarvestJob will harvest from.
1517
1732
  * This cannot be changed after the HarvestJob is submitted.
1518
1733
  */
1519
1734
  OriginEndpointId?: string;
1520
1735
  /**
1736
+ * @public
1521
1737
  * Configuration parameters for where in an S3 bucket to place the harvested content
1522
1738
  */
1523
1739
  S3Destination?: S3Destination;
1524
1740
  /**
1741
+ * @public
1525
1742
  * The start of the time-window which will be harvested.
1526
1743
  */
1527
1744
  StartTime?: string;
1528
1745
  /**
1746
+ * @public
1529
1747
  * The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for
1530
1748
  * HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will
1531
1749
  * include an explanation of why the HarvestJob failed.
@@ -1537,6 +1755,7 @@ export interface DescribeHarvestJobResponse {
1537
1755
  */
1538
1756
  export interface DescribeOriginEndpointRequest {
1539
1757
  /**
1758
+ * @public
1540
1759
  * The ID of the OriginEndpoint.
1541
1760
  */
1542
1761
  Id: string | undefined;
@@ -1546,74 +1765,91 @@ export interface DescribeOriginEndpointRequest {
1546
1765
  */
1547
1766
  export interface DescribeOriginEndpointResponse {
1548
1767
  /**
1768
+ * @public
1549
1769
  * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
1550
1770
  */
1551
1771
  Arn?: string;
1552
1772
  /**
1773
+ * @public
1553
1774
  * CDN Authorization credentials
1554
1775
  */
1555
1776
  Authorization?: Authorization;
1556
1777
  /**
1778
+ * @public
1557
1779
  * The ID of the Channel the OriginEndpoint is associated with.
1558
1780
  */
1559
1781
  ChannelId?: string;
1560
1782
  /**
1783
+ * @public
1561
1784
  * A Common Media Application Format (CMAF) packaging configuration.
1562
1785
  */
1563
1786
  CmafPackage?: CmafPackage;
1564
1787
  /**
1788
+ * @public
1565
1789
  * The date and time the OriginEndpoint was created.
1566
1790
  */
1567
1791
  CreatedAt?: string;
1568
1792
  /**
1793
+ * @public
1569
1794
  * A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
1570
1795
  */
1571
1796
  DashPackage?: DashPackage;
1572
1797
  /**
1798
+ * @public
1573
1799
  * A short text description of the OriginEndpoint.
1574
1800
  */
1575
1801
  Description?: string;
1576
1802
  /**
1803
+ * @public
1577
1804
  * An HTTP Live Streaming (HLS) packaging configuration.
1578
1805
  */
1579
1806
  HlsPackage?: HlsPackage;
1580
1807
  /**
1808
+ * @public
1581
1809
  * The ID of the OriginEndpoint.
1582
1810
  */
1583
1811
  Id?: string;
1584
1812
  /**
1813
+ * @public
1585
1814
  * A short string appended to the end of the OriginEndpoint URL.
1586
1815
  */
1587
1816
  ManifestName?: string;
1588
1817
  /**
1818
+ * @public
1589
1819
  * A Microsoft Smooth Streaming (MSS) packaging configuration.
1590
1820
  */
1591
1821
  MssPackage?: MssPackage;
1592
1822
  /**
1823
+ * @public
1593
1824
  * Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
1594
1825
  * may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
1595
1826
  * requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
1596
1827
  */
1597
1828
  Origination?: Origination | string;
1598
1829
  /**
1830
+ * @public
1599
1831
  * Maximum duration (seconds) of content to retain for startover playback.
1600
1832
  * If not specified, startover playback will be disabled for the OriginEndpoint.
1601
1833
  */
1602
1834
  StartoverWindowSeconds?: number;
1603
1835
  /**
1836
+ * @public
1604
1837
  * A collection of tags associated with a resource
1605
1838
  */
1606
1839
  Tags?: Record<string, string>;
1607
1840
  /**
1841
+ * @public
1608
1842
  * Amount of delay (seconds) to enforce on the playback of live content.
1609
1843
  * If not specified, there will be no time delay in effect for the OriginEndpoint.
1610
1844
  */
1611
1845
  TimeDelaySeconds?: number;
1612
1846
  /**
1847
+ * @public
1613
1848
  * The URL of the packaged OriginEndpoint for consumption.
1614
1849
  */
1615
1850
  Url?: string;
1616
1851
  /**
1852
+ * @public
1617
1853
  * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
1618
1854
  */
1619
1855
  Whitelist?: string[];
@@ -1623,10 +1859,12 @@ export interface DescribeOriginEndpointResponse {
1623
1859
  */
1624
1860
  export interface ListChannelsRequest {
1625
1861
  /**
1862
+ * @public
1626
1863
  * Upper bound on number of records to return.
1627
1864
  */
1628
1865
  MaxResults?: number;
1629
1866
  /**
1867
+ * @public
1630
1868
  * A token used to resume pagination from the end of a previous request.
1631
1869
  */
1632
1870
  NextToken?: string;
@@ -1636,10 +1874,12 @@ export interface ListChannelsRequest {
1636
1874
  */
1637
1875
  export interface ListChannelsResponse {
1638
1876
  /**
1877
+ * @public
1639
1878
  * A list of Channel records.
1640
1879
  */
1641
1880
  Channels?: Channel[];
1642
1881
  /**
1882
+ * @public
1643
1883
  * A token that can be used to resume pagination from the end of the collection.
1644
1884
  */
1645
1885
  NextToken?: string;
@@ -1649,18 +1889,22 @@ export interface ListChannelsResponse {
1649
1889
  */
1650
1890
  export interface ListHarvestJobsRequest {
1651
1891
  /**
1892
+ * @public
1652
1893
  * When specified, the request will return only HarvestJobs associated with the given Channel ID.
1653
1894
  */
1654
1895
  IncludeChannelId?: string;
1655
1896
  /**
1897
+ * @public
1656
1898
  * When specified, the request will return only HarvestJobs in the given status.
1657
1899
  */
1658
1900
  IncludeStatus?: string;
1659
1901
  /**
1902
+ * @public
1660
1903
  * The upper bound on the number of records to return.
1661
1904
  */
1662
1905
  MaxResults?: number;
1663
1906
  /**
1907
+ * @public
1664
1908
  * A token used to resume pagination from the end of a previous request.
1665
1909
  */
1666
1910
  NextToken?: string;
@@ -1670,10 +1914,12 @@ export interface ListHarvestJobsRequest {
1670
1914
  */
1671
1915
  export interface ListHarvestJobsResponse {
1672
1916
  /**
1917
+ * @public
1673
1918
  * A list of HarvestJob records.
1674
1919
  */
1675
1920
  HarvestJobs?: HarvestJob[];
1676
1921
  /**
1922
+ * @public
1677
1923
  * A token that can be used to resume pagination from the end of the collection.
1678
1924
  */
1679
1925
  NextToken?: string;
@@ -1683,14 +1929,17 @@ export interface ListHarvestJobsResponse {
1683
1929
  */
1684
1930
  export interface ListOriginEndpointsRequest {
1685
1931
  /**
1932
+ * @public
1686
1933
  * When specified, the request will return only OriginEndpoints associated with the given Channel ID.
1687
1934
  */
1688
1935
  ChannelId?: string;
1689
1936
  /**
1937
+ * @public
1690
1938
  * The upper bound on the number of records to return.
1691
1939
  */
1692
1940
  MaxResults?: number;
1693
1941
  /**
1942
+ * @public
1694
1943
  * A token used to resume pagination from the end of a previous request.
1695
1944
  */
1696
1945
  NextToken?: string;
@@ -1700,10 +1949,12 @@ export interface ListOriginEndpointsRequest {
1700
1949
  */
1701
1950
  export interface ListOriginEndpointsResponse {
1702
1951
  /**
1952
+ * @public
1703
1953
  * A token that can be used to resume pagination from the end of the collection.
1704
1954
  */
1705
1955
  NextToken?: string;
1706
1956
  /**
1957
+ * @public
1707
1958
  * A list of OriginEndpoint records.
1708
1959
  */
1709
1960
  OriginEndpoints?: OriginEndpoint[];
@@ -1725,6 +1976,7 @@ export interface ListTagsForResourceResponse {
1725
1976
  */
1726
1977
  export interface RotateChannelCredentialsRequest {
1727
1978
  /**
1979
+ * @public
1728
1980
  * The ID of the channel to update.
1729
1981
  */
1730
1982
  Id: string | undefined;
@@ -1734,34 +1986,42 @@ export interface RotateChannelCredentialsRequest {
1734
1986
  */
1735
1987
  export interface RotateChannelCredentialsResponse {
1736
1988
  /**
1989
+ * @public
1737
1990
  * The Amazon Resource Name (ARN) assigned to the Channel.
1738
1991
  */
1739
1992
  Arn?: string;
1740
1993
  /**
1994
+ * @public
1741
1995
  * The date and time the Channel was created.
1742
1996
  */
1743
1997
  CreatedAt?: string;
1744
1998
  /**
1999
+ * @public
1745
2000
  * A short text description of the Channel.
1746
2001
  */
1747
2002
  Description?: string;
1748
2003
  /**
2004
+ * @public
1749
2005
  * Configure egress access logging.
1750
2006
  */
1751
2007
  EgressAccessLogs?: EgressAccessLogs;
1752
2008
  /**
2009
+ * @public
1753
2010
  * An HTTP Live Streaming (HLS) ingest resource configuration.
1754
2011
  */
1755
2012
  HlsIngest?: HlsIngest;
1756
2013
  /**
2014
+ * @public
1757
2015
  * The ID of the Channel.
1758
2016
  */
1759
2017
  Id?: string;
1760
2018
  /**
2019
+ * @public
1761
2020
  * Configure ingress access logging.
1762
2021
  */
1763
2022
  IngressAccessLogs?: IngressAccessLogs;
1764
2023
  /**
2024
+ * @public
1765
2025
  * A collection of tags associated with a resource
1766
2026
  */
1767
2027
  Tags?: Record<string, string>;
@@ -1771,10 +2031,12 @@ export interface RotateChannelCredentialsResponse {
1771
2031
  */
1772
2032
  export interface RotateIngestEndpointCredentialsRequest {
1773
2033
  /**
2034
+ * @public
1774
2035
  * The ID of the channel the IngestEndpoint is on.
1775
2036
  */
1776
2037
  Id: string | undefined;
1777
2038
  /**
2039
+ * @public
1778
2040
  * The id of the IngestEndpoint whose credentials should be rotated
1779
2041
  */
1780
2042
  IngestEndpointId: string | undefined;
@@ -1784,34 +2046,42 @@ export interface RotateIngestEndpointCredentialsRequest {
1784
2046
  */
1785
2047
  export interface RotateIngestEndpointCredentialsResponse {
1786
2048
  /**
2049
+ * @public
1787
2050
  * The Amazon Resource Name (ARN) assigned to the Channel.
1788
2051
  */
1789
2052
  Arn?: string;
1790
2053
  /**
2054
+ * @public
1791
2055
  * The date and time the Channel was created.
1792
2056
  */
1793
2057
  CreatedAt?: string;
1794
2058
  /**
2059
+ * @public
1795
2060
  * A short text description of the Channel.
1796
2061
  */
1797
2062
  Description?: string;
1798
2063
  /**
2064
+ * @public
1799
2065
  * Configure egress access logging.
1800
2066
  */
1801
2067
  EgressAccessLogs?: EgressAccessLogs;
1802
2068
  /**
2069
+ * @public
1803
2070
  * An HTTP Live Streaming (HLS) ingest resource configuration.
1804
2071
  */
1805
2072
  HlsIngest?: HlsIngest;
1806
2073
  /**
2074
+ * @public
1807
2075
  * The ID of the Channel.
1808
2076
  */
1809
2077
  Id?: string;
1810
2078
  /**
2079
+ * @public
1811
2080
  * Configure ingress access logging.
1812
2081
  */
1813
2082
  IngressAccessLogs?: IngressAccessLogs;
1814
2083
  /**
2084
+ * @public
1815
2085
  * A collection of tags associated with a resource
1816
2086
  */
1817
2087
  Tags?: Record<string, string>;
@@ -1829,6 +2099,7 @@ export interface TagResourceRequest {
1829
2099
  export interface UntagResourceRequest {
1830
2100
  ResourceArn: string | undefined;
1831
2101
  /**
2102
+ * @public
1832
2103
  * The key(s) of tag to be deleted
1833
2104
  */
1834
2105
  TagKeys: string[] | undefined;
@@ -1839,10 +2110,12 @@ export interface UntagResourceRequest {
1839
2110
  */
1840
2111
  export interface UpdateChannelRequest {
1841
2112
  /**
2113
+ * @public
1842
2114
  * A short text description of the Channel.
1843
2115
  */
1844
2116
  Description?: string;
1845
2117
  /**
2118
+ * @public
1846
2119
  * The ID of the Channel to update.
1847
2120
  */
1848
2121
  Id: string | undefined;
@@ -1852,34 +2125,42 @@ export interface UpdateChannelRequest {
1852
2125
  */
1853
2126
  export interface UpdateChannelResponse {
1854
2127
  /**
2128
+ * @public
1855
2129
  * The Amazon Resource Name (ARN) assigned to the Channel.
1856
2130
  */
1857
2131
  Arn?: string;
1858
2132
  /**
2133
+ * @public
1859
2134
  * The date and time the Channel was created.
1860
2135
  */
1861
2136
  CreatedAt?: string;
1862
2137
  /**
2138
+ * @public
1863
2139
  * A short text description of the Channel.
1864
2140
  */
1865
2141
  Description?: string;
1866
2142
  /**
2143
+ * @public
1867
2144
  * Configure egress access logging.
1868
2145
  */
1869
2146
  EgressAccessLogs?: EgressAccessLogs;
1870
2147
  /**
2148
+ * @public
1871
2149
  * An HTTP Live Streaming (HLS) ingest resource configuration.
1872
2150
  */
1873
2151
  HlsIngest?: HlsIngest;
1874
2152
  /**
2153
+ * @public
1875
2154
  * The ID of the Channel.
1876
2155
  */
1877
2156
  Id?: string;
1878
2157
  /**
2158
+ * @public
1879
2159
  * Configure ingress access logging.
1880
2160
  */
1881
2161
  IngressAccessLogs?: IngressAccessLogs;
1882
2162
  /**
2163
+ * @public
1883
2164
  * A collection of tags associated with a resource
1884
2165
  */
1885
2166
  Tags?: Record<string, string>;
@@ -1890,54 +2171,66 @@ export interface UpdateChannelResponse {
1890
2171
  */
1891
2172
  export interface UpdateOriginEndpointRequest {
1892
2173
  /**
2174
+ * @public
1893
2175
  * CDN Authorization credentials
1894
2176
  */
1895
2177
  Authorization?: Authorization;
1896
2178
  /**
2179
+ * @public
1897
2180
  * A Common Media Application Format (CMAF) packaging configuration.
1898
2181
  */
1899
2182
  CmafPackage?: CmafPackageCreateOrUpdateParameters;
1900
2183
  /**
2184
+ * @public
1901
2185
  * A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
1902
2186
  */
1903
2187
  DashPackage?: DashPackage;
1904
2188
  /**
2189
+ * @public
1905
2190
  * A short text description of the OriginEndpoint.
1906
2191
  */
1907
2192
  Description?: string;
1908
2193
  /**
2194
+ * @public
1909
2195
  * An HTTP Live Streaming (HLS) packaging configuration.
1910
2196
  */
1911
2197
  HlsPackage?: HlsPackage;
1912
2198
  /**
2199
+ * @public
1913
2200
  * The ID of the OriginEndpoint to update.
1914
2201
  */
1915
2202
  Id: string | undefined;
1916
2203
  /**
2204
+ * @public
1917
2205
  * A short string that will be appended to the end of the Endpoint URL.
1918
2206
  */
1919
2207
  ManifestName?: string;
1920
2208
  /**
2209
+ * @public
1921
2210
  * A Microsoft Smooth Streaming (MSS) packaging configuration.
1922
2211
  */
1923
2212
  MssPackage?: MssPackage;
1924
2213
  /**
2214
+ * @public
1925
2215
  * Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
1926
2216
  * may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
1927
2217
  * requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
1928
2218
  */
1929
2219
  Origination?: Origination | string;
1930
2220
  /**
2221
+ * @public
1931
2222
  * Maximum duration (in seconds) of content to retain for startover playback.
1932
2223
  * If not specified, startover playback will be disabled for the OriginEndpoint.
1933
2224
  */
1934
2225
  StartoverWindowSeconds?: number;
1935
2226
  /**
2227
+ * @public
1936
2228
  * Amount of delay (in seconds) to enforce on the playback of live content.
1937
2229
  * If not specified, there will be no time delay in effect for the OriginEndpoint.
1938
2230
  */
1939
2231
  TimeDelaySeconds?: number;
1940
2232
  /**
2233
+ * @public
1941
2234
  * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
1942
2235
  */
1943
2236
  Whitelist?: string[];
@@ -1947,74 +2240,91 @@ export interface UpdateOriginEndpointRequest {
1947
2240
  */
1948
2241
  export interface UpdateOriginEndpointResponse {
1949
2242
  /**
2243
+ * @public
1950
2244
  * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
1951
2245
  */
1952
2246
  Arn?: string;
1953
2247
  /**
2248
+ * @public
1954
2249
  * CDN Authorization credentials
1955
2250
  */
1956
2251
  Authorization?: Authorization;
1957
2252
  /**
2253
+ * @public
1958
2254
  * The ID of the Channel the OriginEndpoint is associated with.
1959
2255
  */
1960
2256
  ChannelId?: string;
1961
2257
  /**
2258
+ * @public
1962
2259
  * A Common Media Application Format (CMAF) packaging configuration.
1963
2260
  */
1964
2261
  CmafPackage?: CmafPackage;
1965
2262
  /**
2263
+ * @public
1966
2264
  * The date and time the OriginEndpoint was created.
1967
2265
  */
1968
2266
  CreatedAt?: string;
1969
2267
  /**
2268
+ * @public
1970
2269
  * A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
1971
2270
  */
1972
2271
  DashPackage?: DashPackage;
1973
2272
  /**
2273
+ * @public
1974
2274
  * A short text description of the OriginEndpoint.
1975
2275
  */
1976
2276
  Description?: string;
1977
2277
  /**
2278
+ * @public
1978
2279
  * An HTTP Live Streaming (HLS) packaging configuration.
1979
2280
  */
1980
2281
  HlsPackage?: HlsPackage;
1981
2282
  /**
2283
+ * @public
1982
2284
  * The ID of the OriginEndpoint.
1983
2285
  */
1984
2286
  Id?: string;
1985
2287
  /**
2288
+ * @public
1986
2289
  * A short string appended to the end of the OriginEndpoint URL.
1987
2290
  */
1988
2291
  ManifestName?: string;
1989
2292
  /**
2293
+ * @public
1990
2294
  * A Microsoft Smooth Streaming (MSS) packaging configuration.
1991
2295
  */
1992
2296
  MssPackage?: MssPackage;
1993
2297
  /**
2298
+ * @public
1994
2299
  * Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint
1995
2300
  * may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
1996
2301
  * requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
1997
2302
  */
1998
2303
  Origination?: Origination | string;
1999
2304
  /**
2305
+ * @public
2000
2306
  * Maximum duration (seconds) of content to retain for startover playback.
2001
2307
  * If not specified, startover playback will be disabled for the OriginEndpoint.
2002
2308
  */
2003
2309
  StartoverWindowSeconds?: number;
2004
2310
  /**
2311
+ * @public
2005
2312
  * A collection of tags associated with a resource
2006
2313
  */
2007
2314
  Tags?: Record<string, string>;
2008
2315
  /**
2316
+ * @public
2009
2317
  * Amount of delay (seconds) to enforce on the playback of live content.
2010
2318
  * If not specified, there will be no time delay in effect for the OriginEndpoint.
2011
2319
  */
2012
2320
  TimeDelaySeconds?: number;
2013
2321
  /**
2322
+ * @public
2014
2323
  * The URL of the packaged OriginEndpoint for consumption.
2015
2324
  */
2016
2325
  Url?: string;
2017
2326
  /**
2327
+ * @public
2018
2328
  * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
2019
2329
  */
2020
2330
  Whitelist?: string[];