@aws-sdk/client-mediapackagev2 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.
@@ -30,22 +30,27 @@ export type AdMarkerHls = (typeof AdMarkerHls)[keyof typeof AdMarkerHls];
30
30
  */
31
31
  export interface ChannelGroupListConfiguration {
32
32
  /**
33
+ * @public
33
34
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
34
35
  */
35
36
  ChannelGroupName: string | undefined;
36
37
  /**
38
+ * @public
37
39
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
38
40
  */
39
41
  Arn: string | undefined;
40
42
  /**
43
+ * @public
41
44
  * <p>The date and time the channel group was created.</p>
42
45
  */
43
46
  CreatedAt: Date | undefined;
44
47
  /**
48
+ * @public
45
49
  * <p>The date and time the channel group was modified.</p>
46
50
  */
47
51
  ModifiedAt: Date | undefined;
48
52
  /**
53
+ * @public
49
54
  * <p>Any descriptive information that you want to add to the channel group for future identification purposes.</p>
50
55
  */
51
56
  Description?: string;
@@ -73,6 +78,7 @@ export declare class ConflictException extends __BaseException {
73
78
  readonly $fault: "client";
74
79
  Message?: string;
75
80
  /**
81
+ * @public
76
82
  * <p>The type of ConflictException.</p>
77
83
  */
78
84
  ConflictExceptionType?: ConflictExceptionType | string;
@@ -86,10 +92,12 @@ export declare class ConflictException extends __BaseException {
86
92
  */
87
93
  export interface DeleteChannelPolicyRequest {
88
94
  /**
95
+ * @public
89
96
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
90
97
  */
91
98
  ChannelGroupName: string | undefined;
92
99
  /**
100
+ * @public
93
101
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
94
102
  */
95
103
  ChannelName: string | undefined;
@@ -178,6 +186,7 @@ export declare class ValidationException extends __BaseException {
178
186
  readonly $fault: "client";
179
187
  Message?: string;
180
188
  /**
189
+ * @public
181
190
  * <p>The type of ValidationException.</p>
182
191
  */
183
192
  ValidationExceptionType?: ValidationExceptionType | string;
@@ -191,10 +200,12 @@ export declare class ValidationException extends __BaseException {
191
200
  */
192
201
  export interface GetChannelPolicyRequest {
193
202
  /**
203
+ * @public
194
204
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
195
205
  */
196
206
  ChannelGroupName: string | undefined;
197
207
  /**
208
+ * @public
198
209
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
199
210
  */
200
211
  ChannelName: string | undefined;
@@ -204,14 +215,17 @@ export interface GetChannelPolicyRequest {
204
215
  */
205
216
  export interface GetChannelPolicyResponse {
206
217
  /**
218
+ * @public
207
219
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
208
220
  */
209
221
  ChannelGroupName: string | undefined;
210
222
  /**
223
+ * @public
211
224
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
212
225
  */
213
226
  ChannelName: string | undefined;
214
227
  /**
228
+ * @public
215
229
  * <p>The policy assigned to the channel.</p>
216
230
  */
217
231
  Policy: string | undefined;
@@ -238,6 +252,7 @@ export declare class ResourceNotFoundException extends __BaseException {
238
252
  readonly $fault: "client";
239
253
  Message?: string;
240
254
  /**
255
+ * @public
241
256
  * <p>The specified resource type wasn't found.</p>
242
257
  */
243
258
  ResourceTypeNotFound?: ResourceTypeNotFound | string;
@@ -251,14 +266,17 @@ export declare class ResourceNotFoundException extends __BaseException {
251
266
  */
252
267
  export interface PutChannelPolicyRequest {
253
268
  /**
269
+ * @public
254
270
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
255
271
  */
256
272
  ChannelGroupName: string | undefined;
257
273
  /**
274
+ * @public
258
275
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
259
276
  */
260
277
  ChannelName: string | undefined;
261
278
  /**
279
+ * @public
262
280
  * <p>The policy to attach to the specified channel.</p>
263
281
  */
264
282
  Policy: string | undefined;
@@ -273,22 +291,27 @@ export interface PutChannelPolicyResponse {
273
291
  */
274
292
  export interface CreateChannelRequest {
275
293
  /**
294
+ * @public
276
295
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
277
296
  */
278
297
  ChannelGroupName: string | undefined;
279
298
  /**
299
+ * @public
280
300
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.</p>
281
301
  */
282
302
  ChannelName: string | undefined;
283
303
  /**
304
+ * @public
284
305
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
285
306
  */
286
307
  ClientToken?: string;
287
308
  /**
309
+ * @public
288
310
  * <p>Enter any descriptive text that helps you to identify the channel.</p>
289
311
  */
290
312
  Description?: string;
291
313
  /**
314
+ * @public
292
315
  * <p>A comma-separated list of tag key:value pairs that you define. For example:</p>
293
316
  * <p>
294
317
  * <code>"Key1": "Value1",</code>
@@ -305,10 +328,12 @@ export interface CreateChannelRequest {
305
328
  */
306
329
  export interface IngestEndpoint {
307
330
  /**
331
+ * @public
308
332
  * <p>The system-generated unique identifier for the IngestEndpoint.</p>
309
333
  */
310
334
  Id?: string;
311
335
  /**
336
+ * @public
312
337
  * <p>The ingest domain URL where the source stream should be sent.</p>
313
338
  */
314
339
  Url?: string;
@@ -318,34 +343,42 @@ export interface IngestEndpoint {
318
343
  */
319
344
  export interface CreateChannelResponse {
320
345
  /**
346
+ * @public
321
347
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
322
348
  */
323
349
  Arn: string | undefined;
324
350
  /**
351
+ * @public
325
352
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
326
353
  */
327
354
  ChannelName: string | undefined;
328
355
  /**
356
+ * @public
329
357
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
330
358
  */
331
359
  ChannelGroupName: string | undefined;
332
360
  /**
361
+ * @public
333
362
  * <p>The date and time the channel was created.</p>
334
363
  */
335
364
  CreatedAt: Date | undefined;
336
365
  /**
366
+ * @public
337
367
  * <p>The date and time the channel was modified.</p>
338
368
  */
339
369
  ModifiedAt: Date | undefined;
340
370
  /**
371
+ * @public
341
372
  * <p>The description for your channel.</p>
342
373
  */
343
374
  Description?: string;
344
375
  /**
376
+ * @public
345
377
  * <p>The list of ingest endpoints.</p>
346
378
  */
347
379
  IngestEndpoints?: IngestEndpoint[];
348
380
  /**
381
+ * @public
349
382
  * <p>The comma-separated list of tag key:value pairs assigned to the channel.</p>
350
383
  */
351
384
  Tags?: Record<string, string>;
@@ -368,10 +401,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
368
401
  */
369
402
  export interface DeleteChannelRequest {
370
403
  /**
404
+ * @public
371
405
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
372
406
  */
373
407
  ChannelGroupName: string | undefined;
374
408
  /**
409
+ * @public
375
410
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
376
411
  */
377
412
  ChannelName: string | undefined;
@@ -386,10 +421,12 @@ export interface DeleteChannelResponse {
386
421
  */
387
422
  export interface GetChannelRequest {
388
423
  /**
424
+ * @public
389
425
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
390
426
  */
391
427
  ChannelGroupName: string | undefined;
392
428
  /**
429
+ * @public
393
430
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
394
431
  */
395
432
  ChannelName: string | undefined;
@@ -399,34 +436,42 @@ export interface GetChannelRequest {
399
436
  */
400
437
  export interface GetChannelResponse {
401
438
  /**
439
+ * @public
402
440
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
403
441
  */
404
442
  Arn: string | undefined;
405
443
  /**
444
+ * @public
406
445
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
407
446
  */
408
447
  ChannelName: string | undefined;
409
448
  /**
449
+ * @public
410
450
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
411
451
  */
412
452
  ChannelGroupName: string | undefined;
413
453
  /**
454
+ * @public
414
455
  * <p>The date and time the channel was created.</p>
415
456
  */
416
457
  CreatedAt: Date | undefined;
417
458
  /**
459
+ * @public
418
460
  * <p>The date and time the channel was modified.</p>
419
461
  */
420
462
  ModifiedAt: Date | undefined;
421
463
  /**
464
+ * @public
422
465
  * <p>The description for your channel.</p>
423
466
  */
424
467
  Description?: string;
425
468
  /**
469
+ * @public
426
470
  * <p>The list of ingest endpoints.</p>
427
471
  */
428
472
  IngestEndpoints?: IngestEndpoint[];
429
473
  /**
474
+ * @public
430
475
  * <p>The comma-separated list of tag key:value pairs assigned to the channel.</p>
431
476
  */
432
477
  Tags?: Record<string, string>;
@@ -436,14 +481,17 @@ export interface GetChannelResponse {
436
481
  */
437
482
  export interface ListChannelsRequest {
438
483
  /**
484
+ * @public
439
485
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
440
486
  */
441
487
  ChannelGroupName: string | undefined;
442
488
  /**
489
+ * @public
443
490
  * <p>The maximum number of results to return in the response.</p>
444
491
  */
445
492
  MaxResults?: number;
446
493
  /**
494
+ * @public
447
495
  * <p>The pagination token from the GET list request. Use the token to fetch the next page of results.</p>
448
496
  */
449
497
  NextToken?: string;
@@ -454,26 +502,32 @@ export interface ListChannelsRequest {
454
502
  */
455
503
  export interface ChannelListConfiguration {
456
504
  /**
505
+ * @public
457
506
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
458
507
  */
459
508
  Arn: string | undefined;
460
509
  /**
510
+ * @public
461
511
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
462
512
  */
463
513
  ChannelName: string | undefined;
464
514
  /**
515
+ * @public
465
516
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
466
517
  */
467
518
  ChannelGroupName: string | undefined;
468
519
  /**
520
+ * @public
469
521
  * <p>The date and time the channel was created.</p>
470
522
  */
471
523
  CreatedAt: Date | undefined;
472
524
  /**
525
+ * @public
473
526
  * <p>The date and time the channel was modified.</p>
474
527
  */
475
528
  ModifiedAt: Date | undefined;
476
529
  /**
530
+ * @public
477
531
  * <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
478
532
  */
479
533
  Description?: string;
@@ -483,10 +537,12 @@ export interface ChannelListConfiguration {
483
537
  */
484
538
  export interface ListChannelsResponse {
485
539
  /**
540
+ * @public
486
541
  * <p>The objects being returned.</p>
487
542
  */
488
543
  Items?: ChannelListConfiguration[];
489
544
  /**
545
+ * @public
490
546
  * <p>The pagination token from the GET list request.</p>
491
547
  */
492
548
  NextToken?: string;
@@ -509,6 +565,7 @@ export type ContainerType = (typeof ContainerType)[keyof typeof ContainerType];
509
565
  */
510
566
  export interface ScteHls {
511
567
  /**
568
+ * @public
512
569
  * <p>Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.</p>
513
570
  * <p>Value description: </p>
514
571
  * <ul>
@@ -525,22 +582,27 @@ export interface ScteHls {
525
582
  */
526
583
  export interface CreateHlsManifestConfiguration {
527
584
  /**
585
+ * @public
528
586
  * <p>A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
529
587
  */
530
588
  ManifestName: string | undefined;
531
589
  /**
590
+ * @public
532
591
  * <p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
533
592
  */
534
593
  ChildManifestName?: string;
535
594
  /**
595
+ * @public
536
596
  * <p>The SCTE configuration.</p>
537
597
  */
538
598
  ScteHls?: ScteHls;
539
599
  /**
600
+ * @public
540
601
  * <p>The total duration (in seconds) of the manifest's content.</p>
541
602
  */
542
603
  ManifestWindowSeconds?: number;
543
604
  /**
605
+ * @public
544
606
  * <p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,
545
607
  * EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.
546
608
  * The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
@@ -555,22 +617,27 @@ export interface CreateHlsManifestConfiguration {
555
617
  */
556
618
  export interface CreateLowLatencyHlsManifestConfiguration {
557
619
  /**
620
+ * @public
558
621
  * <p>A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
559
622
  */
560
623
  ManifestName: string | undefined;
561
624
  /**
625
+ * @public
562
626
  * <p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
563
627
  */
564
628
  ChildManifestName?: string;
565
629
  /**
630
+ * @public
566
631
  * <p>The SCTE configuration.</p>
567
632
  */
568
633
  ScteHls?: ScteHls;
569
634
  /**
635
+ * @public
570
636
  * <p>The total duration (in seconds) of the manifest's content.</p>
571
637
  */
572
638
  ManifestWindowSeconds?: number;
573
639
  /**
640
+ * @public
574
641
  * <p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,
575
642
  * EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.
576
643
  * The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
@@ -609,10 +676,12 @@ export type TsEncryptionMethod = (typeof TsEncryptionMethod)[keyof typeof TsEncr
609
676
  */
610
677
  export interface EncryptionMethod {
611
678
  /**
679
+ * @public
612
680
  * <p>The encryption method to use.</p>
613
681
  */
614
682
  TsEncryptionMethod?: TsEncryptionMethod | string;
615
683
  /**
684
+ * @public
616
685
  * <p>The encryption method to use.</p>
617
686
  */
618
687
  CmafEncryptionMethod?: CmafEncryptionMethod | string;
@@ -672,6 +741,7 @@ export type PresetSpeke20Video = (typeof PresetSpeke20Video)[keyof typeof Preset
672
741
  */
673
742
  export interface EncryptionContractConfiguration {
674
743
  /**
744
+ * @public
675
745
  * <p>A collection of audio encryption presets.</p>
676
746
  * <p>Value description: </p>
677
747
  * <ul>
@@ -702,6 +772,7 @@ export interface EncryptionContractConfiguration {
702
772
  */
703
773
  PresetSpeke20Audio: PresetSpeke20Audio | string | undefined;
704
774
  /**
775
+ * @public
705
776
  * <p>A collection of video encryption presets.</p>
706
777
  * <p>Value description: </p>
707
778
  * <ul>
@@ -762,26 +833,31 @@ export interface EncryptionContractConfiguration {
762
833
  */
763
834
  export interface SpekeKeyProvider {
764
835
  /**
836
+ * @public
765
837
  * <p>Configure one or more content encryption keys for your endpoints that use SPEKE Version 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.</p>
766
838
  */
767
839
  EncryptionContractConfiguration: EncryptionContractConfiguration | undefined;
768
840
  /**
841
+ * @public
769
842
  * <p>The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.</p>
770
843
  * <p>The following example shows a resource ID: <code>MovieNight20171126093045</code>
771
844
  * </p>
772
845
  */
773
846
  ResourceId: string | undefined;
774
847
  /**
848
+ * @public
775
849
  * <p>The DRM solution provider you're using to protect your content during distribution.</p>
776
850
  */
777
851
  DrmSystems: (DrmSystem | string)[] | undefined;
778
852
  /**
853
+ * @public
779
854
  * <p>The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.</p>
780
855
  * <p>Valid format: <code>arn:aws:iam::\{accountID\}:role/\{name\}</code>. The following example shows a role ARN: <code>arn:aws:iam::444455556666:role/SpekeAccess</code>
781
856
  * </p>
782
857
  */
783
858
  RoleArn: string | undefined;
784
859
  /**
860
+ * @public
785
861
  * <p>The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.</p>
786
862
  * <p>The following example shows a URL: <code>https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection</code>
787
863
  * </p>
@@ -794,20 +870,24 @@ export interface SpekeKeyProvider {
794
870
  */
795
871
  export interface Encryption {
796
872
  /**
873
+ * @public
797
874
  * <p>A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).</p>
798
875
  */
799
876
  ConstantInitializationVector?: string;
800
877
  /**
878
+ * @public
801
879
  * <p>The encryption method to use.</p>
802
880
  */
803
881
  EncryptionMethod: EncryptionMethod | undefined;
804
882
  /**
883
+ * @public
805
884
  * <p>The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.</p>
806
885
  * <p>The following example setting causes the service to rotate keys every thirty minutes: <code>1800</code>
807
886
  * </p>
808
887
  */
809
888
  KeyRotationIntervalSeconds?: number;
810
889
  /**
890
+ * @public
811
891
  * <p>The parameters for the SPEKE key provider.</p>
812
892
  */
813
893
  SpekeKeyProvider: SpekeKeyProvider | undefined;
@@ -837,6 +917,7 @@ export type ScteFilter = (typeof ScteFilter)[keyof typeof ScteFilter];
837
917
  */
838
918
  export interface Scte {
839
919
  /**
920
+ * @public
840
921
  * <p>The SCTE-35 message types that you want to be treated as ad markers in the output.</p>
841
922
  */
842
923
  ScteFilter?: (ScteFilter | string)[];
@@ -847,30 +928,37 @@ export interface Scte {
847
928
  */
848
929
  export interface Segment {
849
930
  /**
931
+ * @public
850
932
  * <p>The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.</p>
851
933
  */
852
934
  SegmentDurationSeconds?: number;
853
935
  /**
936
+ * @public
854
937
  * <p>The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.</p>
855
938
  */
856
939
  SegmentName?: string;
857
940
  /**
941
+ * @public
858
942
  * <p>When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.</p>
859
943
  */
860
944
  TsUseAudioRenditionGroup?: boolean;
861
945
  /**
946
+ * @public
862
947
  * <p>When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.</p>
863
948
  */
864
949
  IncludeIframeOnlyStreams?: boolean;
865
950
  /**
951
+ * @public
866
952
  * <p>By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.</p>
867
953
  */
868
954
  TsIncludeDvbSubtitles?: boolean;
869
955
  /**
956
+ * @public
870
957
  * <p>The SCTE configuration options in the segment settings.</p>
871
958
  */
872
959
  Scte?: Scte;
873
960
  /**
961
+ * @public
874
962
  * <p>The parameters for encrypting content.</p>
875
963
  */
876
964
  Encryption?: Encryption;
@@ -880,46 +968,57 @@ export interface Segment {
880
968
  */
881
969
  export interface CreateOriginEndpointRequest {
882
970
  /**
971
+ * @public
883
972
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
884
973
  */
885
974
  ChannelGroupName: string | undefined;
886
975
  /**
976
+ * @public
887
977
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
888
978
  */
889
979
  ChannelName: string | undefined;
890
980
  /**
981
+ * @public
891
982
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.</p>
892
983
  */
893
984
  OriginEndpointName: string | undefined;
894
985
  /**
986
+ * @public
895
987
  * <p>The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.</p>
896
988
  */
897
989
  ContainerType: ContainerType | string | undefined;
898
990
  /**
991
+ * @public
899
992
  * <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
900
993
  */
901
994
  Segment?: Segment;
902
995
  /**
996
+ * @public
903
997
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
904
998
  */
905
999
  ClientToken?: string;
906
1000
  /**
1001
+ * @public
907
1002
  * <p>Enter any descriptive text that helps you to identify the origin endpoint.</p>
908
1003
  */
909
1004
  Description?: string;
910
1005
  /**
1006
+ * @public
911
1007
  * <p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).</p>
912
1008
  */
913
1009
  StartoverWindowSeconds?: number;
914
1010
  /**
1011
+ * @public
915
1012
  * <p>An HTTP live streaming (HLS) manifest configuration.</p>
916
1013
  */
917
1014
  HlsManifests?: CreateHlsManifestConfiguration[];
918
1015
  /**
1016
+ * @public
919
1017
  * <p>A low-latency HLS manifest configuration.</p>
920
1018
  */
921
1019
  LowLatencyHlsManifests?: CreateLowLatencyHlsManifestConfiguration[];
922
1020
  /**
1021
+ * @public
923
1022
  * <p>A comma-separated list of tag key:value pairs that you define. For example:</p>
924
1023
  * <p>
925
1024
  * <code>"Key1": "Value1",</code>
@@ -936,22 +1035,27 @@ export interface CreateOriginEndpointRequest {
936
1035
  */
937
1036
  export interface GetHlsManifestConfiguration {
938
1037
  /**
1038
+ * @public
939
1039
  * <p>A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
940
1040
  */
941
1041
  ManifestName: string | undefined;
942
1042
  /**
1043
+ * @public
943
1044
  * <p>The egress domain URL for stream delivery from MediaPackage.</p>
944
1045
  */
945
1046
  Url: string | undefined;
946
1047
  /**
1048
+ * @public
947
1049
  * <p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
948
1050
  */
949
1051
  ChildManifestName?: string;
950
1052
  /**
1053
+ * @public
951
1054
  * <p>The total duration (in seconds) of the manifest's content.</p>
952
1055
  */
953
1056
  ManifestWindowSeconds?: number;
954
1057
  /**
1058
+ * @public
955
1059
  * <p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,
956
1060
  * EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.
957
1061
  * The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
@@ -960,6 +1064,7 @@ export interface GetHlsManifestConfiguration {
960
1064
  */
961
1065
  ProgramDateTimeIntervalSeconds?: number;
962
1066
  /**
1067
+ * @public
963
1068
  * <p>The SCTE configuration.</p>
964
1069
  */
965
1070
  ScteHls?: ScteHls;
@@ -970,22 +1075,27 @@ export interface GetHlsManifestConfiguration {
970
1075
  */
971
1076
  export interface GetLowLatencyHlsManifestConfiguration {
972
1077
  /**
1078
+ * @public
973
1079
  * <p>A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
974
1080
  */
975
1081
  ManifestName: string | undefined;
976
1082
  /**
1083
+ * @public
977
1084
  * <p>The egress domain URL for stream delivery from MediaPackage.</p>
978
1085
  */
979
1086
  Url: string | undefined;
980
1087
  /**
1088
+ * @public
981
1089
  * <p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
982
1090
  */
983
1091
  ChildManifestName?: string;
984
1092
  /**
1093
+ * @public
985
1094
  * <p>The total duration (in seconds) of the manifest's content.</p>
986
1095
  */
987
1096
  ManifestWindowSeconds?: number;
988
1097
  /**
1098
+ * @public
989
1099
  * <p>Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,
990
1100
  * EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.
991
1101
  * The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.
@@ -994,6 +1104,7 @@ export interface GetLowLatencyHlsManifestConfiguration {
994
1104
  */
995
1105
  ProgramDateTimeIntervalSeconds?: number;
996
1106
  /**
1107
+ * @public
997
1108
  * <p>The SCTE configuration.</p>
998
1109
  */
999
1110
  ScteHls?: ScteHls;
@@ -1003,54 +1114,67 @@ export interface GetLowLatencyHlsManifestConfiguration {
1003
1114
  */
1004
1115
  export interface CreateOriginEndpointResponse {
1005
1116
  /**
1117
+ * @public
1006
1118
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1007
1119
  */
1008
1120
  Arn: string | undefined;
1009
1121
  /**
1122
+ * @public
1010
1123
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1011
1124
  */
1012
1125
  ChannelGroupName: string | undefined;
1013
1126
  /**
1127
+ * @public
1014
1128
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
1015
1129
  */
1016
1130
  ChannelName: string | undefined;
1017
1131
  /**
1132
+ * @public
1018
1133
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.</p>
1019
1134
  */
1020
1135
  OriginEndpointName: string | undefined;
1021
1136
  /**
1137
+ * @public
1022
1138
  * <p>The type of container attached to this origin endpoint.</p>
1023
1139
  */
1024
1140
  ContainerType: ContainerType | string | undefined;
1025
1141
  /**
1142
+ * @public
1026
1143
  * <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
1027
1144
  */
1028
1145
  Segment: Segment | undefined;
1029
1146
  /**
1147
+ * @public
1030
1148
  * <p>The date and time the origin endpoint was created.</p>
1031
1149
  */
1032
1150
  CreatedAt: Date | undefined;
1033
1151
  /**
1152
+ * @public
1034
1153
  * <p>The date and time the origin endpoint was modified.</p>
1035
1154
  */
1036
1155
  ModifiedAt: Date | undefined;
1037
1156
  /**
1157
+ * @public
1038
1158
  * <p>The description for your origin endpoint.</p>
1039
1159
  */
1040
1160
  Description?: string;
1041
1161
  /**
1162
+ * @public
1042
1163
  * <p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.</p>
1043
1164
  */
1044
1165
  StartoverWindowSeconds?: number;
1045
1166
  /**
1167
+ * @public
1046
1168
  * <p>An HTTP live streaming (HLS) manifest configuration.</p>
1047
1169
  */
1048
1170
  HlsManifests?: GetHlsManifestConfiguration[];
1049
1171
  /**
1172
+ * @public
1050
1173
  * <p>A low-latency HLS manifest configuration.</p>
1051
1174
  */
1052
1175
  LowLatencyHlsManifests?: GetLowLatencyHlsManifestConfiguration[];
1053
1176
  /**
1177
+ * @public
1054
1178
  * <p>The comma-separated list of tag key:value pairs assigned to the origin endpoint.</p>
1055
1179
  */
1056
1180
  Tags?: Record<string, string>;
@@ -1060,14 +1184,17 @@ export interface CreateOriginEndpointResponse {
1060
1184
  */
1061
1185
  export interface DeleteOriginEndpointRequest {
1062
1186
  /**
1187
+ * @public
1063
1188
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1064
1189
  */
1065
1190
  ChannelGroupName: string | undefined;
1066
1191
  /**
1192
+ * @public
1067
1193
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1068
1194
  */
1069
1195
  ChannelName: string | undefined;
1070
1196
  /**
1197
+ * @public
1071
1198
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1072
1199
  */
1073
1200
  OriginEndpointName: string | undefined;
@@ -1082,14 +1209,17 @@ export interface DeleteOriginEndpointResponse {
1082
1209
  */
1083
1210
  export interface GetOriginEndpointRequest {
1084
1211
  /**
1212
+ * @public
1085
1213
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1086
1214
  */
1087
1215
  ChannelGroupName: string | undefined;
1088
1216
  /**
1217
+ * @public
1089
1218
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1090
1219
  */
1091
1220
  ChannelName: string | undefined;
1092
1221
  /**
1222
+ * @public
1093
1223
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1094
1224
  */
1095
1225
  OriginEndpointName: string | undefined;
@@ -1099,54 +1229,67 @@ export interface GetOriginEndpointRequest {
1099
1229
  */
1100
1230
  export interface GetOriginEndpointResponse {
1101
1231
  /**
1232
+ * @public
1102
1233
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1103
1234
  */
1104
1235
  Arn: string | undefined;
1105
1236
  /**
1237
+ * @public
1106
1238
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1107
1239
  */
1108
1240
  ChannelGroupName: string | undefined;
1109
1241
  /**
1242
+ * @public
1110
1243
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
1111
1244
  */
1112
1245
  ChannelName: string | undefined;
1113
1246
  /**
1247
+ * @public
1114
1248
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.</p>
1115
1249
  */
1116
1250
  OriginEndpointName: string | undefined;
1117
1251
  /**
1252
+ * @public
1118
1253
  * <p>The type of container attached to this origin endpoint.</p>
1119
1254
  */
1120
1255
  ContainerType: ContainerType | string | undefined;
1121
1256
  /**
1257
+ * @public
1122
1258
  * <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
1123
1259
  */
1124
1260
  Segment: Segment | undefined;
1125
1261
  /**
1262
+ * @public
1126
1263
  * <p>The date and time the origin endpoint was created.</p>
1127
1264
  */
1128
1265
  CreatedAt: Date | undefined;
1129
1266
  /**
1267
+ * @public
1130
1268
  * <p>The date and time the origin endpoint was modified.</p>
1131
1269
  */
1132
1270
  ModifiedAt: Date | undefined;
1133
1271
  /**
1272
+ * @public
1134
1273
  * <p>The description for your origin endpoint.</p>
1135
1274
  */
1136
1275
  Description?: string;
1137
1276
  /**
1277
+ * @public
1138
1278
  * <p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.</p>
1139
1279
  */
1140
1280
  StartoverWindowSeconds?: number;
1141
1281
  /**
1282
+ * @public
1142
1283
  * <p>An HTTP live streaming (HLS) manifest configuration.</p>
1143
1284
  */
1144
1285
  HlsManifests?: GetHlsManifestConfiguration[];
1145
1286
  /**
1287
+ * @public
1146
1288
  * <p>A low-latency HLS manifest configuration.</p>
1147
1289
  */
1148
1290
  LowLatencyHlsManifests?: GetLowLatencyHlsManifestConfiguration[];
1149
1291
  /**
1292
+ * @public
1150
1293
  * <p>The comma-separated list of tag key:value pairs assigned to the origin endpoint.</p>
1151
1294
  */
1152
1295
  Tags?: Record<string, string>;
@@ -1156,18 +1299,22 @@ export interface GetOriginEndpointResponse {
1156
1299
  */
1157
1300
  export interface ListOriginEndpointsRequest {
1158
1301
  /**
1302
+ * @public
1159
1303
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1160
1304
  */
1161
1305
  ChannelGroupName: string | undefined;
1162
1306
  /**
1307
+ * @public
1163
1308
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1164
1309
  */
1165
1310
  ChannelName: string | undefined;
1166
1311
  /**
1312
+ * @public
1167
1313
  * <p>The maximum number of results to return in the response.</p>
1168
1314
  */
1169
1315
  MaxResults?: number;
1170
1316
  /**
1317
+ * @public
1171
1318
  * <p>The pagination token from the GET list request. Use the token to fetch the next page of results.</p>
1172
1319
  */
1173
1320
  NextToken?: string;
@@ -1178,14 +1325,17 @@ export interface ListOriginEndpointsRequest {
1178
1325
  */
1179
1326
  export interface ListHlsManifestConfiguration {
1180
1327
  /**
1328
+ * @public
1181
1329
  * <p>A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
1182
1330
  */
1183
1331
  ManifestName: string | undefined;
1184
1332
  /**
1333
+ * @public
1185
1334
  * <p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
1186
1335
  */
1187
1336
  ChildManifestName?: string;
1188
1337
  /**
1338
+ * @public
1189
1339
  * <p>The egress domain URL for stream delivery from MediaPackage.</p>
1190
1340
  */
1191
1341
  Url?: string;
@@ -1196,14 +1346,17 @@ export interface ListHlsManifestConfiguration {
1196
1346
  */
1197
1347
  export interface ListLowLatencyHlsManifestConfiguration {
1198
1348
  /**
1349
+ * @public
1199
1350
  * <p>A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
1200
1351
  */
1201
1352
  ManifestName: string | undefined;
1202
1353
  /**
1354
+ * @public
1203
1355
  * <p>A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.</p>
1204
1356
  */
1205
1357
  ChildManifestName?: string;
1206
1358
  /**
1359
+ * @public
1207
1360
  * <p>The egress domain URL for stream delivery from MediaPackage.</p>
1208
1361
  */
1209
1362
  Url?: string;
@@ -1214,42 +1367,52 @@ export interface ListLowLatencyHlsManifestConfiguration {
1214
1367
  */
1215
1368
  export interface OriginEndpointListConfiguration {
1216
1369
  /**
1370
+ * @public
1217
1371
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1218
1372
  */
1219
1373
  Arn: string | undefined;
1220
1374
  /**
1375
+ * @public
1221
1376
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1222
1377
  */
1223
1378
  ChannelGroupName: string | undefined;
1224
1379
  /**
1380
+ * @public
1225
1381
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1226
1382
  */
1227
1383
  ChannelName: string | undefined;
1228
1384
  /**
1385
+ * @public
1229
1386
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1230
1387
  */
1231
1388
  OriginEndpointName: string | undefined;
1232
1389
  /**
1390
+ * @public
1233
1391
  * <p>The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. </p>
1234
1392
  */
1235
1393
  ContainerType: ContainerType | string | undefined;
1236
1394
  /**
1395
+ * @public
1237
1396
  * <p>Any descriptive information that you want to add to the origin endpoint for future identification purposes.</p>
1238
1397
  */
1239
1398
  Description?: string;
1240
1399
  /**
1400
+ * @public
1241
1401
  * <p>The date and time the origin endpoint was created.</p>
1242
1402
  */
1243
1403
  CreatedAt?: Date;
1244
1404
  /**
1405
+ * @public
1245
1406
  * <p>The date and time the origin endpoint was modified.</p>
1246
1407
  */
1247
1408
  ModifiedAt?: Date;
1248
1409
  /**
1410
+ * @public
1249
1411
  * <p>An HTTP live streaming (HLS) manifest configuration.</p>
1250
1412
  */
1251
1413
  HlsManifests?: ListHlsManifestConfiguration[];
1252
1414
  /**
1415
+ * @public
1253
1416
  * <p>A low-latency HLS manifest configuration.</p>
1254
1417
  */
1255
1418
  LowLatencyHlsManifests?: ListLowLatencyHlsManifestConfiguration[];
@@ -1259,10 +1422,12 @@ export interface OriginEndpointListConfiguration {
1259
1422
  */
1260
1423
  export interface ListOriginEndpointsResponse {
1261
1424
  /**
1425
+ * @public
1262
1426
  * <p>The objects being returned.</p>
1263
1427
  */
1264
1428
  Items?: OriginEndpointListConfiguration[];
1265
1429
  /**
1430
+ * @public
1266
1431
  * <p>The pagination token from the GET list request. Use the token to fetch the next page of results.</p>
1267
1432
  */
1268
1433
  NextToken?: string;
@@ -1272,14 +1437,17 @@ export interface ListOriginEndpointsResponse {
1272
1437
  */
1273
1438
  export interface DeleteOriginEndpointPolicyRequest {
1274
1439
  /**
1440
+ * @public
1275
1441
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1276
1442
  */
1277
1443
  ChannelGroupName: string | undefined;
1278
1444
  /**
1445
+ * @public
1279
1446
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1280
1447
  */
1281
1448
  ChannelName: string | undefined;
1282
1449
  /**
1450
+ * @public
1283
1451
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1284
1452
  */
1285
1453
  OriginEndpointName: string | undefined;
@@ -1294,14 +1462,17 @@ export interface DeleteOriginEndpointPolicyResponse {
1294
1462
  */
1295
1463
  export interface GetOriginEndpointPolicyRequest {
1296
1464
  /**
1465
+ * @public
1297
1466
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1298
1467
  */
1299
1468
  ChannelGroupName: string | undefined;
1300
1469
  /**
1470
+ * @public
1301
1471
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1302
1472
  */
1303
1473
  ChannelName: string | undefined;
1304
1474
  /**
1475
+ * @public
1305
1476
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1306
1477
  */
1307
1478
  OriginEndpointName: string | undefined;
@@ -1311,18 +1482,22 @@ export interface GetOriginEndpointPolicyRequest {
1311
1482
  */
1312
1483
  export interface GetOriginEndpointPolicyResponse {
1313
1484
  /**
1485
+ * @public
1314
1486
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1315
1487
  */
1316
1488
  ChannelGroupName: string | undefined;
1317
1489
  /**
1490
+ * @public
1318
1491
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
1319
1492
  */
1320
1493
  ChannelName: string | undefined;
1321
1494
  /**
1495
+ * @public
1322
1496
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.</p>
1323
1497
  */
1324
1498
  OriginEndpointName: string | undefined;
1325
1499
  /**
1500
+ * @public
1326
1501
  * <p>The policy assigned to the origin endpoint.</p>
1327
1502
  */
1328
1503
  Policy: string | undefined;
@@ -1332,18 +1507,22 @@ export interface GetOriginEndpointPolicyResponse {
1332
1507
  */
1333
1508
  export interface PutOriginEndpointPolicyRequest {
1334
1509
  /**
1510
+ * @public
1335
1511
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1336
1512
  */
1337
1513
  ChannelGroupName: string | undefined;
1338
1514
  /**
1515
+ * @public
1339
1516
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1340
1517
  */
1341
1518
  ChannelName: string | undefined;
1342
1519
  /**
1520
+ * @public
1343
1521
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1344
1522
  */
1345
1523
  OriginEndpointName: string | undefined;
1346
1524
  /**
1525
+ * @public
1347
1526
  * <p>The policy to attach to the specified origin endpoint.</p>
1348
1527
  */
1349
1528
  Policy: string | undefined;
@@ -1358,38 +1537,47 @@ export interface PutOriginEndpointPolicyResponse {
1358
1537
  */
1359
1538
  export interface UpdateOriginEndpointRequest {
1360
1539
  /**
1540
+ * @public
1361
1541
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1362
1542
  */
1363
1543
  ChannelGroupName: string | undefined;
1364
1544
  /**
1545
+ * @public
1365
1546
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1366
1547
  */
1367
1548
  ChannelName: string | undefined;
1368
1549
  /**
1550
+ * @public
1369
1551
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. </p>
1370
1552
  */
1371
1553
  OriginEndpointName: string | undefined;
1372
1554
  /**
1555
+ * @public
1373
1556
  * <p>The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. </p>
1374
1557
  */
1375
1558
  ContainerType: ContainerType | string | undefined;
1376
1559
  /**
1560
+ * @public
1377
1561
  * <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
1378
1562
  */
1379
1563
  Segment?: Segment;
1380
1564
  /**
1565
+ * @public
1381
1566
  * <p>Any descriptive information that you want to add to the origin endpoint for future identification purposes.</p>
1382
1567
  */
1383
1568
  Description?: string;
1384
1569
  /**
1570
+ * @public
1385
1571
  * <p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).</p>
1386
1572
  */
1387
1573
  StartoverWindowSeconds?: number;
1388
1574
  /**
1575
+ * @public
1389
1576
  * <p>An HTTP live streaming (HLS) manifest configuration.</p>
1390
1577
  */
1391
1578
  HlsManifests?: CreateHlsManifestConfiguration[];
1392
1579
  /**
1580
+ * @public
1393
1581
  * <p>A low-latency HLS manifest configuration.</p>
1394
1582
  */
1395
1583
  LowLatencyHlsManifests?: CreateLowLatencyHlsManifestConfiguration[];
@@ -1399,54 +1587,67 @@ export interface UpdateOriginEndpointRequest {
1399
1587
  */
1400
1588
  export interface UpdateOriginEndpointResponse {
1401
1589
  /**
1590
+ * @public
1402
1591
  * <p>The ARN associated with the resource.</p>
1403
1592
  */
1404
1593
  Arn: string | undefined;
1405
1594
  /**
1595
+ * @public
1406
1596
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1407
1597
  */
1408
1598
  ChannelGroupName: string | undefined;
1409
1599
  /**
1600
+ * @public
1410
1601
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
1411
1602
  */
1412
1603
  ChannelName: string | undefined;
1413
1604
  /**
1605
+ * @public
1414
1606
  * <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.</p>
1415
1607
  */
1416
1608
  OriginEndpointName: string | undefined;
1417
1609
  /**
1610
+ * @public
1418
1611
  * <p>The type of container attached to this origin endpoint.</p>
1419
1612
  */
1420
1613
  ContainerType: ContainerType | string | undefined;
1421
1614
  /**
1615
+ * @public
1422
1616
  * <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
1423
1617
  */
1424
1618
  Segment: Segment | undefined;
1425
1619
  /**
1620
+ * @public
1426
1621
  * <p>The date and time the origin endpoint was created.</p>
1427
1622
  */
1428
1623
  CreatedAt: Date | undefined;
1429
1624
  /**
1625
+ * @public
1430
1626
  * <p>The date and time the origin endpoint was modified.</p>
1431
1627
  */
1432
1628
  ModifiedAt: Date | undefined;
1433
1629
  /**
1630
+ * @public
1434
1631
  * <p>The description of the origin endpoint.</p>
1435
1632
  */
1436
1633
  Description?: string;
1437
1634
  /**
1635
+ * @public
1438
1636
  * <p>The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.</p>
1439
1637
  */
1440
1638
  StartoverWindowSeconds?: number;
1441
1639
  /**
1640
+ * @public
1442
1641
  * <p>An HTTP live streaming (HLS) manifest configuration.</p>
1443
1642
  */
1444
1643
  HlsManifests?: GetHlsManifestConfiguration[];
1445
1644
  /**
1645
+ * @public
1446
1646
  * <p>A low-latency HLS manifest configuration.</p>
1447
1647
  */
1448
1648
  LowLatencyHlsManifests?: GetLowLatencyHlsManifestConfiguration[];
1449
1649
  /**
1650
+ * @public
1450
1651
  * <p>The comma-separated list of tag key:value pairs assigned to the origin endpoint.</p>
1451
1652
  */
1452
1653
  Tags?: Record<string, string>;
@@ -1456,14 +1657,17 @@ export interface UpdateOriginEndpointResponse {
1456
1657
  */
1457
1658
  export interface UpdateChannelRequest {
1458
1659
  /**
1660
+ * @public
1459
1661
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1460
1662
  */
1461
1663
  ChannelGroupName: string | undefined;
1462
1664
  /**
1665
+ * @public
1463
1666
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. </p>
1464
1667
  */
1465
1668
  ChannelName: string | undefined;
1466
1669
  /**
1670
+ * @public
1467
1671
  * <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
1468
1672
  */
1469
1673
  Description?: string;
@@ -1473,34 +1677,42 @@ export interface UpdateChannelRequest {
1473
1677
  */
1474
1678
  export interface UpdateChannelResponse {
1475
1679
  /**
1680
+ * @public
1476
1681
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1477
1682
  */
1478
1683
  Arn: string | undefined;
1479
1684
  /**
1685
+ * @public
1480
1686
  * <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
1481
1687
  */
1482
1688
  ChannelName: string | undefined;
1483
1689
  /**
1690
+ * @public
1484
1691
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1485
1692
  */
1486
1693
  ChannelGroupName: string | undefined;
1487
1694
  /**
1695
+ * @public
1488
1696
  * <p>The date and time the channel was created.</p>
1489
1697
  */
1490
1698
  CreatedAt: Date | undefined;
1491
1699
  /**
1700
+ * @public
1492
1701
  * <p>The date and time the channel was modified.</p>
1493
1702
  */
1494
1703
  ModifiedAt: Date | undefined;
1495
1704
  /**
1705
+ * @public
1496
1706
  * <p>The description for your channel.</p>
1497
1707
  */
1498
1708
  Description?: string;
1499
1709
  /**
1710
+ * @public
1500
1711
  * <p>The list of ingest endpoints.</p>
1501
1712
  */
1502
1713
  IngestEndpoints?: IngestEndpoint[];
1503
1714
  /**
1715
+ * @public
1504
1716
  * <p>The comma-separated list of tag key:value pairs assigned to the channel.</p>
1505
1717
  */
1506
1718
  Tags?: Record<string, string>;
@@ -1510,18 +1722,22 @@ export interface UpdateChannelResponse {
1510
1722
  */
1511
1723
  export interface CreateChannelGroupRequest {
1512
1724
  /**
1725
+ * @public
1513
1726
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can't use spaces in the name. You can't change the name after you create the channel group.</p>
1514
1727
  */
1515
1728
  ChannelGroupName: string | undefined;
1516
1729
  /**
1730
+ * @public
1517
1731
  * <p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>
1518
1732
  */
1519
1733
  ClientToken?: string;
1520
1734
  /**
1735
+ * @public
1521
1736
  * <p>Enter any descriptive text that helps you to identify the channel group.</p>
1522
1737
  */
1523
1738
  Description?: string;
1524
1739
  /**
1740
+ * @public
1525
1741
  * <p>A comma-separated list of tag key:value pairs that you define. For example:</p>
1526
1742
  * <p>
1527
1743
  * <code>"Key1": "Value1",</code>
@@ -1537,30 +1753,37 @@ export interface CreateChannelGroupRequest {
1537
1753
  */
1538
1754
  export interface CreateChannelGroupResponse {
1539
1755
  /**
1756
+ * @public
1540
1757
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1541
1758
  */
1542
1759
  ChannelGroupName: string | undefined;
1543
1760
  /**
1761
+ * @public
1544
1762
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1545
1763
  */
1546
1764
  Arn: string | undefined;
1547
1765
  /**
1766
+ * @public
1548
1767
  * <p>The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.</p>
1549
1768
  */
1550
1769
  EgressDomain: string | undefined;
1551
1770
  /**
1771
+ * @public
1552
1772
  * <p>The date and time the channel group was created.</p>
1553
1773
  */
1554
1774
  CreatedAt: Date | undefined;
1555
1775
  /**
1776
+ * @public
1556
1777
  * <p>The date and time the channel group was modified.</p>
1557
1778
  */
1558
1779
  ModifiedAt: Date | undefined;
1559
1780
  /**
1781
+ * @public
1560
1782
  * <p>The description for your channel group.</p>
1561
1783
  */
1562
1784
  Description?: string;
1563
1785
  /**
1786
+ * @public
1564
1787
  * <p>The comma-separated list of tag key:value pairs assigned to the channel group.</p>
1565
1788
  */
1566
1789
  Tags?: Record<string, string>;
@@ -1570,6 +1793,7 @@ export interface CreateChannelGroupResponse {
1570
1793
  */
1571
1794
  export interface DeleteChannelGroupRequest {
1572
1795
  /**
1796
+ * @public
1573
1797
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1574
1798
  */
1575
1799
  ChannelGroupName: string | undefined;
@@ -1584,6 +1808,7 @@ export interface DeleteChannelGroupResponse {
1584
1808
  */
1585
1809
  export interface GetChannelGroupRequest {
1586
1810
  /**
1811
+ * @public
1587
1812
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1588
1813
  */
1589
1814
  ChannelGroupName: string | undefined;
@@ -1593,30 +1818,37 @@ export interface GetChannelGroupRequest {
1593
1818
  */
1594
1819
  export interface GetChannelGroupResponse {
1595
1820
  /**
1821
+ * @public
1596
1822
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1597
1823
  */
1598
1824
  ChannelGroupName: string | undefined;
1599
1825
  /**
1826
+ * @public
1600
1827
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1601
1828
  */
1602
1829
  Arn: string | undefined;
1603
1830
  /**
1831
+ * @public
1604
1832
  * <p>The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.</p>
1605
1833
  */
1606
1834
  EgressDomain: string | undefined;
1607
1835
  /**
1836
+ * @public
1608
1837
  * <p>The date and time the channel group was created.</p>
1609
1838
  */
1610
1839
  CreatedAt: Date | undefined;
1611
1840
  /**
1841
+ * @public
1612
1842
  * <p>The date and time the channel group was modified.</p>
1613
1843
  */
1614
1844
  ModifiedAt: Date | undefined;
1615
1845
  /**
1846
+ * @public
1616
1847
  * <p>The description for your channel group.</p>
1617
1848
  */
1618
1849
  Description?: string;
1619
1850
  /**
1851
+ * @public
1620
1852
  * <p>The comma-separated list of tag key:value pairs assigned to the channel group.</p>
1621
1853
  */
1622
1854
  Tags?: Record<string, string>;
@@ -1626,10 +1858,12 @@ export interface GetChannelGroupResponse {
1626
1858
  */
1627
1859
  export interface ListChannelGroupsRequest {
1628
1860
  /**
1861
+ * @public
1629
1862
  * <p>The maximum number of results to return in the response.</p>
1630
1863
  */
1631
1864
  MaxResults?: number;
1632
1865
  /**
1866
+ * @public
1633
1867
  * <p>The pagination token from the GET list request. Use the token to fetch the next page of results.</p>
1634
1868
  */
1635
1869
  NextToken?: string;
@@ -1639,10 +1873,12 @@ export interface ListChannelGroupsRequest {
1639
1873
  */
1640
1874
  export interface ListChannelGroupsResponse {
1641
1875
  /**
1876
+ * @public
1642
1877
  * <p>The objects being returned.</p>
1643
1878
  */
1644
1879
  Items?: ChannelGroupListConfiguration[];
1645
1880
  /**
1881
+ * @public
1646
1882
  * <p>The pagination token from the GET list request. Use the token to fetch the next page of results.</p>
1647
1883
  */
1648
1884
  NextToken?: string;
@@ -1652,10 +1888,12 @@ export interface ListChannelGroupsResponse {
1652
1888
  */
1653
1889
  export interface UpdateChannelGroupRequest {
1654
1890
  /**
1891
+ * @public
1655
1892
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1656
1893
  */
1657
1894
  ChannelGroupName: string | undefined;
1658
1895
  /**
1896
+ * @public
1659
1897
  * <p>Any descriptive information that you want to add to the channel group for future identification purposes.</p>
1660
1898
  */
1661
1899
  Description?: string;
@@ -1665,30 +1903,37 @@ export interface UpdateChannelGroupRequest {
1665
1903
  */
1666
1904
  export interface UpdateChannelGroupResponse {
1667
1905
  /**
1906
+ * @public
1668
1907
  * <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
1669
1908
  */
1670
1909
  ChannelGroupName: string | undefined;
1671
1910
  /**
1911
+ * @public
1672
1912
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
1673
1913
  */
1674
1914
  Arn: string | undefined;
1675
1915
  /**
1916
+ * @public
1676
1917
  * <p>The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.</p>
1677
1918
  */
1678
1919
  EgressDomain: string | undefined;
1679
1920
  /**
1921
+ * @public
1680
1922
  * <p>The date and time the channel group was created.</p>
1681
1923
  */
1682
1924
  CreatedAt: Date | undefined;
1683
1925
  /**
1926
+ * @public
1684
1927
  * <p>The date and time the channel group was modified.</p>
1685
1928
  */
1686
1929
  ModifiedAt: Date | undefined;
1687
1930
  /**
1931
+ * @public
1688
1932
  * <p>The description for your channel group.</p>
1689
1933
  */
1690
1934
  Description?: string;
1691
1935
  /**
1936
+ * @public
1692
1937
  * <p>The comma-separated list of tag key:value pairs assigned to the channel group.</p>
1693
1938
  */
1694
1939
  Tags?: Record<string, string>;
@@ -1698,6 +1943,7 @@ export interface UpdateChannelGroupResponse {
1698
1943
  */
1699
1944
  export interface ListTagsForResourceRequest {
1700
1945
  /**
1946
+ * @public
1701
1947
  * <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
1702
1948
  */
1703
1949
  ResourceArn: string | undefined;
@@ -1707,6 +1953,7 @@ export interface ListTagsForResourceRequest {
1707
1953
  */
1708
1954
  export interface ListTagsForResourceResponse {
1709
1955
  /**
1956
+ * @public
1710
1957
  * <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>
1711
1958
  */
1712
1959
  Tags?: Record<string, string>;
@@ -1716,10 +1963,12 @@ export interface ListTagsForResourceResponse {
1716
1963
  */
1717
1964
  export interface TagResourceRequest {
1718
1965
  /**
1966
+ * @public
1719
1967
  * <p>The ARN of the MediaPackage resource that you're adding tags to.</p>
1720
1968
  */
1721
1969
  ResourceArn: string | undefined;
1722
1970
  /**
1971
+ * @public
1723
1972
  * <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>
1724
1973
  */
1725
1974
  Tags: Record<string, string> | undefined;
@@ -1729,10 +1978,12 @@ export interface TagResourceRequest {
1729
1978
  */
1730
1979
  export interface UntagResourceRequest {
1731
1980
  /**
1981
+ * @public
1732
1982
  * <p>The ARN of the MediaPackage resource that you're removing tags from.</p>
1733
1983
  */
1734
1984
  ResourceArn: string | undefined;
1735
1985
  /**
1986
+ * @public
1736
1987
  * <p>The list of tag keys to remove from the resource.</p>
1737
1988
  */
1738
1989
  TagKeys: string[] | undefined;