@aws-sdk/client-mediatailor 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.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +497 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -6,10 +6,12 @@ import { MediaTailorServiceException as __BaseException } from "./MediaTailorSer
6
6
  */
7
7
  export interface KeyValuePair {
8
8
  /**
9
+ * @public
9
10
  * <p>For <code>SCTE35_ENHANCED</code> output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the <code>EXT-X-ASSET</code>tag. If you specify a key, you must also specify a corresponding value.</p>
10
11
  */
11
12
  Key: string | undefined;
12
13
  /**
14
+ * @public
13
15
  * <p>For <code>SCTE35_ENHANCED</code> output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the <code>EXT-X-ASSET</code>tag. If you specify a value, you must also specify a corresponding key.</p>
14
16
  */
15
17
  Value: string | undefined;
@@ -32,10 +34,12 @@ export type MessageType = (typeof MessageType)[keyof typeof MessageType];
32
34
  */
33
35
  export interface SlateSource {
34
36
  /**
37
+ * @public
35
38
  * <p>The name of the source location where the slate VOD source is stored.</p>
36
39
  */
37
40
  SourceLocationName?: string;
38
41
  /**
42
+ * @public
39
43
  * <p>The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.</p>
40
44
  */
41
45
  VodSourceName?: string;
@@ -46,18 +50,22 @@ export interface SlateSource {
46
50
  */
47
51
  export interface SpliceInsertMessage {
48
52
  /**
53
+ * @public
49
54
  * <p>This is written to <code>splice_insert.avail_num</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>0</code>. Values must be between <code>0</code> and <code>256</code>, inclusive.</p>
50
55
  */
51
56
  AvailNum?: number;
52
57
  /**
58
+ * @public
53
59
  * <p>This is written to <code>splice_insert.avails_expected</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>0</code>. Values must be between <code>0</code> and <code>256</code>, inclusive.</p>
54
60
  */
55
61
  AvailsExpected?: number;
56
62
  /**
63
+ * @public
57
64
  * <p>This is written to <code>splice_insert.splice_event_id</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>1</code>.</p>
58
65
  */
59
66
  SpliceEventId?: number;
60
67
  /**
68
+ * @public
61
69
  * <p>This is written to <code>splice_insert.unique_program_id</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>0</code>. Values must be between <code>0</code> and <code>256</code>, inclusive.</p>
62
70
  */
63
71
  UniqueProgramId?: number;
@@ -71,34 +79,42 @@ export interface SpliceInsertMessage {
71
79
  */
72
80
  export interface SegmentationDescriptor {
73
81
  /**
82
+ * @public
74
83
  * <p>The Event Identifier to assign to the <code>segmentation_descriptor.segmentation_event_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.</p>
75
84
  */
76
85
  SegmentationEventId?: number;
77
86
  /**
87
+ * @public
78
88
  * <p>The Upid Type to assign to the <code>segmentation_descriptor.segmentation_upid_type</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.</p>
79
89
  */
80
90
  SegmentationUpidType?: number;
81
91
  /**
92
+ * @public
82
93
  * <p>The Upid to assign to the <code>segmentation_descriptor.segmentation_upid</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).</p>
83
94
  */
84
95
  SegmentationUpid?: string;
85
96
  /**
97
+ * @public
86
98
  * <p>The Type Identifier to assign to the <code>segmentation_descriptor.segmentation_type_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.</p>
87
99
  */
88
100
  SegmentationTypeId?: number;
89
101
  /**
102
+ * @public
90
103
  * <p>The segment number to assign to the <code>segmentation_descriptor.segment_num</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.</p>
91
104
  */
92
105
  SegmentNum?: number;
93
106
  /**
107
+ * @public
94
108
  * <p>The number of segments expected, which is assigned to the <code>segmentation_descriptor.segments_expectedS</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.</p>
95
109
  */
96
110
  SegmentsExpected?: number;
97
111
  /**
112
+ * @public
98
113
  * <p>The sub-segment number to assign to the <code>segmentation_descriptor.sub_segment_num</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.</p>
99
114
  */
100
115
  SubSegmentNum?: number;
101
116
  /**
117
+ * @public
102
118
  * <p>The number of sub-segments expected, which is assigned to the <code>segmentation_descriptor.sub_segments_expected</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.</p>
103
119
  */
104
120
  SubSegmentsExpected?: number;
@@ -111,6 +127,7 @@ export interface SegmentationDescriptor {
111
127
  */
112
128
  export interface TimeSignalMessage {
113
129
  /**
130
+ * @public
114
131
  * <p>The configurations for the SCTE-35 <code>segmentation_descriptor</code> message(s) sent with the <code>time_signal</code> message.</p>
115
132
  */
116
133
  SegmentationDescriptors?: SegmentationDescriptor[];
@@ -121,28 +138,34 @@ export interface TimeSignalMessage {
121
138
  */
122
139
  export interface AdBreak {
123
140
  /**
141
+ * @public
124
142
  * <p>The SCTE-35 ad insertion type. Accepted value: <code>SPLICE_INSERT</code>, <code>TIME_SIGNAL</code>.</p>
125
143
  */
126
144
  MessageType?: MessageType | string;
127
145
  /**
146
+ * @public
128
147
  * <p>How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.</p>
129
148
  */
130
149
  OffsetMillis?: number;
131
150
  /**
151
+ * @public
132
152
  * <p>Ad break slate configuration.</p>
133
153
  */
134
154
  Slate?: SlateSource;
135
155
  /**
156
+ * @public
136
157
  * <p>This defines the SCTE-35 <code>splice_insert()</code> message inserted around the ad. For information about using <code>splice_insert()</code>, see the SCTE-35 specficiaiton, section 9.7.3.1.</p>
137
158
  */
138
159
  SpliceInsertMessage?: SpliceInsertMessage;
139
160
  /**
161
+ * @public
140
162
  * <p>Defines the SCTE-35 <code>time_signal</code> message inserted around the ad.</p>
141
163
  * <p>Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a <code>splice_insert</code> SCTE-35 message to the ad break. This message provides basic metadata about the ad break.</p>
142
164
  * <p>See section 9.7.4 of the 2022 SCTE-35 specification for more information.</p>
143
165
  */
144
166
  TimeSignalMessage?: TimeSignalMessage;
145
167
  /**
168
+ * @public
146
169
  * <p>Defines a list of key/value pairs that MediaTailor generates within the <code>EXT-X-ASSET</code>tag for <code>SCTE35_ENHANCED</code> output.</p>
147
170
  */
148
171
  AdBreakMetadata?: KeyValuePair[];
@@ -166,26 +189,32 @@ export type AlertCategory = (typeof AlertCategory)[keyof typeof AlertCategory];
166
189
  */
167
190
  export interface Alert {
168
191
  /**
192
+ * @public
169
193
  * <p>The code for the alert. For example, <code>NOT_PROCESSED</code>.</p>
170
194
  */
171
195
  AlertCode: string | undefined;
172
196
  /**
197
+ * @public
173
198
  * <p>If an alert is generated for a resource, an explanation of the reason for the alert.</p>
174
199
  */
175
200
  AlertMessage: string | undefined;
176
201
  /**
202
+ * @public
177
203
  * <p>The timestamp when the alert was last modified.</p>
178
204
  */
179
205
  LastModifiedTime: Date | undefined;
180
206
  /**
207
+ * @public
181
208
  * <p>The Amazon Resource Names (ARNs) related to this alert.</p>
182
209
  */
183
210
  RelatedResourceArns: string[] | undefined;
184
211
  /**
212
+ * @public
185
213
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
186
214
  */
187
215
  ResourceArn: string | undefined;
188
216
  /**
217
+ * @public
189
218
  * <p>The category that MediaTailor assigns to the alert.</p>
190
219
  */
191
220
  Category?: AlertCategory | string;
@@ -209,11 +238,13 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
209
238
  */
210
239
  export interface AvailMatchingCriteria {
211
240
  /**
241
+ * @public
212
242
  * <p>The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">Using dynamic ad variables</a> in the <i>MediaTailor User Guide</i>.</p>
213
243
  * <p>You can include up to 100 dynamic variables.</p>
214
244
  */
215
245
  DynamicVariable: string | undefined;
216
246
  /**
247
+ * @public
217
248
  * <p>For the <code>DynamicVariable</code> specified in <code>AvailMatchingCriteria</code>, the Operator that is used for the comparison.</p>
218
249
  */
219
250
  Operator: Operator | string | undefined;
@@ -235,6 +266,7 @@ export type LogType = (typeof LogType)[keyof typeof LogType];
235
266
  */
236
267
  export interface LogConfigurationForChannel {
237
268
  /**
269
+ * @public
238
270
  * <p>The log types.</p>
239
271
  */
240
272
  LogTypes?: (LogType | string)[];
@@ -245,18 +277,22 @@ export interface LogConfigurationForChannel {
245
277
  */
246
278
  export interface DashPlaylistSettings {
247
279
  /**
280
+ * @public
248
281
  * <p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
249
282
  */
250
283
  ManifestWindowSeconds?: number;
251
284
  /**
285
+ * @public
252
286
  * <p>Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
253
287
  */
254
288
  MinBufferTimeSeconds?: number;
255
289
  /**
290
+ * @public
256
291
  * <p>Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
257
292
  */
258
293
  MinUpdatePeriodSeconds?: number;
259
294
  /**
295
+ * @public
260
296
  * <p>Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
261
297
  */
262
298
  SuggestedPresentationDelaySeconds?: number;
@@ -279,10 +315,12 @@ export type AdMarkupType = (typeof AdMarkupType)[keyof typeof AdMarkupType];
279
315
  */
280
316
  export interface HlsPlaylistSettings {
281
317
  /**
318
+ * @public
282
319
  * <p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
283
320
  */
284
321
  ManifestWindowSeconds?: number;
285
322
  /**
323
+ * @public
286
324
  * <p>Determines the type of SCTE 35 tags to use in ad markup. Specify <code>DATERANGE</code> to use <code>DATERANGE</code> tags (for live or VOD content). Specify <code>SCTE35_ENHANCED</code> to use <code>EXT-X-CUE-OUT</code> and <code>EXT-X-CUE-IN</code> tags (for VOD content only).</p>
287
325
  */
288
326
  AdMarkupType?: (AdMarkupType | string)[];
@@ -293,22 +331,27 @@ export interface HlsPlaylistSettings {
293
331
  */
294
332
  export interface ResponseOutputItem {
295
333
  /**
334
+ * @public
296
335
  * <p>DASH manifest configuration settings.</p>
297
336
  */
298
337
  DashPlaylistSettings?: DashPlaylistSettings;
299
338
  /**
339
+ * @public
300
340
  * <p>HLS manifest configuration settings.</p>
301
341
  */
302
342
  HlsPlaylistSettings?: HlsPlaylistSettings;
303
343
  /**
344
+ * @public
304
345
  * <p>The name of the manifest for the channel that will appear in the channel output's playback URL.</p>
305
346
  */
306
347
  ManifestName: string | undefined;
307
348
  /**
349
+ * @public
308
350
  * <p>The URL used for playback by content players.</p>
309
351
  */
310
352
  PlaybackUrl: string | undefined;
311
353
  /**
354
+ * @public
312
355
  * <p>A string used to associate a package configuration source group with a channel output.</p>
313
356
  */
314
357
  SourceGroup: string | undefined;
@@ -319,36 +362,44 @@ export interface ResponseOutputItem {
319
362
  */
320
363
  export interface Channel {
321
364
  /**
365
+ * @public
322
366
  * <p>The ARN of the channel.</p>
323
367
  */
324
368
  Arn: string | undefined;
325
369
  /**
370
+ * @public
326
371
  * <p>The name of the channel.</p>
327
372
  */
328
373
  ChannelName: string | undefined;
329
374
  /**
375
+ * @public
330
376
  * <p>Returns the state whether the channel is running or not.</p>
331
377
  */
332
378
  ChannelState: string | undefined;
333
379
  /**
380
+ * @public
334
381
  * <p>The timestamp of when the channel was created.</p>
335
382
  */
336
383
  CreationTime?: Date;
337
384
  /**
385
+ * @public
338
386
  * <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
339
387
  * <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
340
388
  * <code>PlaybackMode</code>.</p>
341
389
  */
342
390
  FillerSlate?: SlateSource;
343
391
  /**
392
+ * @public
344
393
  * <p>The timestamp of when the channel was last modified.</p>
345
394
  */
346
395
  LastModifiedTime?: Date;
347
396
  /**
397
+ * @public
348
398
  * <p>The channel's output properties.</p>
349
399
  */
350
400
  Outputs: ResponseOutputItem[] | undefined;
351
401
  /**
402
+ * @public
352
403
  * <p>The type of playback mode for this channel.</p>
353
404
  * <p>
354
405
  * <code>LINEAR</code> - Programs play back-to-back only once.</p>
@@ -357,14 +408,17 @@ export interface Channel {
357
408
  */
358
409
  PlaybackMode: string | undefined;
359
410
  /**
411
+ * @public
360
412
  * <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
361
413
  */
362
414
  Tags?: Record<string, string>;
363
415
  /**
416
+ * @public
364
417
  * <p>The tier for this channel. STANDARD tier channels can contain live programs.</p>
365
418
  */
366
419
  Tier: string | undefined;
367
420
  /**
421
+ * @public
368
422
  * <p>The log configuration.</p>
369
423
  */
370
424
  LogConfiguration: LogConfigurationForChannel | undefined;
@@ -387,14 +441,17 @@ export type Type = (typeof Type)[keyof typeof Type];
387
441
  */
388
442
  export interface HttpPackageConfiguration {
389
443
  /**
444
+ * @public
390
445
  * <p>The relative path to the URL for this VOD source. This is combined with <code>SourceLocation::HttpConfiguration::BaseUrl</code> to form a valid URL.</p>
391
446
  */
392
447
  Path: string | undefined;
393
448
  /**
449
+ * @public
394
450
  * <p>The name of the source group. This has to match one of the <code>Channel::Outputs::SourceGroup</code>.</p>
395
451
  */
396
452
  SourceGroup: string | undefined;
397
453
  /**
454
+ * @public
398
455
  * <p>The streaming protocol for this package configuration. Supported values are <code>HLS</code> and <code>DASH</code>.</p>
399
456
  */
400
457
  Type: Type | string | undefined;
@@ -405,30 +462,37 @@ export interface HttpPackageConfiguration {
405
462
  */
406
463
  export interface LiveSource {
407
464
  /**
465
+ * @public
408
466
  * <p>The ARN for the live source.</p>
409
467
  */
410
468
  Arn: string | undefined;
411
469
  /**
470
+ * @public
412
471
  * <p>The timestamp that indicates when the live source was created.</p>
413
472
  */
414
473
  CreationTime?: Date;
415
474
  /**
475
+ * @public
416
476
  * <p>The HTTP package configurations for the live source.</p>
417
477
  */
418
478
  HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
419
479
  /**
480
+ * @public
420
481
  * <p>The timestamp that indicates when the live source was last modified.</p>
421
482
  */
422
483
  LastModifiedTime?: Date;
423
484
  /**
485
+ * @public
424
486
  * <p>The name that's used to refer to a live source.</p>
425
487
  */
426
488
  LiveSourceName: string | undefined;
427
489
  /**
490
+ * @public
428
491
  * <p>The name of the source location.</p>
429
492
  */
430
493
  SourceLocationName: string | undefined;
431
494
  /**
495
+ * @public
432
496
  * <p>The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
433
497
  */
434
498
  Tags?: Record<string, string>;
@@ -464,14 +528,17 @@ export type Mode = (typeof Mode)[keyof typeof Mode];
464
528
  */
465
529
  export interface AvailSuppression {
466
530
  /**
531
+ * @public
467
532
  * <p>Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to <code>BEHIND_LIVE_EDGE</code>, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to <code>AFTER_LIVE_EDGE</code>, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.</p>
468
533
  */
469
534
  Mode?: Mode | string;
470
535
  /**
536
+ * @public
471
537
  * <p>A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.</p>
472
538
  */
473
539
  Value?: string;
474
540
  /**
541
+ * @public
475
542
  * <p>Defines the policy to apply to the avail suppression mode. <code>BEHIND_LIVE_EDGE</code> will always use the full avail suppression policy. <code>AFTER_LIVE_EDGE</code> mode can be used to invoke partial ad break fills when a session starts mid-break.</p>
476
543
  */
477
544
  FillPolicy?: FillPolicy | string;
@@ -482,10 +549,12 @@ export interface AvailSuppression {
482
549
  */
483
550
  export interface Bumper {
484
551
  /**
552
+ * @public
485
553
  * <p>The URL for the end bumper asset.</p>
486
554
  */
487
555
  EndUrl?: string;
488
556
  /**
557
+ * @public
489
558
  * <p>The URL for the start bumper asset.</p>
490
559
  */
491
560
  StartUrl?: string;
@@ -496,10 +565,12 @@ export interface Bumper {
496
565
  */
497
566
  export interface CdnConfiguration {
498
567
  /**
568
+ * @public
499
569
  * <p>A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<i>&lt;region&gt;</i>.amazonaws.com. Then specify the rule's name in this <code>AdSegmentUrlPrefix</code>. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.</p>
500
570
  */
501
571
  AdSegmentUrlPrefix?: string;
502
572
  /**
573
+ * @public
503
574
  * <p>A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this <code>ContentSegmentUrlPrefix</code>. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.</p>
504
575
  */
505
576
  ContentSegmentUrlPrefix?: string;
@@ -522,14 +593,17 @@ export type OriginManifestType = (typeof OriginManifestType)[keyof typeof Origin
522
593
  */
523
594
  export interface DashConfiguration {
524
595
  /**
596
+ * @public
525
597
  * <p>The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.</p>
526
598
  */
527
599
  ManifestEndpointPrefix?: string;
528
600
  /**
601
+ * @public
529
602
  * <p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are <code>DISABLED</code> and <code>EMT_DEFAULT</code>. The <code>EMT_DEFAULT</code> setting enables the inclusion of the tag and is the default value.</p>
530
603
  */
531
604
  MpdLocation?: string;
532
605
  /**
606
+ * @public
533
607
  * <p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to <code>SINGLE_PERIOD</code>. The default setting is <code>MULTI_PERIOD</code>. For multi-period manifests, omit this setting or set it to <code>MULTI_PERIOD</code>.</p>
534
608
  */
535
609
  OriginManifestType?: OriginManifestType | string;
@@ -540,6 +614,7 @@ export interface DashConfiguration {
540
614
  */
541
615
  export interface HlsConfiguration {
542
616
  /**
617
+ * @public
543
618
  * <p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>
544
619
  */
545
620
  ManifestEndpointPrefix?: string;
@@ -550,10 +625,12 @@ export interface HlsConfiguration {
550
625
  */
551
626
  export interface LivePreRollConfiguration {
552
627
  /**
628
+ * @public
553
629
  * <p>The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
554
630
  */
555
631
  AdDecisionServerUrl?: string;
556
632
  /**
633
+ * @public
557
634
  * <p>The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.</p>
558
635
  */
559
636
  MaxDurationSeconds?: number;
@@ -564,6 +641,7 @@ export interface LivePreRollConfiguration {
564
641
  */
565
642
  export interface LogConfiguration {
566
643
  /**
644
+ * @public
567
645
  * <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and <code>percentEnabled</code> is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p>
568
646
  * <p>Valid values: <code>0</code> - <code>100</code>
569
647
  * </p>
@@ -577,6 +655,7 @@ export interface LogConfiguration {
577
655
  */
578
656
  export interface AdMarkerPassthrough {
579
657
  /**
658
+ * @public
580
659
  * <p>Enables ad marker passthrough for your configuration.</p>
581
660
  */
582
661
  Enabled?: boolean;
@@ -587,6 +666,7 @@ export interface AdMarkerPassthrough {
587
666
  */
588
667
  export interface ManifestProcessingRules {
589
668
  /**
669
+ * @public
590
670
  * <p>For HLS, when set to <code>true</code>, MediaTailor passes through <code>EXT-X-CUE-IN</code>, <code>EXT-X-CUE-OUT</code>, and <code>EXT-X-SPLICEPOINT-SCTE35</code> ad markers from the origin manifest to the MediaTailor personalized manifest.</p>
591
671
  * <p>No logic is applied to these ad markers. For example, if <code>EXT-X-CUE-OUT</code> has a value of <code>60</code>, but no ads are filled for that ad break, MediaTailor will not set the value to <code>0</code>.</p>
592
672
  */
@@ -598,78 +678,97 @@ export interface ManifestProcessingRules {
598
678
  */
599
679
  export interface PlaybackConfiguration {
600
680
  /**
681
+ * @public
601
682
  * <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
602
683
  */
603
684
  AdDecisionServerUrl?: string;
604
685
  /**
686
+ * @public
605
687
  * <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
606
688
  */
607
689
  AvailSuppression?: AvailSuppression;
608
690
  /**
691
+ * @public
609
692
  * <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
610
693
  */
611
694
  Bumper?: Bumper;
612
695
  /**
696
+ * @public
613
697
  * <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
614
698
  */
615
699
  CdnConfiguration?: CdnConfiguration;
616
700
  /**
701
+ * @public
617
702
  * <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
618
703
  */
619
704
  ConfigurationAliases?: Record<string, Record<string, string>>;
620
705
  /**
706
+ * @public
621
707
  * <p>The configuration for a DASH source.</p>
622
708
  */
623
709
  DashConfiguration?: DashConfiguration;
624
710
  /**
711
+ * @public
625
712
  * <p>The configuration for HLS content.</p>
626
713
  */
627
714
  HlsConfiguration?: HlsConfiguration;
628
715
  /**
716
+ * @public
629
717
  * <p>The configuration for pre-roll ad insertion.</p>
630
718
  */
631
719
  LivePreRollConfiguration?: LivePreRollConfiguration;
632
720
  /**
721
+ * @public
633
722
  * <p>The Amazon CloudWatch log settings for a playback configuration.</p>
634
723
  */
635
724
  LogConfiguration?: LogConfiguration;
636
725
  /**
726
+ * @public
637
727
  * <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
638
728
  */
639
729
  ManifestProcessingRules?: ManifestProcessingRules;
640
730
  /**
731
+ * @public
641
732
  * <p>The identifier for the playback configuration.</p>
642
733
  */
643
734
  Name?: string;
644
735
  /**
736
+ * @public
645
737
  * <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
646
738
  */
647
739
  PersonalizationThresholdSeconds?: number;
648
740
  /**
741
+ * @public
649
742
  * <p>The Amazon Resource Name (ARN) for the playback configuration.</p>
650
743
  */
651
744
  PlaybackConfigurationArn?: string;
652
745
  /**
746
+ * @public
653
747
  * <p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.</p>
654
748
  */
655
749
  PlaybackEndpointPrefix?: string;
656
750
  /**
751
+ * @public
657
752
  * <p>The URL that the player uses to initialize a session that uses client-side reporting.</p>
658
753
  */
659
754
  SessionInitializationEndpointPrefix?: string;
660
755
  /**
756
+ * @public
661
757
  * <p>The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
662
758
  */
663
759
  SlateAdUrl?: string;
664
760
  /**
761
+ * @public
665
762
  * <p>The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
666
763
  */
667
764
  Tags?: Record<string, string>;
668
765
  /**
766
+ * @public
669
767
  * <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
670
768
  */
671
769
  TranscodeProfileName?: string;
672
770
  /**
771
+ * @public
673
772
  * <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
674
773
  */
675
774
  VideoContentSourceUrl?: string;
@@ -680,14 +779,17 @@ export interface PlaybackConfiguration {
680
779
  */
681
780
  export interface PrefetchConsumption {
682
781
  /**
782
+ * @public
683
783
  * <p>If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as <code>scte.event_id</code>, set the avail matching criteria.</p>
684
784
  */
685
785
  AvailMatchingCriteria?: AvailMatchingCriteria[];
686
786
  /**
787
+ * @public
687
788
  * <p>The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call <code>DeletePrefetchSchedule</code>.</p>
688
789
  */
689
790
  EndTime: Date | undefined;
690
791
  /**
792
+ * @public
691
793
  * <p>The time when prefetched ads are considered for use in an ad break. If you don't specify <code>StartTime</code>, the prefetched ads are available after MediaTailor retrives them from the ad decision server.</p>
692
794
  */
693
795
  StartTime?: Date;
@@ -698,15 +800,18 @@ export interface PrefetchConsumption {
698
800
  */
699
801
  export interface PrefetchRetrieval {
700
802
  /**
803
+ * @public
701
804
  * <p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p>
702
805
  * <p>You initially configure <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">dynamic variables</a> for the ADS URL when you set up your playback configuration. When you specify <code>DynamicVariables</code> for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.</p>
703
806
  */
704
807
  DynamicVariables?: Record<string, string>;
705
808
  /**
809
+ * @public
706
810
  * <p>The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.</p>
707
811
  */
708
812
  EndTime: Date | undefined;
709
813
  /**
814
+ * @public
710
815
  * <p>The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.</p>
711
816
  */
712
817
  StartTime?: Date;
@@ -717,26 +822,32 @@ export interface PrefetchRetrieval {
717
822
  */
718
823
  export interface PrefetchSchedule {
719
824
  /**
825
+ * @public
720
826
  * <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
721
827
  */
722
828
  Arn: string | undefined;
723
829
  /**
830
+ * @public
724
831
  * <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
725
832
  */
726
833
  Consumption: PrefetchConsumption | undefined;
727
834
  /**
835
+ * @public
728
836
  * <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
729
837
  */
730
838
  Name: string | undefined;
731
839
  /**
840
+ * @public
732
841
  * <p>The name of the playback configuration to create the prefetch schedule for.</p>
733
842
  */
734
843
  PlaybackConfigurationName: string | undefined;
735
844
  /**
845
+ * @public
736
846
  * <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
737
847
  */
738
848
  Retrieval: PrefetchRetrieval | undefined;
739
849
  /**
850
+ * @public
740
851
  * <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
741
852
  */
742
853
  StreamId?: string;
@@ -747,18 +858,22 @@ export interface PrefetchSchedule {
747
858
  */
748
859
  export interface ScheduleAdBreak {
749
860
  /**
861
+ * @public
750
862
  * <p>The approximate duration of the ad break, in seconds.</p>
751
863
  */
752
864
  ApproximateDurationSeconds?: number;
753
865
  /**
866
+ * @public
754
867
  * <p>The approximate time that the ad will start playing.</p>
755
868
  */
756
869
  ApproximateStartTime?: Date;
757
870
  /**
871
+ * @public
758
872
  * <p>The name of the source location containing the VOD source used for the ad break.</p>
759
873
  */
760
874
  SourceLocationName?: string;
761
875
  /**
876
+ * @public
762
877
  * <p>The name of the VOD source used for the ad break.</p>
763
878
  */
764
879
  VodSourceName?: string;
@@ -781,42 +896,52 @@ export type ScheduleEntryType = (typeof ScheduleEntryType)[keyof typeof Schedule
781
896
  */
782
897
  export interface ScheduleEntry {
783
898
  /**
899
+ * @public
784
900
  * <p>The approximate duration of this program, in seconds.</p>
785
901
  */
786
902
  ApproximateDurationSeconds?: number;
787
903
  /**
904
+ * @public
788
905
  * <p>The approximate time that the program will start playing.</p>
789
906
  */
790
907
  ApproximateStartTime?: Date;
791
908
  /**
909
+ * @public
792
910
  * <p>The ARN of the program.</p>
793
911
  */
794
912
  Arn: string | undefined;
795
913
  /**
914
+ * @public
796
915
  * <p>The name of the channel that uses this schedule.</p>
797
916
  */
798
917
  ChannelName: string | undefined;
799
918
  /**
919
+ * @public
800
920
  * <p>The name of the live source used for the program.</p>
801
921
  */
802
922
  LiveSourceName?: string;
803
923
  /**
924
+ * @public
804
925
  * <p>The name of the program.</p>
805
926
  */
806
927
  ProgramName: string | undefined;
807
928
  /**
929
+ * @public
808
930
  * <p>The schedule's ad break properties.</p>
809
931
  */
810
932
  ScheduleAdBreaks?: ScheduleAdBreak[];
811
933
  /**
934
+ * @public
812
935
  * <p>The type of schedule entry.</p>
813
936
  */
814
937
  ScheduleEntryType?: ScheduleEntryType | string;
815
938
  /**
939
+ * @public
816
940
  * <p>The name of the source location.</p>
817
941
  */
818
942
  SourceLocationName: string | undefined;
819
943
  /**
944
+ * @public
820
945
  * <p>The name of the VOD source.</p>
821
946
  */
822
947
  VodSourceName?: string;
@@ -827,10 +952,12 @@ export interface ScheduleEntry {
827
952
  */
828
953
  export interface SegmentDeliveryConfiguration {
829
954
  /**
955
+ * @public
830
956
  * <p>The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as <code>https://example.com/some/path</code>. To use a relative URL specify the relative path, such as <code>/some/path*</code>.</p>
831
957
  */
832
958
  BaseUrl?: string;
833
959
  /**
960
+ * @public
834
961
  * <p>A unique identifier used to distinguish between multiple segment delivery configurations in a source location.</p>
835
962
  */
836
963
  Name?: string;
@@ -853,14 +980,17 @@ export type AccessType = (typeof AccessType)[keyof typeof AccessType];
853
980
  */
854
981
  export interface SecretsManagerAccessTokenConfiguration {
855
982
  /**
983
+ * @public
856
984
  * <p>The name of the HTTP header used to supply the access token in requests to the source location.</p>
857
985
  */
858
986
  HeaderName?: string;
859
987
  /**
988
+ * @public
860
989
  * <p>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.</p>
861
990
  */
862
991
  SecretArn?: string;
863
992
  /**
993
+ * @public
864
994
  * <p>The AWS Secrets Manager <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html">SecretString</a> key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.</p>
865
995
  */
866
996
  SecretStringKey?: string;
@@ -871,6 +1001,7 @@ export interface SecretsManagerAccessTokenConfiguration {
871
1001
  */
872
1002
  export interface AccessConfiguration {
873
1003
  /**
1004
+ * @public
874
1005
  * <p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location. Accepted value: <code>S3_SIGV4</code>.</p>
875
1006
  * <p>
876
1007
  * <code>S3_SIGV4</code> - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.</p>
@@ -881,6 +1012,7 @@ export interface AccessConfiguration {
881
1012
  */
882
1013
  AccessType?: AccessType | string;
883
1014
  /**
1015
+ * @public
884
1016
  * <p>AWS Secrets Manager access token configuration parameters.</p>
885
1017
  */
886
1018
  SecretsManagerAccessTokenConfiguration?: SecretsManagerAccessTokenConfiguration;
@@ -891,6 +1023,7 @@ export interface AccessConfiguration {
891
1023
  */
892
1024
  export interface DefaultSegmentDeliveryConfiguration {
893
1025
  /**
1026
+ * @public
894
1027
  * <p>The hostname of the server that will be used to serve segments. This string must include the protocol, such as <b>https://</b>.</p>
895
1028
  */
896
1029
  BaseUrl?: string;
@@ -901,6 +1034,7 @@ export interface DefaultSegmentDeliveryConfiguration {
901
1034
  */
902
1035
  export interface HttpConfiguration {
903
1036
  /**
1037
+ * @public
904
1038
  * <p>The base URL for the source location host server. This string must include the protocol, such as <b>https://</b>.</p>
905
1039
  */
906
1040
  BaseUrl: string | undefined;
@@ -911,38 +1045,47 @@ export interface HttpConfiguration {
911
1045
  */
912
1046
  export interface SourceLocation {
913
1047
  /**
1048
+ * @public
914
1049
  * <p>The access configuration for the source location.</p>
915
1050
  */
916
1051
  AccessConfiguration?: AccessConfiguration;
917
1052
  /**
1053
+ * @public
918
1054
  * <p>The ARN of the SourceLocation.</p>
919
1055
  */
920
1056
  Arn: string | undefined;
921
1057
  /**
1058
+ * @public
922
1059
  * <p>The timestamp that indicates when the source location was created.</p>
923
1060
  */
924
1061
  CreationTime?: Date;
925
1062
  /**
1063
+ * @public
926
1064
  * <p>The default segment delivery configuration.</p>
927
1065
  */
928
1066
  DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
929
1067
  /**
1068
+ * @public
930
1069
  * <p>The HTTP configuration for the source location.</p>
931
1070
  */
932
1071
  HttpConfiguration: HttpConfiguration | undefined;
933
1072
  /**
1073
+ * @public
934
1074
  * <p>The timestamp that indicates when the source location was last modified.</p>
935
1075
  */
936
1076
  LastModifiedTime?: Date;
937
1077
  /**
1078
+ * @public
938
1079
  * <p>The segment delivery configurations for the source location.</p>
939
1080
  */
940
1081
  SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
941
1082
  /**
1083
+ * @public
942
1084
  * <p>The name of the source location.</p>
943
1085
  */
944
1086
  SourceLocationName: string | undefined;
945
1087
  /**
1088
+ * @public
946
1089
  * <p>The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
947
1090
  */
948
1091
  Tags?: Record<string, string>;
@@ -953,30 +1096,37 @@ export interface SourceLocation {
953
1096
  */
954
1097
  export interface VodSource {
955
1098
  /**
1099
+ * @public
956
1100
  * <p>The ARN for the VOD source.</p>
957
1101
  */
958
1102
  Arn: string | undefined;
959
1103
  /**
1104
+ * @public
960
1105
  * <p>The timestamp that indicates when the VOD source was created.</p>
961
1106
  */
962
1107
  CreationTime?: Date;
963
1108
  /**
1109
+ * @public
964
1110
  * <p>The HTTP package configurations for the VOD source.</p>
965
1111
  */
966
1112
  HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
967
1113
  /**
1114
+ * @public
968
1115
  * <p>The timestamp that indicates when the VOD source was last modified.</p>
969
1116
  */
970
1117
  LastModifiedTime?: Date;
971
1118
  /**
1119
+ * @public
972
1120
  * <p>The name of the source location that the VOD source is associated with.</p>
973
1121
  */
974
1122
  SourceLocationName: string | undefined;
975
1123
  /**
1124
+ * @public
976
1125
  * <p>The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
977
1126
  */
978
1127
  Tags?: Record<string, string>;
979
1128
  /**
1129
+ * @public
980
1130
  * <p>The name of the VOD source.</p>
981
1131
  */
982
1132
  VodSourceName: string | undefined;
@@ -999,6 +1149,7 @@ export declare class BadRequestException extends __BaseException {
999
1149
  */
1000
1150
  export interface DeleteChannelPolicyRequest {
1001
1151
  /**
1152
+ * @public
1002
1153
  * <p>The name of the channel associated with this channel policy.</p>
1003
1154
  */
1004
1155
  ChannelName: string | undefined;
@@ -1013,6 +1164,7 @@ export interface DeleteChannelPolicyResponse {
1013
1164
  */
1014
1165
  export interface GetChannelPolicyRequest {
1015
1166
  /**
1167
+ * @public
1016
1168
  * <p>The name of the channel associated with this Channel Policy.</p>
1017
1169
  */
1018
1170
  ChannelName: string | undefined;
@@ -1022,6 +1174,7 @@ export interface GetChannelPolicyRequest {
1022
1174
  */
1023
1175
  export interface GetChannelPolicyResponse {
1024
1176
  /**
1177
+ * @public
1025
1178
  * <p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
1026
1179
  */
1027
1180
  Policy?: string;
@@ -1031,10 +1184,12 @@ export interface GetChannelPolicyResponse {
1031
1184
  */
1032
1185
  export interface PutChannelPolicyRequest {
1033
1186
  /**
1187
+ * @public
1034
1188
  * <p>The channel name associated with this Channel Policy.</p>
1035
1189
  */
1036
1190
  ChannelName: string | undefined;
1037
1191
  /**
1192
+ * @public
1038
1193
  * <p>Adds an IAM role that determines the permissions of your channel.</p>
1039
1194
  */
1040
1195
  Policy: string | undefined;
@@ -1049,10 +1204,12 @@ export interface PutChannelPolicyResponse {
1049
1204
  */
1050
1205
  export interface ConfigureLogsForChannelRequest {
1051
1206
  /**
1207
+ * @public
1052
1208
  * <p>The name of the channel.</p>
1053
1209
  */
1054
1210
  ChannelName: string | undefined;
1055
1211
  /**
1212
+ * @public
1056
1213
  * <p>The types of logs to collect.</p>
1057
1214
  */
1058
1215
  LogTypes: (LogType | string)[] | undefined;
@@ -1062,10 +1219,12 @@ export interface ConfigureLogsForChannelRequest {
1062
1219
  */
1063
1220
  export interface ConfigureLogsForChannelResponse {
1064
1221
  /**
1222
+ * @public
1065
1223
  * <p>The name of the channel.</p>
1066
1224
  */
1067
1225
  ChannelName?: string;
1068
1226
  /**
1227
+ * @public
1069
1228
  * <p>The types of logs collected.</p>
1070
1229
  */
1071
1230
  LogTypes?: (LogType | string)[];
@@ -1076,18 +1235,22 @@ export interface ConfigureLogsForChannelResponse {
1076
1235
  */
1077
1236
  export interface RequestOutputItem {
1078
1237
  /**
1238
+ * @public
1079
1239
  * <p>DASH manifest configuration parameters.</p>
1080
1240
  */
1081
1241
  DashPlaylistSettings?: DashPlaylistSettings;
1082
1242
  /**
1243
+ * @public
1083
1244
  * <p>HLS playlist configuration parameters.</p>
1084
1245
  */
1085
1246
  HlsPlaylistSettings?: HlsPlaylistSettings;
1086
1247
  /**
1248
+ * @public
1087
1249
  * <p>The name of the manifest for the channel. The name appears in the <code>PlaybackUrl</code>.</p>
1088
1250
  */
1089
1251
  ManifestName: string | undefined;
1090
1252
  /**
1253
+ * @public
1091
1254
  * <p>A string used to match which <code>HttpPackageConfiguration</code> is used for each <code>VodSource</code>.</p>
1092
1255
  */
1093
1256
  SourceGroup: string | undefined;
@@ -1121,20 +1284,24 @@ export type Tier = (typeof Tier)[keyof typeof Tier];
1121
1284
  */
1122
1285
  export interface CreateChannelRequest {
1123
1286
  /**
1287
+ * @public
1124
1288
  * <p>The name of the channel.</p>
1125
1289
  */
1126
1290
  ChannelName: string | undefined;
1127
1291
  /**
1292
+ * @public
1128
1293
  * <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
1129
1294
  * <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
1130
1295
  * <code>PlaybackMode</code>.</p>
1131
1296
  */
1132
1297
  FillerSlate?: SlateSource;
1133
1298
  /**
1299
+ * @public
1134
1300
  * <p>The channel's output properties.</p>
1135
1301
  */
1136
1302
  Outputs: RequestOutputItem[] | undefined;
1137
1303
  /**
1304
+ * @public
1138
1305
  * <p>The type of playback mode to use for this channel.</p>
1139
1306
  * <p>
1140
1307
  * <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p>
@@ -1143,10 +1310,12 @@ export interface CreateChannelRequest {
1143
1310
  */
1144
1311
  PlaybackMode: PlaybackMode | string | undefined;
1145
1312
  /**
1313
+ * @public
1146
1314
  * <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1147
1315
  */
1148
1316
  Tags?: Record<string, string>;
1149
1317
  /**
1318
+ * @public
1150
1319
  * <p>The tier of the channel.</p>
1151
1320
  */
1152
1321
  Tier?: Tier | string;
@@ -1168,42 +1337,52 @@ export type ChannelState = (typeof ChannelState)[keyof typeof ChannelState];
1168
1337
  */
1169
1338
  export interface CreateChannelResponse {
1170
1339
  /**
1340
+ * @public
1171
1341
  * <p>The Amazon Resource Name (ARN) to assign to the channel.</p>
1172
1342
  */
1173
1343
  Arn?: string;
1174
1344
  /**
1345
+ * @public
1175
1346
  * <p>The name to assign to the channel.</p>
1176
1347
  */
1177
1348
  ChannelName?: string;
1178
1349
  /**
1350
+ * @public
1179
1351
  * <p>Indicates whether the channel is in a running state or not.</p>
1180
1352
  */
1181
1353
  ChannelState?: ChannelState | string;
1182
1354
  /**
1355
+ * @public
1183
1356
  * <p>The timestamp of when the channel was created.</p>
1184
1357
  */
1185
1358
  CreationTime?: Date;
1186
1359
  /**
1360
+ * @public
1187
1361
  * <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
1188
1362
  */
1189
1363
  FillerSlate?: SlateSource;
1190
1364
  /**
1365
+ * @public
1191
1366
  * <p>The timestamp of when the channel was last modified.</p>
1192
1367
  */
1193
1368
  LastModifiedTime?: Date;
1194
1369
  /**
1370
+ * @public
1195
1371
  * <p>The output properties to assign to the channel.</p>
1196
1372
  */
1197
1373
  Outputs?: ResponseOutputItem[];
1198
1374
  /**
1375
+ * @public
1199
1376
  * <p>The playback mode to assign to the channel.</p>
1200
1377
  */
1201
1378
  PlaybackMode?: string;
1202
1379
  /**
1380
+ * @public
1203
1381
  * <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1204
1382
  */
1205
1383
  Tags?: Record<string, string>;
1206
1384
  /**
1385
+ * @public
1207
1386
  * <p>The tier of the channel.</p>
1208
1387
  */
1209
1388
  Tier?: string;
@@ -1213,6 +1392,7 @@ export interface CreateChannelResponse {
1213
1392
  */
1214
1393
  export interface DeleteChannelRequest {
1215
1394
  /**
1395
+ * @public
1216
1396
  * <p>The name of the channel.</p>
1217
1397
  */
1218
1398
  ChannelName: string | undefined;
@@ -1227,6 +1407,7 @@ export interface DeleteChannelResponse {
1227
1407
  */
1228
1408
  export interface DescribeChannelRequest {
1229
1409
  /**
1410
+ * @public
1230
1411
  * <p>The name of the channel.</p>
1231
1412
  */
1232
1413
  ChannelName: string | undefined;
@@ -1236,46 +1417,57 @@ export interface DescribeChannelRequest {
1236
1417
  */
1237
1418
  export interface DescribeChannelResponse {
1238
1419
  /**
1420
+ * @public
1239
1421
  * <p>The ARN of the channel.</p>
1240
1422
  */
1241
1423
  Arn?: string;
1242
1424
  /**
1425
+ * @public
1243
1426
  * <p>The name of the channel.</p>
1244
1427
  */
1245
1428
  ChannelName?: string;
1246
1429
  /**
1430
+ * @public
1247
1431
  * <p>Indicates whether the channel is in a running state or not.</p>
1248
1432
  */
1249
1433
  ChannelState?: ChannelState | string;
1250
1434
  /**
1435
+ * @public
1251
1436
  * <p>The timestamp of when the channel was created.</p>
1252
1437
  */
1253
1438
  CreationTime?: Date;
1254
1439
  /**
1440
+ * @public
1255
1441
  * <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
1256
1442
  */
1257
1443
  FillerSlate?: SlateSource;
1258
1444
  /**
1445
+ * @public
1259
1446
  * <p>The timestamp of when the channel was last modified.</p>
1260
1447
  */
1261
1448
  LastModifiedTime?: Date;
1262
1449
  /**
1450
+ * @public
1263
1451
  * <p>The channel's output properties.</p>
1264
1452
  */
1265
1453
  Outputs?: ResponseOutputItem[];
1266
1454
  /**
1455
+ * @public
1267
1456
  * <p>The channel's playback mode.</p>
1268
1457
  */
1269
1458
  PlaybackMode?: string;
1270
1459
  /**
1460
+ * @public
1271
1461
  * <p>The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1272
1462
  */
1273
1463
  Tags?: Record<string, string>;
1274
1464
  /**
1465
+ * @public
1275
1466
  * <p>The channel's tier.</p>
1276
1467
  */
1277
1468
  Tier?: string;
1278
1469
  /**
1470
+ * @public
1279
1471
  * <p>The log configuration for the channel.</p>
1280
1472
  */
1281
1473
  LogConfiguration: LogConfigurationForChannel | undefined;
@@ -1285,18 +1477,22 @@ export interface DescribeChannelResponse {
1285
1477
  */
1286
1478
  export interface GetChannelScheduleRequest {
1287
1479
  /**
1480
+ * @public
1288
1481
  * <p>The name of the channel associated with this Channel Schedule.</p>
1289
1482
  */
1290
1483
  ChannelName: string | undefined;
1291
1484
  /**
1485
+ * @public
1292
1486
  * <p>The duration in minutes of the channel schedule.</p>
1293
1487
  */
1294
1488
  DurationMinutes?: string;
1295
1489
  /**
1490
+ * @public
1296
1491
  * <p>The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channel schedules, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
1297
1492
  */
1298
1493
  MaxResults?: number;
1299
1494
  /**
1495
+ * @public
1300
1496
  * <p>(Optional) If the playback configuration has more than <code>MaxResults</code> channel schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p>
1301
1497
  * <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p>
1302
1498
  * <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p>
@@ -1309,10 +1505,12 @@ export interface GetChannelScheduleRequest {
1309
1505
  */
1310
1506
  export interface GetChannelScheduleResponse {
1311
1507
  /**
1508
+ * @public
1312
1509
  * <p>A list of schedule entries for the channel.</p>
1313
1510
  */
1314
1511
  Items?: ScheduleEntry[];
1315
1512
  /**
1513
+ * @public
1316
1514
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
1317
1515
  */
1318
1516
  NextToken?: string;
@@ -1322,10 +1520,12 @@ export interface GetChannelScheduleResponse {
1322
1520
  */
1323
1521
  export interface ListChannelsRequest {
1324
1522
  /**
1523
+ * @public
1325
1524
  * <p>The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channels, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
1326
1525
  */
1327
1526
  MaxResults?: number;
1328
1527
  /**
1528
+ * @public
1329
1529
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
1330
1530
  */
1331
1531
  NextToken?: string;
@@ -1335,10 +1535,12 @@ export interface ListChannelsRequest {
1335
1535
  */
1336
1536
  export interface ListChannelsResponse {
1337
1537
  /**
1538
+ * @public
1338
1539
  * <p>A list of channels that are associated with this account.</p>
1339
1540
  */
1340
1541
  Items?: Channel[];
1341
1542
  /**
1543
+ * @public
1342
1544
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
1343
1545
  */
1344
1546
  NextToken?: string;
@@ -1349,6 +1551,7 @@ export interface ListChannelsResponse {
1349
1551
  */
1350
1552
  export interface ClipRange {
1351
1553
  /**
1554
+ * @public
1352
1555
  * <p>The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.</p>
1353
1556
  */
1354
1557
  EndOffsetMillis: number | undefined;
@@ -1371,22 +1574,27 @@ export type RelativePosition = (typeof RelativePosition)[keyof typeof RelativePo
1371
1574
  */
1372
1575
  export interface Transition {
1373
1576
  /**
1577
+ * @public
1374
1578
  * <p>The duration of the live program in seconds.</p>
1375
1579
  */
1376
1580
  DurationMillis?: number;
1377
1581
  /**
1582
+ * @public
1378
1583
  * <p>The position where this program will be inserted relative to the <code>RelativePosition</code>.</p>
1379
1584
  */
1380
1585
  RelativePosition: RelativePosition | string | undefined;
1381
1586
  /**
1587
+ * @public
1382
1588
  * <p>The name of the program that this program will be inserted next to, as defined by <code>RelativePosition</code>.</p>
1383
1589
  */
1384
1590
  RelativeProgram?: string;
1385
1591
  /**
1592
+ * @public
1386
1593
  * <p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>
1387
1594
  */
1388
1595
  ScheduledStartTimeMillis?: number;
1389
1596
  /**
1597
+ * @public
1390
1598
  * <p>Defines when the program plays in the schedule. You can set the value to <code>ABSOLUTE</code> or <code>RELATIVE</code>.</p>
1391
1599
  * <p>
1392
1600
  * <code>ABSOLUTE</code> - The program plays at a specific wall clock time. This setting can only be used for channels using the <code>LINEAR</code>
@@ -1405,10 +1613,12 @@ export interface Transition {
1405
1613
  */
1406
1614
  export interface ScheduleConfiguration {
1407
1615
  /**
1616
+ * @public
1408
1617
  * <p>Program transition configurations.</p>
1409
1618
  */
1410
1619
  Transition: Transition | undefined;
1411
1620
  /**
1621
+ * @public
1412
1622
  * <p>Program clip range configuration.</p>
1413
1623
  */
1414
1624
  ClipRange?: ClipRange;
@@ -1418,30 +1628,37 @@ export interface ScheduleConfiguration {
1418
1628
  */
1419
1629
  export interface CreateProgramRequest {
1420
1630
  /**
1631
+ * @public
1421
1632
  * <p>The ad break configuration settings.</p>
1422
1633
  */
1423
1634
  AdBreaks?: AdBreak[];
1424
1635
  /**
1636
+ * @public
1425
1637
  * <p>The name of the channel for this Program.</p>
1426
1638
  */
1427
1639
  ChannelName: string | undefined;
1428
1640
  /**
1641
+ * @public
1429
1642
  * <p>The name of the LiveSource for this Program.</p>
1430
1643
  */
1431
1644
  LiveSourceName?: string;
1432
1645
  /**
1646
+ * @public
1433
1647
  * <p>The name of the Program.</p>
1434
1648
  */
1435
1649
  ProgramName: string | undefined;
1436
1650
  /**
1651
+ * @public
1437
1652
  * <p>The schedule configuration settings.</p>
1438
1653
  */
1439
1654
  ScheduleConfiguration: ScheduleConfiguration | undefined;
1440
1655
  /**
1656
+ * @public
1441
1657
  * <p>The name of the source location.</p>
1442
1658
  */
1443
1659
  SourceLocationName: string | undefined;
1444
1660
  /**
1661
+ * @public
1445
1662
  * <p>The name that's used to refer to a VOD source.</p>
1446
1663
  */
1447
1664
  VodSourceName?: string;
@@ -1451,46 +1668,57 @@ export interface CreateProgramRequest {
1451
1668
  */
1452
1669
  export interface CreateProgramResponse {
1453
1670
  /**
1671
+ * @public
1454
1672
  * <p>The ad break configuration settings.</p>
1455
1673
  */
1456
1674
  AdBreaks?: AdBreak[];
1457
1675
  /**
1676
+ * @public
1458
1677
  * <p>The ARN to assign to the program.</p>
1459
1678
  */
1460
1679
  Arn?: string;
1461
1680
  /**
1681
+ * @public
1462
1682
  * <p>The name to assign to the channel for this program.</p>
1463
1683
  */
1464
1684
  ChannelName?: string;
1465
1685
  /**
1686
+ * @public
1466
1687
  * <p>The time the program was created.</p>
1467
1688
  */
1468
1689
  CreationTime?: Date;
1469
1690
  /**
1691
+ * @public
1470
1692
  * <p>The name of the LiveSource for this Program.</p>
1471
1693
  */
1472
1694
  LiveSourceName?: string;
1473
1695
  /**
1696
+ * @public
1474
1697
  * <p>The name to assign to this program.</p>
1475
1698
  */
1476
1699
  ProgramName?: string;
1477
1700
  /**
1701
+ * @public
1478
1702
  * <p>The scheduled start time for this Program.</p>
1479
1703
  */
1480
1704
  ScheduledStartTime?: Date;
1481
1705
  /**
1706
+ * @public
1482
1707
  * <p>The name to assign to the source location for this program.</p>
1483
1708
  */
1484
1709
  SourceLocationName?: string;
1485
1710
  /**
1711
+ * @public
1486
1712
  * <p>The name that's used to refer to a VOD source.</p>
1487
1713
  */
1488
1714
  VodSourceName?: string;
1489
1715
  /**
1716
+ * @public
1490
1717
  * <p>The clip range configuration settings.</p>
1491
1718
  */
1492
1719
  ClipRange?: ClipRange;
1493
1720
  /**
1721
+ * @public
1494
1722
  * <p>The duration of the live program in milliseconds.</p>
1495
1723
  */
1496
1724
  DurationMillis?: number;
@@ -1500,10 +1728,12 @@ export interface CreateProgramResponse {
1500
1728
  */
1501
1729
  export interface DeleteProgramRequest {
1502
1730
  /**
1731
+ * @public
1503
1732
  * <p>The name of the channel.</p>
1504
1733
  */
1505
1734
  ChannelName: string | undefined;
1506
1735
  /**
1736
+ * @public
1507
1737
  * <p>The name of the program.</p>
1508
1738
  */
1509
1739
  ProgramName: string | undefined;
@@ -1518,10 +1748,12 @@ export interface DeleteProgramResponse {
1518
1748
  */
1519
1749
  export interface DescribeProgramRequest {
1520
1750
  /**
1751
+ * @public
1521
1752
  * <p>The name of the channel associated with this Program.</p>
1522
1753
  */
1523
1754
  ChannelName: string | undefined;
1524
1755
  /**
1756
+ * @public
1525
1757
  * <p>The name of the program.</p>
1526
1758
  */
1527
1759
  ProgramName: string | undefined;
@@ -1531,46 +1763,57 @@ export interface DescribeProgramRequest {
1531
1763
  */
1532
1764
  export interface DescribeProgramResponse {
1533
1765
  /**
1766
+ * @public
1534
1767
  * <p>The ad break configuration settings.</p>
1535
1768
  */
1536
1769
  AdBreaks?: AdBreak[];
1537
1770
  /**
1771
+ * @public
1538
1772
  * <p>The ARN of the program.</p>
1539
1773
  */
1540
1774
  Arn?: string;
1541
1775
  /**
1776
+ * @public
1542
1777
  * <p>The name of the channel that the program belongs to.</p>
1543
1778
  */
1544
1779
  ChannelName?: string;
1545
1780
  /**
1781
+ * @public
1546
1782
  * <p>The timestamp of when the program was created.</p>
1547
1783
  */
1548
1784
  CreationTime?: Date;
1549
1785
  /**
1786
+ * @public
1550
1787
  * <p>The name of the LiveSource for this Program.</p>
1551
1788
  */
1552
1789
  LiveSourceName?: string;
1553
1790
  /**
1791
+ * @public
1554
1792
  * <p>The name of the program.</p>
1555
1793
  */
1556
1794
  ProgramName?: string;
1557
1795
  /**
1796
+ * @public
1558
1797
  * <p>The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.</p>
1559
1798
  */
1560
1799
  ScheduledStartTime?: Date;
1561
1800
  /**
1801
+ * @public
1562
1802
  * <p>The source location name.</p>
1563
1803
  */
1564
1804
  SourceLocationName?: string;
1565
1805
  /**
1806
+ * @public
1566
1807
  * <p>The name that's used to refer to a VOD source.</p>
1567
1808
  */
1568
1809
  VodSourceName?: string;
1569
1810
  /**
1811
+ * @public
1570
1812
  * <p>The clip range configuration settings.</p>
1571
1813
  */
1572
1814
  ClipRange?: ClipRange;
1573
1815
  /**
1816
+ * @public
1574
1817
  * <p>The duration of the live program in milliseconds.</p>
1575
1818
  */
1576
1819
  DurationMillis?: number;
@@ -1581,10 +1824,12 @@ export interface DescribeProgramResponse {
1581
1824
  */
1582
1825
  export interface UpdateProgramTransition {
1583
1826
  /**
1827
+ * @public
1584
1828
  * <p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>
1585
1829
  */
1586
1830
  ScheduledStartTimeMillis?: number;
1587
1831
  /**
1832
+ * @public
1588
1833
  * <p>The duration of the live program in seconds.</p>
1589
1834
  */
1590
1835
  DurationMillis?: number;
@@ -1595,10 +1840,12 @@ export interface UpdateProgramTransition {
1595
1840
  */
1596
1841
  export interface UpdateProgramScheduleConfiguration {
1597
1842
  /**
1843
+ * @public
1598
1844
  * <p>Program transition configuration.</p>
1599
1845
  */
1600
1846
  Transition?: UpdateProgramTransition;
1601
1847
  /**
1848
+ * @public
1602
1849
  * <p>Program clip range configuration.</p>
1603
1850
  */
1604
1851
  ClipRange?: ClipRange;
@@ -1608,18 +1855,22 @@ export interface UpdateProgramScheduleConfiguration {
1608
1855
  */
1609
1856
  export interface UpdateProgramRequest {
1610
1857
  /**
1858
+ * @public
1611
1859
  * <p>The ad break configuration settings.</p>
1612
1860
  */
1613
1861
  AdBreaks?: AdBreak[];
1614
1862
  /**
1863
+ * @public
1615
1864
  * <p>The name of the channel for this Program.</p>
1616
1865
  */
1617
1866
  ChannelName: string | undefined;
1618
1867
  /**
1868
+ * @public
1619
1869
  * <p>The name of the Program.</p>
1620
1870
  */
1621
1871
  ProgramName: string | undefined;
1622
1872
  /**
1873
+ * @public
1623
1874
  * <p>The schedule configuration settings.</p>
1624
1875
  */
1625
1876
  ScheduleConfiguration: UpdateProgramScheduleConfiguration | undefined;
@@ -1629,46 +1880,57 @@ export interface UpdateProgramRequest {
1629
1880
  */
1630
1881
  export interface UpdateProgramResponse {
1631
1882
  /**
1883
+ * @public
1632
1884
  * <p>The ad break configuration settings.</p>
1633
1885
  */
1634
1886
  AdBreaks?: AdBreak[];
1635
1887
  /**
1888
+ * @public
1636
1889
  * <p>The ARN to assign to the program.</p>
1637
1890
  */
1638
1891
  Arn?: string;
1639
1892
  /**
1893
+ * @public
1640
1894
  * <p>The name to assign to the channel for this program.</p>
1641
1895
  */
1642
1896
  ChannelName?: string;
1643
1897
  /**
1898
+ * @public
1644
1899
  * <p>The time the program was created.</p>
1645
1900
  */
1646
1901
  CreationTime?: Date;
1647
1902
  /**
1903
+ * @public
1648
1904
  * <p>The name to assign to this program.</p>
1649
1905
  */
1650
1906
  ProgramName?: string;
1651
1907
  /**
1908
+ * @public
1652
1909
  * <p>The name to assign to the source location for this program.</p>
1653
1910
  */
1654
1911
  SourceLocationName?: string;
1655
1912
  /**
1913
+ * @public
1656
1914
  * <p>The name that's used to refer to a VOD source.</p>
1657
1915
  */
1658
1916
  VodSourceName?: string;
1659
1917
  /**
1918
+ * @public
1660
1919
  * <p>The name of the LiveSource for this Program.</p>
1661
1920
  */
1662
1921
  LiveSourceName?: string;
1663
1922
  /**
1923
+ * @public
1664
1924
  * <p>The clip range configuration settings.</p>
1665
1925
  */
1666
1926
  ClipRange?: ClipRange;
1667
1927
  /**
1928
+ * @public
1668
1929
  * <p>The duration of the live program in milliseconds.</p>
1669
1930
  */
1670
1931
  DurationMillis?: number;
1671
1932
  /**
1933
+ * @public
1672
1934
  * <p>The scheduled start time for this Program.</p>
1673
1935
  */
1674
1936
  ScheduledStartTime?: Date;
@@ -1678,6 +1940,7 @@ export interface UpdateProgramResponse {
1678
1940
  */
1679
1941
  export interface StartChannelRequest {
1680
1942
  /**
1943
+ * @public
1681
1944
  * <p>The name of the channel.</p>
1682
1945
  */
1683
1946
  ChannelName: string | undefined;
@@ -1692,6 +1955,7 @@ export interface StartChannelResponse {
1692
1955
  */
1693
1956
  export interface StopChannelRequest {
1694
1957
  /**
1958
+ * @public
1695
1959
  * <p>The name of the channel.</p>
1696
1960
  */
1697
1961
  ChannelName: string | undefined;
@@ -1706,16 +1970,19 @@ export interface StopChannelResponse {
1706
1970
  */
1707
1971
  export interface UpdateChannelRequest {
1708
1972
  /**
1973
+ * @public
1709
1974
  * <p>The name of the channel.</p>
1710
1975
  */
1711
1976
  ChannelName: string | undefined;
1712
1977
  /**
1978
+ * @public
1713
1979
  * <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
1714
1980
  * <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
1715
1981
  * <code>PlaybackMode</code>.</p>
1716
1982
  */
1717
1983
  FillerSlate?: SlateSource;
1718
1984
  /**
1985
+ * @public
1719
1986
  * <p>The channel's output properties.</p>
1720
1987
  */
1721
1988
  Outputs: RequestOutputItem[] | undefined;
@@ -1725,36 +1992,44 @@ export interface UpdateChannelRequest {
1725
1992
  */
1726
1993
  export interface UpdateChannelResponse {
1727
1994
  /**
1995
+ * @public
1728
1996
  * <p>The Amazon Resource Name (ARN) associated with the channel.</p>
1729
1997
  */
1730
1998
  Arn?: string;
1731
1999
  /**
2000
+ * @public
1732
2001
  * <p>The name of the channel.</p>
1733
2002
  */
1734
2003
  ChannelName?: string;
1735
2004
  /**
2005
+ * @public
1736
2006
  * <p>Returns the state whether the channel is running or not.</p>
1737
2007
  */
1738
2008
  ChannelState?: ChannelState | string;
1739
2009
  /**
2010
+ * @public
1740
2011
  * <p>The timestamp of when the channel was created.</p>
1741
2012
  */
1742
2013
  CreationTime?: Date;
1743
2014
  /**
2015
+ * @public
1744
2016
  * <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
1745
2017
  * <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
1746
2018
  * <code>PlaybackMode</code>.</p>
1747
2019
  */
1748
2020
  FillerSlate?: SlateSource;
1749
2021
  /**
2022
+ * @public
1750
2023
  * <p>The timestamp that indicates when the channel was last modified.</p>
1751
2024
  */
1752
2025
  LastModifiedTime?: Date;
1753
2026
  /**
2027
+ * @public
1754
2028
  * <p>The channel's output properties.</p>
1755
2029
  */
1756
2030
  Outputs?: ResponseOutputItem[];
1757
2031
  /**
2032
+ * @public
1758
2033
  * <p>The type of playback mode for this channel.</p>
1759
2034
  * <p>
1760
2035
  * <code>LINEAR</code> - Programs play back-to-back only once.</p>
@@ -1763,10 +2038,12 @@ export interface UpdateChannelResponse {
1763
2038
  */
1764
2039
  PlaybackMode?: string;
1765
2040
  /**
2041
+ * @public
1766
2042
  * <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1767
2043
  */
1768
2044
  Tags?: Record<string, string>;
1769
2045
  /**
2046
+ * @public
1770
2047
  * <p>The tier associated with this Channel.</p>
1771
2048
  */
1772
2049
  Tier?: string;
@@ -1777,12 +2054,14 @@ export interface UpdateChannelResponse {
1777
2054
  */
1778
2055
  export interface ConfigureLogsForPlaybackConfigurationRequest {
1779
2056
  /**
2057
+ * @public
1780
2058
  * <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p>
1781
2059
  * <p>Valid values: <code>0</code> - <code>100</code>
1782
2060
  * </p>
1783
2061
  */
1784
2062
  PercentEnabled: number | undefined;
1785
2063
  /**
2064
+ * @public
1786
2065
  * <p>The name of the playback configuration.</p>
1787
2066
  */
1788
2067
  PlaybackConfigurationName: string | undefined;
@@ -1792,10 +2071,12 @@ export interface ConfigureLogsForPlaybackConfigurationRequest {
1792
2071
  */
1793
2072
  export interface ConfigureLogsForPlaybackConfigurationResponse {
1794
2073
  /**
2074
+ * @public
1795
2075
  * <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.</p>
1796
2076
  */
1797
2077
  PercentEnabled: number | undefined;
1798
2078
  /**
2079
+ * @public
1799
2080
  * <p>The name of the playback configuration.</p>
1800
2081
  */
1801
2082
  PlaybackConfigurationName?: string;
@@ -1805,18 +2086,22 @@ export interface ConfigureLogsForPlaybackConfigurationResponse {
1805
2086
  */
1806
2087
  export interface CreateLiveSourceRequest {
1807
2088
  /**
2089
+ * @public
1808
2090
  * <p>A list of HTTP package configuration parameters for this live source.</p>
1809
2091
  */
1810
2092
  HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
1811
2093
  /**
2094
+ * @public
1812
2095
  * <p>The name of the live source.</p>
1813
2096
  */
1814
2097
  LiveSourceName: string | undefined;
1815
2098
  /**
2099
+ * @public
1816
2100
  * <p>The name of the source location.</p>
1817
2101
  */
1818
2102
  SourceLocationName: string | undefined;
1819
2103
  /**
2104
+ * @public
1820
2105
  * <p>The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1821
2106
  */
1822
2107
  Tags?: Record<string, string>;
@@ -1826,30 +2111,37 @@ export interface CreateLiveSourceRequest {
1826
2111
  */
1827
2112
  export interface CreateLiveSourceResponse {
1828
2113
  /**
2114
+ * @public
1829
2115
  * <p>The ARN to assign to the live source.</p>
1830
2116
  */
1831
2117
  Arn?: string;
1832
2118
  /**
2119
+ * @public
1833
2120
  * <p>The time the live source was created.</p>
1834
2121
  */
1835
2122
  CreationTime?: Date;
1836
2123
  /**
2124
+ * @public
1837
2125
  * <p>A list of HTTP package configuration parameters for this live source.</p>
1838
2126
  */
1839
2127
  HttpPackageConfigurations?: HttpPackageConfiguration[];
1840
2128
  /**
2129
+ * @public
1841
2130
  * <p>The time the live source was last modified.</p>
1842
2131
  */
1843
2132
  LastModifiedTime?: Date;
1844
2133
  /**
2134
+ * @public
1845
2135
  * <p>The name to assign to the live source.</p>
1846
2136
  */
1847
2137
  LiveSourceName?: string;
1848
2138
  /**
2139
+ * @public
1849
2140
  * <p>The name to assign to the source location of the live source.</p>
1850
2141
  */
1851
2142
  SourceLocationName?: string;
1852
2143
  /**
2144
+ * @public
1853
2145
  * <p>The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1854
2146
  */
1855
2147
  Tags?: Record<string, string>;
@@ -1859,22 +2151,27 @@ export interface CreateLiveSourceResponse {
1859
2151
  */
1860
2152
  export interface CreatePrefetchScheduleRequest {
1861
2153
  /**
2154
+ * @public
1862
2155
  * <p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
1863
2156
  */
1864
2157
  Consumption: PrefetchConsumption | undefined;
1865
2158
  /**
2159
+ * @public
1866
2160
  * <p>The name to assign to the schedule request.</p>
1867
2161
  */
1868
2162
  Name: string | undefined;
1869
2163
  /**
2164
+ * @public
1870
2165
  * <p>The name to assign to the playback configuration.</p>
1871
2166
  */
1872
2167
  PlaybackConfigurationName: string | undefined;
1873
2168
  /**
2169
+ * @public
1874
2170
  * <p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p>
1875
2171
  */
1876
2172
  Retrieval: PrefetchRetrieval | undefined;
1877
2173
  /**
2174
+ * @public
1878
2175
  * <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
1879
2176
  */
1880
2177
  StreamId?: string;
@@ -1884,26 +2181,32 @@ export interface CreatePrefetchScheduleRequest {
1884
2181
  */
1885
2182
  export interface CreatePrefetchScheduleResponse {
1886
2183
  /**
2184
+ * @public
1887
2185
  * <p>The ARN to assign to the prefetch schedule.</p>
1888
2186
  */
1889
2187
  Arn?: string;
1890
2188
  /**
2189
+ * @public
1891
2190
  * <p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
1892
2191
  */
1893
2192
  Consumption?: PrefetchConsumption;
1894
2193
  /**
2194
+ * @public
1895
2195
  * <p>The name to assign to the prefetch schedule.</p>
1896
2196
  */
1897
2197
  Name?: string;
1898
2198
  /**
2199
+ * @public
1899
2200
  * <p>The name to assign to the playback configuration.</p>
1900
2201
  */
1901
2202
  PlaybackConfigurationName?: string;
1902
2203
  /**
2204
+ * @public
1903
2205
  * <p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p>
1904
2206
  */
1905
2207
  Retrieval?: PrefetchRetrieval;
1906
2208
  /**
2209
+ * @public
1907
2210
  * <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
1908
2211
  */
1909
2212
  StreamId?: string;
@@ -1913,26 +2216,32 @@ export interface CreatePrefetchScheduleResponse {
1913
2216
  */
1914
2217
  export interface CreateSourceLocationRequest {
1915
2218
  /**
2219
+ * @public
1916
2220
  * <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
1917
2221
  */
1918
2222
  AccessConfiguration?: AccessConfiguration;
1919
2223
  /**
2224
+ * @public
1920
2225
  * <p>The optional configuration for the server that serves segments.</p>
1921
2226
  */
1922
2227
  DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
1923
2228
  /**
2229
+ * @public
1924
2230
  * <p>The source's HTTP package configurations.</p>
1925
2231
  */
1926
2232
  HttpConfiguration: HttpConfiguration | undefined;
1927
2233
  /**
2234
+ * @public
1928
2235
  * <p>A list of the segment delivery configurations associated with this resource.</p>
1929
2236
  */
1930
2237
  SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
1931
2238
  /**
2239
+ * @public
1932
2240
  * <p>The name associated with the source location.</p>
1933
2241
  */
1934
2242
  SourceLocationName: string | undefined;
1935
2243
  /**
2244
+ * @public
1936
2245
  * <p>The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1937
2246
  */
1938
2247
  Tags?: Record<string, string>;
@@ -1942,38 +2251,47 @@ export interface CreateSourceLocationRequest {
1942
2251
  */
1943
2252
  export interface CreateSourceLocationResponse {
1944
2253
  /**
2254
+ * @public
1945
2255
  * <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
1946
2256
  */
1947
2257
  AccessConfiguration?: AccessConfiguration;
1948
2258
  /**
2259
+ * @public
1949
2260
  * <p>The ARN to assign to the source location.</p>
1950
2261
  */
1951
2262
  Arn?: string;
1952
2263
  /**
2264
+ * @public
1953
2265
  * <p>The time the source location was created.</p>
1954
2266
  */
1955
2267
  CreationTime?: Date;
1956
2268
  /**
2269
+ * @public
1957
2270
  * <p>The optional configuration for the server that serves segments.</p>
1958
2271
  */
1959
2272
  DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
1960
2273
  /**
2274
+ * @public
1961
2275
  * <p>The source's HTTP package configurations.</p>
1962
2276
  */
1963
2277
  HttpConfiguration?: HttpConfiguration;
1964
2278
  /**
2279
+ * @public
1965
2280
  * <p>The time the source location was last modified.</p>
1966
2281
  */
1967
2282
  LastModifiedTime?: Date;
1968
2283
  /**
2284
+ * @public
1969
2285
  * <p>The segment delivery configurations for the source location. For information about MediaTailor configurations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html">Working with configurations in AWS Elemental MediaTailor</a>.</p>
1970
2286
  */
1971
2287
  SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
1972
2288
  /**
2289
+ * @public
1973
2290
  * <p>The name to assign to the source location.</p>
1974
2291
  */
1975
2292
  SourceLocationName?: string;
1976
2293
  /**
2294
+ * @public
1977
2295
  * <p>The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1978
2296
  */
1979
2297
  Tags?: Record<string, string>;
@@ -1983,18 +2301,22 @@ export interface CreateSourceLocationResponse {
1983
2301
  */
1984
2302
  export interface CreateVodSourceRequest {
1985
2303
  /**
2304
+ * @public
1986
2305
  * <p>A list of HTTP package configuration parameters for this VOD source.</p>
1987
2306
  */
1988
2307
  HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
1989
2308
  /**
2309
+ * @public
1990
2310
  * <p>The name of the source location for this VOD source.</p>
1991
2311
  */
1992
2312
  SourceLocationName: string | undefined;
1993
2313
  /**
2314
+ * @public
1994
2315
  * <p>The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
1995
2316
  */
1996
2317
  Tags?: Record<string, string>;
1997
2318
  /**
2319
+ * @public
1998
2320
  * <p>The name associated with the VOD source.&gt;</p>
1999
2321
  */
2000
2322
  VodSourceName: string | undefined;
@@ -2004,30 +2326,37 @@ export interface CreateVodSourceRequest {
2004
2326
  */
2005
2327
  export interface CreateVodSourceResponse {
2006
2328
  /**
2329
+ * @public
2007
2330
  * <p>The ARN to assign to this VOD source.</p>
2008
2331
  */
2009
2332
  Arn?: string;
2010
2333
  /**
2334
+ * @public
2011
2335
  * <p>The time the VOD source was created.</p>
2012
2336
  */
2013
2337
  CreationTime?: Date;
2014
2338
  /**
2339
+ * @public
2015
2340
  * <p>A list of HTTP package configuration parameters for this VOD source.</p>
2016
2341
  */
2017
2342
  HttpPackageConfigurations?: HttpPackageConfiguration[];
2018
2343
  /**
2344
+ * @public
2019
2345
  * <p>The time the VOD source was last modified.</p>
2020
2346
  */
2021
2347
  LastModifiedTime?: Date;
2022
2348
  /**
2349
+ * @public
2023
2350
  * <p>The name to assign to the source location for this VOD source.</p>
2024
2351
  */
2025
2352
  SourceLocationName?: string;
2026
2353
  /**
2354
+ * @public
2027
2355
  * <p>The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2028
2356
  */
2029
2357
  Tags?: Record<string, string>;
2030
2358
  /**
2359
+ * @public
2031
2360
  * <p>The name to assign to the VOD source.</p>
2032
2361
  */
2033
2362
  VodSourceName?: string;
@@ -2038,10 +2367,12 @@ export interface CreateVodSourceResponse {
2038
2367
  */
2039
2368
  export interface DashConfigurationForPut {
2040
2369
  /**
2370
+ * @public
2041
2371
  * <p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are <code>DISABLED</code> and <code>EMT_DEFAULT</code>. The <code>EMT_DEFAULT</code> setting enables the inclusion of the tag and is the default value.</p>
2042
2372
  */
2043
2373
  MpdLocation?: string;
2044
2374
  /**
2375
+ * @public
2045
2376
  * <p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to <code>SINGLE_PERIOD</code>. The default setting is <code>MULTI_PERIOD</code>. For multi-period manifests, omit this setting or set it to <code>MULTI_PERIOD</code>.</p>
2046
2377
  */
2047
2378
  OriginManifestType?: OriginManifestType | string;
@@ -2051,10 +2382,12 @@ export interface DashConfigurationForPut {
2051
2382
  */
2052
2383
  export interface DeleteLiveSourceRequest {
2053
2384
  /**
2385
+ * @public
2054
2386
  * <p>The name of the live source.</p>
2055
2387
  */
2056
2388
  LiveSourceName: string | undefined;
2057
2389
  /**
2390
+ * @public
2058
2391
  * <p>The name of the source location associated with this Live Source.</p>
2059
2392
  */
2060
2393
  SourceLocationName: string | undefined;
@@ -2069,6 +2402,7 @@ export interface DeleteLiveSourceResponse {
2069
2402
  */
2070
2403
  export interface DeletePlaybackConfigurationRequest {
2071
2404
  /**
2405
+ * @public
2072
2406
  * <p>The name of the playback configuration.</p>
2073
2407
  */
2074
2408
  Name: string | undefined;
@@ -2083,10 +2417,12 @@ export interface DeletePlaybackConfigurationResponse {
2083
2417
  */
2084
2418
  export interface DeletePrefetchScheduleRequest {
2085
2419
  /**
2420
+ * @public
2086
2421
  * <p>The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.</p>
2087
2422
  */
2088
2423
  Name: string | undefined;
2089
2424
  /**
2425
+ * @public
2090
2426
  * <p>The name of the playback configuration for this prefetch schedule.</p>
2091
2427
  */
2092
2428
  PlaybackConfigurationName: string | undefined;
@@ -2101,6 +2437,7 @@ export interface DeletePrefetchScheduleResponse {
2101
2437
  */
2102
2438
  export interface DeleteSourceLocationRequest {
2103
2439
  /**
2440
+ * @public
2104
2441
  * <p>The name of the source location.</p>
2105
2442
  */
2106
2443
  SourceLocationName: string | undefined;
@@ -2115,10 +2452,12 @@ export interface DeleteSourceLocationResponse {
2115
2452
  */
2116
2453
  export interface DeleteVodSourceRequest {
2117
2454
  /**
2455
+ * @public
2118
2456
  * <p>The name of the source location associated with this VOD Source.</p>
2119
2457
  */
2120
2458
  SourceLocationName: string | undefined;
2121
2459
  /**
2460
+ * @public
2122
2461
  * <p>The name of the VOD source.</p>
2123
2462
  */
2124
2463
  VodSourceName: string | undefined;
@@ -2133,10 +2472,12 @@ export interface DeleteVodSourceResponse {
2133
2472
  */
2134
2473
  export interface DescribeLiveSourceRequest {
2135
2474
  /**
2475
+ * @public
2136
2476
  * <p>The name of the live source.</p>
2137
2477
  */
2138
2478
  LiveSourceName: string | undefined;
2139
2479
  /**
2480
+ * @public
2140
2481
  * <p>The name of the source location associated with this Live Source.</p>
2141
2482
  */
2142
2483
  SourceLocationName: string | undefined;
@@ -2146,30 +2487,37 @@ export interface DescribeLiveSourceRequest {
2146
2487
  */
2147
2488
  export interface DescribeLiveSourceResponse {
2148
2489
  /**
2490
+ * @public
2149
2491
  * <p>The ARN of the live source.</p>
2150
2492
  */
2151
2493
  Arn?: string;
2152
2494
  /**
2495
+ * @public
2153
2496
  * <p>The timestamp that indicates when the live source was created.</p>
2154
2497
  */
2155
2498
  CreationTime?: Date;
2156
2499
  /**
2500
+ * @public
2157
2501
  * <p>The HTTP package configurations.</p>
2158
2502
  */
2159
2503
  HttpPackageConfigurations?: HttpPackageConfiguration[];
2160
2504
  /**
2505
+ * @public
2161
2506
  * <p>The timestamp that indicates when the live source was modified.</p>
2162
2507
  */
2163
2508
  LastModifiedTime?: Date;
2164
2509
  /**
2510
+ * @public
2165
2511
  * <p>The name of the live source.</p>
2166
2512
  */
2167
2513
  LiveSourceName?: string;
2168
2514
  /**
2515
+ * @public
2169
2516
  * <p>The name of the source location associated with the live source.</p>
2170
2517
  */
2171
2518
  SourceLocationName?: string;
2172
2519
  /**
2520
+ * @public
2173
2521
  * <p>The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2174
2522
  */
2175
2523
  Tags?: Record<string, string>;
@@ -2179,6 +2527,7 @@ export interface DescribeLiveSourceResponse {
2179
2527
  */
2180
2528
  export interface DescribeSourceLocationRequest {
2181
2529
  /**
2530
+ * @public
2182
2531
  * <p>The name of the source location.</p>
2183
2532
  */
2184
2533
  SourceLocationName: string | undefined;
@@ -2188,38 +2537,47 @@ export interface DescribeSourceLocationRequest {
2188
2537
  */
2189
2538
  export interface DescribeSourceLocationResponse {
2190
2539
  /**
2540
+ * @public
2191
2541
  * <p>The access configuration for the source location.</p>
2192
2542
  */
2193
2543
  AccessConfiguration?: AccessConfiguration;
2194
2544
  /**
2545
+ * @public
2195
2546
  * <p>The ARN of the source location.</p>
2196
2547
  */
2197
2548
  Arn?: string;
2198
2549
  /**
2550
+ * @public
2199
2551
  * <p>The timestamp that indicates when the source location was created.</p>
2200
2552
  */
2201
2553
  CreationTime?: Date;
2202
2554
  /**
2555
+ * @public
2203
2556
  * <p>The default segment delivery configuration settings.</p>
2204
2557
  */
2205
2558
  DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
2206
2559
  /**
2560
+ * @public
2207
2561
  * <p>The HTTP package configuration settings for the source location.</p>
2208
2562
  */
2209
2563
  HttpConfiguration?: HttpConfiguration;
2210
2564
  /**
2565
+ * @public
2211
2566
  * <p>The timestamp that indicates when the source location was last modified.</p>
2212
2567
  */
2213
2568
  LastModifiedTime?: Date;
2214
2569
  /**
2570
+ * @public
2215
2571
  * <p>A list of the segment delivery configurations associated with this resource.</p>
2216
2572
  */
2217
2573
  SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
2218
2574
  /**
2575
+ * @public
2219
2576
  * <p>The name of the source location.</p>
2220
2577
  */
2221
2578
  SourceLocationName?: string;
2222
2579
  /**
2580
+ * @public
2223
2581
  * <p>The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2224
2582
  */
2225
2583
  Tags?: Record<string, string>;
@@ -2229,10 +2587,12 @@ export interface DescribeSourceLocationResponse {
2229
2587
  */
2230
2588
  export interface DescribeVodSourceRequest {
2231
2589
  /**
2590
+ * @public
2232
2591
  * <p>The name of the source location associated with this VOD Source.</p>
2233
2592
  */
2234
2593
  SourceLocationName: string | undefined;
2235
2594
  /**
2595
+ * @public
2236
2596
  * <p>The name of the VOD Source.</p>
2237
2597
  */
2238
2598
  VodSourceName: string | undefined;
@@ -2242,30 +2602,37 @@ export interface DescribeVodSourceRequest {
2242
2602
  */
2243
2603
  export interface DescribeVodSourceResponse {
2244
2604
  /**
2605
+ * @public
2245
2606
  * <p>The ARN of the VOD source.</p>
2246
2607
  */
2247
2608
  Arn?: string;
2248
2609
  /**
2610
+ * @public
2249
2611
  * <p>The timestamp that indicates when the VOD source was created.</p>
2250
2612
  */
2251
2613
  CreationTime?: Date;
2252
2614
  /**
2615
+ * @public
2253
2616
  * <p>The HTTP package configurations.</p>
2254
2617
  */
2255
2618
  HttpPackageConfigurations?: HttpPackageConfiguration[];
2256
2619
  /**
2620
+ * @public
2257
2621
  * <p>The last modified time of the VOD source.</p>
2258
2622
  */
2259
2623
  LastModifiedTime?: Date;
2260
2624
  /**
2625
+ * @public
2261
2626
  * <p>The name of the source location associated with the VOD source.</p>
2262
2627
  */
2263
2628
  SourceLocationName?: string;
2264
2629
  /**
2630
+ * @public
2265
2631
  * <p>The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2266
2632
  */
2267
2633
  Tags?: Record<string, string>;
2268
2634
  /**
2635
+ * @public
2269
2636
  * <p>The name of the VOD source.</p>
2270
2637
  */
2271
2638
  VodSourceName?: string;
@@ -2275,6 +2642,7 @@ export interface DescribeVodSourceResponse {
2275
2642
  */
2276
2643
  export interface GetPlaybackConfigurationRequest {
2277
2644
  /**
2645
+ * @public
2278
2646
  * <p>The identifier for the playback configuration.</p>
2279
2647
  */
2280
2648
  Name: string | undefined;
@@ -2284,78 +2652,97 @@ export interface GetPlaybackConfigurationRequest {
2284
2652
  */
2285
2653
  export interface GetPlaybackConfigurationResponse {
2286
2654
  /**
2655
+ * @public
2287
2656
  * <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
2288
2657
  */
2289
2658
  AdDecisionServerUrl?: string;
2290
2659
  /**
2660
+ * @public
2291
2661
  * <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
2292
2662
  */
2293
2663
  AvailSuppression?: AvailSuppression;
2294
2664
  /**
2665
+ * @public
2295
2666
  * <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
2296
2667
  */
2297
2668
  Bumper?: Bumper;
2298
2669
  /**
2670
+ * @public
2299
2671
  * <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
2300
2672
  */
2301
2673
  CdnConfiguration?: CdnConfiguration;
2302
2674
  /**
2675
+ * @public
2303
2676
  * <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
2304
2677
  */
2305
2678
  ConfigurationAliases?: Record<string, Record<string, string>>;
2306
2679
  /**
2680
+ * @public
2307
2681
  * <p>The configuration for DASH content.</p>
2308
2682
  */
2309
2683
  DashConfiguration?: DashConfiguration;
2310
2684
  /**
2685
+ * @public
2311
2686
  * <p>The configuration for HLS content.</p>
2312
2687
  */
2313
2688
  HlsConfiguration?: HlsConfiguration;
2314
2689
  /**
2690
+ * @public
2315
2691
  * <p>The configuration for pre-roll ad insertion.</p>
2316
2692
  */
2317
2693
  LivePreRollConfiguration?: LivePreRollConfiguration;
2318
2694
  /**
2695
+ * @public
2319
2696
  * <p>The Amazon CloudWatch log settings for a playback configuration.</p>
2320
2697
  */
2321
2698
  LogConfiguration?: LogConfiguration;
2322
2699
  /**
2700
+ * @public
2323
2701
  * <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
2324
2702
  */
2325
2703
  ManifestProcessingRules?: ManifestProcessingRules;
2326
2704
  /**
2705
+ * @public
2327
2706
  * <p>The identifier for the playback configuration.</p>
2328
2707
  */
2329
2708
  Name?: string;
2330
2709
  /**
2710
+ * @public
2331
2711
  * <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
2332
2712
  */
2333
2713
  PersonalizationThresholdSeconds?: number;
2334
2714
  /**
2715
+ * @public
2335
2716
  * <p>The Amazon Resource Name (ARN) for the playback configuration.</p>
2336
2717
  */
2337
2718
  PlaybackConfigurationArn?: string;
2338
2719
  /**
2720
+ * @public
2339
2721
  * <p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.</p>
2340
2722
  */
2341
2723
  PlaybackEndpointPrefix?: string;
2342
2724
  /**
2725
+ * @public
2343
2726
  * <p>The URL that the player uses to initialize a session that uses client-side reporting.</p>
2344
2727
  */
2345
2728
  SessionInitializationEndpointPrefix?: string;
2346
2729
  /**
2730
+ * @public
2347
2731
  * <p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
2348
2732
  */
2349
2733
  SlateAdUrl?: string;
2350
2734
  /**
2735
+ * @public
2351
2736
  * <p>The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2352
2737
  */
2353
2738
  Tags?: Record<string, string>;
2354
2739
  /**
2740
+ * @public
2355
2741
  * <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
2356
2742
  */
2357
2743
  TranscodeProfileName?: string;
2358
2744
  /**
2745
+ * @public
2359
2746
  * <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
2360
2747
  */
2361
2748
  VideoContentSourceUrl?: string;
@@ -2365,10 +2752,12 @@ export interface GetPlaybackConfigurationResponse {
2365
2752
  */
2366
2753
  export interface GetPrefetchScheduleRequest {
2367
2754
  /**
2755
+ * @public
2368
2756
  * <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
2369
2757
  */
2370
2758
  Name: string | undefined;
2371
2759
  /**
2760
+ * @public
2372
2761
  * <p>Returns information about the prefetch schedule for a specific playback configuration. If you call <code>GetPrefetchSchedule</code> on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.</p>
2373
2762
  */
2374
2763
  PlaybackConfigurationName: string | undefined;
@@ -2378,26 +2767,32 @@ export interface GetPrefetchScheduleRequest {
2378
2767
  */
2379
2768
  export interface GetPrefetchScheduleResponse {
2380
2769
  /**
2770
+ * @public
2381
2771
  * <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
2382
2772
  */
2383
2773
  Arn?: string;
2384
2774
  /**
2775
+ * @public
2385
2776
  * <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
2386
2777
  */
2387
2778
  Consumption?: PrefetchConsumption;
2388
2779
  /**
2780
+ * @public
2389
2781
  * <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
2390
2782
  */
2391
2783
  Name?: string;
2392
2784
  /**
2785
+ * @public
2393
2786
  * <p>The name of the playback configuration to create the prefetch schedule for.</p>
2394
2787
  */
2395
2788
  PlaybackConfigurationName?: string;
2396
2789
  /**
2790
+ * @public
2397
2791
  * <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
2398
2792
  */
2399
2793
  Retrieval?: PrefetchRetrieval;
2400
2794
  /**
2795
+ * @public
2401
2796
  * <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
2402
2797
  */
2403
2798
  StreamId?: string;
@@ -2407,14 +2802,17 @@ export interface GetPrefetchScheduleResponse {
2407
2802
  */
2408
2803
  export interface ListAlertsRequest {
2409
2804
  /**
2805
+ * @public
2410
2806
  * <p>The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> alerts, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
2411
2807
  */
2412
2808
  MaxResults?: number;
2413
2809
  /**
2810
+ * @public
2414
2811
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2415
2812
  */
2416
2813
  NextToken?: string;
2417
2814
  /**
2815
+ * @public
2418
2816
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2419
2817
  */
2420
2818
  ResourceArn: string | undefined;
@@ -2424,10 +2822,12 @@ export interface ListAlertsRequest {
2424
2822
  */
2425
2823
  export interface ListAlertsResponse {
2426
2824
  /**
2825
+ * @public
2427
2826
  * <p>A list of alerts that are associated with this resource.</p>
2428
2827
  */
2429
2828
  Items?: Alert[];
2430
2829
  /**
2830
+ * @public
2431
2831
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2432
2832
  */
2433
2833
  NextToken?: string;
@@ -2437,14 +2837,17 @@ export interface ListAlertsResponse {
2437
2837
  */
2438
2838
  export interface ListLiveSourcesRequest {
2439
2839
  /**
2840
+ * @public
2440
2841
  * <p>The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> live sources, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
2441
2842
  */
2442
2843
  MaxResults?: number;
2443
2844
  /**
2845
+ * @public
2444
2846
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2445
2847
  */
2446
2848
  NextToken?: string;
2447
2849
  /**
2850
+ * @public
2448
2851
  * <p>The name of the source location associated with this Live Sources list.</p>
2449
2852
  */
2450
2853
  SourceLocationName: string | undefined;
@@ -2454,10 +2857,12 @@ export interface ListLiveSourcesRequest {
2454
2857
  */
2455
2858
  export interface ListLiveSourcesResponse {
2456
2859
  /**
2860
+ * @public
2457
2861
  * <p>Lists the live sources.</p>
2458
2862
  */
2459
2863
  Items?: LiveSource[];
2460
2864
  /**
2865
+ * @public
2461
2866
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2462
2867
  */
2463
2868
  NextToken?: string;
@@ -2467,10 +2872,12 @@ export interface ListLiveSourcesResponse {
2467
2872
  */
2468
2873
  export interface ListPlaybackConfigurationsRequest {
2469
2874
  /**
2875
+ * @public
2470
2876
  * <p>The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> playback configurations, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
2471
2877
  */
2472
2878
  MaxResults?: number;
2473
2879
  /**
2880
+ * @public
2474
2881
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2475
2882
  */
2476
2883
  NextToken?: string;
@@ -2480,10 +2887,12 @@ export interface ListPlaybackConfigurationsRequest {
2480
2887
  */
2481
2888
  export interface ListPlaybackConfigurationsResponse {
2482
2889
  /**
2890
+ * @public
2483
2891
  * <p>Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.</p>
2484
2892
  */
2485
2893
  Items?: PlaybackConfiguration[];
2486
2894
  /**
2895
+ * @public
2487
2896
  * <p>Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2488
2897
  */
2489
2898
  NextToken?: string;
@@ -2493,10 +2902,12 @@ export interface ListPlaybackConfigurationsResponse {
2493
2902
  */
2494
2903
  export interface ListPrefetchSchedulesRequest {
2495
2904
  /**
2905
+ * @public
2496
2906
  * <p>The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> prefetch schedules, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
2497
2907
  */
2498
2908
  MaxResults?: number;
2499
2909
  /**
2910
+ * @public
2500
2911
  * <p>(Optional) If the playback configuration has more than <code>MaxResults</code> prefetch schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p>
2501
2912
  * <p> For the first <code>ListPrefetchSchedulesRequest</code> request, omit this value.</p>
2502
2913
  * <p> For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p>
@@ -2504,10 +2915,12 @@ export interface ListPrefetchSchedulesRequest {
2504
2915
  */
2505
2916
  NextToken?: string;
2506
2917
  /**
2918
+ * @public
2507
2919
  * <p>Retrieves the prefetch schedule(s) for a specific playback configuration.</p>
2508
2920
  */
2509
2921
  PlaybackConfigurationName: string | undefined;
2510
2922
  /**
2923
+ * @public
2511
2924
  * <p>An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.</p>
2512
2925
  */
2513
2926
  StreamId?: string;
@@ -2517,10 +2930,12 @@ export interface ListPrefetchSchedulesRequest {
2517
2930
  */
2518
2931
  export interface ListPrefetchSchedulesResponse {
2519
2932
  /**
2933
+ * @public
2520
2934
  * <p>Lists the prefetch schedules. An empty <code>Items</code> list doesn't mean there aren't more items to fetch, just that that page was empty.</p>
2521
2935
  */
2522
2936
  Items?: PrefetchSchedule[];
2523
2937
  /**
2938
+ * @public
2524
2939
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2525
2940
  */
2526
2941
  NextToken?: string;
@@ -2530,10 +2945,12 @@ export interface ListPrefetchSchedulesResponse {
2530
2945
  */
2531
2946
  export interface ListSourceLocationsRequest {
2532
2947
  /**
2948
+ * @public
2533
2949
  * <p> The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> source locations, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
2534
2950
  */
2535
2951
  MaxResults?: number;
2536
2952
  /**
2953
+ * @public
2537
2954
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2538
2955
  */
2539
2956
  NextToken?: string;
@@ -2543,10 +2960,12 @@ export interface ListSourceLocationsRequest {
2543
2960
  */
2544
2961
  export interface ListSourceLocationsResponse {
2545
2962
  /**
2963
+ * @public
2546
2964
  * <p>A list of source locations.</p>
2547
2965
  */
2548
2966
  Items?: SourceLocation[];
2549
2967
  /**
2968
+ * @public
2550
2969
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2551
2970
  */
2552
2971
  NextToken?: string;
@@ -2556,6 +2975,7 @@ export interface ListSourceLocationsResponse {
2556
2975
  */
2557
2976
  export interface ListTagsForResourceRequest {
2558
2977
  /**
2978
+ * @public
2559
2979
  * <p>The Amazon Resource Name (ARN) associated with this resource.</p>
2560
2980
  */
2561
2981
  ResourceArn: string | undefined;
@@ -2565,6 +2985,7 @@ export interface ListTagsForResourceRequest {
2565
2985
  */
2566
2986
  export interface ListTagsForResourceResponse {
2567
2987
  /**
2988
+ * @public
2568
2989
  * <p>The tags associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2569
2990
  */
2570
2991
  Tags?: Record<string, string>;
@@ -2574,14 +2995,17 @@ export interface ListTagsForResourceResponse {
2574
2995
  */
2575
2996
  export interface ListVodSourcesRequest {
2576
2997
  /**
2998
+ * @public
2577
2999
  * <p> The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> VOD sources, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
2578
3000
  */
2579
3001
  MaxResults?: number;
2580
3002
  /**
3003
+ * @public
2581
3004
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2582
3005
  */
2583
3006
  NextToken?: string;
2584
3007
  /**
3008
+ * @public
2585
3009
  * <p>The name of the source location associated with this VOD Source list.</p>
2586
3010
  */
2587
3011
  SourceLocationName: string | undefined;
@@ -2591,10 +3015,12 @@ export interface ListVodSourcesRequest {
2591
3015
  */
2592
3016
  export interface ListVodSourcesResponse {
2593
3017
  /**
3018
+ * @public
2594
3019
  * <p>Lists the VOD sources.</p>
2595
3020
  */
2596
3021
  Items?: VodSource[];
2597
3022
  /**
3023
+ * @public
2598
3024
  * <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
2599
3025
  */
2600
3026
  NextToken?: string;
@@ -2604,14 +3030,17 @@ export interface ListVodSourcesResponse {
2604
3030
  */
2605
3031
  export interface UpdateLiveSourceRequest {
2606
3032
  /**
3033
+ * @public
2607
3034
  * <p>A list of HTTP package configurations for the live source on this account.</p>
2608
3035
  */
2609
3036
  HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
2610
3037
  /**
3038
+ * @public
2611
3039
  * <p>The name of the live source.</p>
2612
3040
  */
2613
3041
  LiveSourceName: string | undefined;
2614
3042
  /**
3043
+ * @public
2615
3044
  * <p>The name of the source location associated with this Live Source.</p>
2616
3045
  */
2617
3046
  SourceLocationName: string | undefined;
@@ -2621,30 +3050,37 @@ export interface UpdateLiveSourceRequest {
2621
3050
  */
2622
3051
  export interface UpdateLiveSourceResponse {
2623
3052
  /**
3053
+ * @public
2624
3054
  * <p>The Amazon Resource Name (ARN) associated with this live source.</p>
2625
3055
  */
2626
3056
  Arn?: string;
2627
3057
  /**
3058
+ * @public
2628
3059
  * <p>The timestamp that indicates when the live source was created.</p>
2629
3060
  */
2630
3061
  CreationTime?: Date;
2631
3062
  /**
3063
+ * @public
2632
3064
  * <p>A list of HTTP package configurations for the live source on this account.</p>
2633
3065
  */
2634
3066
  HttpPackageConfigurations?: HttpPackageConfiguration[];
2635
3067
  /**
3068
+ * @public
2636
3069
  * <p>The timestamp that indicates when the live source was last modified.</p>
2637
3070
  */
2638
3071
  LastModifiedTime?: Date;
2639
3072
  /**
3073
+ * @public
2640
3074
  * <p>The name of the live source.</p>
2641
3075
  */
2642
3076
  LiveSourceName?: string;
2643
3077
  /**
3078
+ * @public
2644
3079
  * <p>The name of the source location associated with the live source.</p>
2645
3080
  */
2646
3081
  SourceLocationName?: string;
2647
3082
  /**
3083
+ * @public
2648
3084
  * <p>The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2649
3085
  */
2650
3086
  Tags?: Record<string, string>;
@@ -2654,58 +3090,72 @@ export interface UpdateLiveSourceResponse {
2654
3090
  */
2655
3091
  export interface PutPlaybackConfigurationRequest {
2656
3092
  /**
3093
+ * @public
2657
3094
  * <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
2658
3095
  */
2659
3096
  AdDecisionServerUrl?: string;
2660
3097
  /**
3098
+ * @public
2661
3099
  * <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
2662
3100
  */
2663
3101
  AvailSuppression?: AvailSuppression;
2664
3102
  /**
3103
+ * @public
2665
3104
  * <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
2666
3105
  */
2667
3106
  Bumper?: Bumper;
2668
3107
  /**
3108
+ * @public
2669
3109
  * <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
2670
3110
  */
2671
3111
  CdnConfiguration?: CdnConfiguration;
2672
3112
  /**
3113
+ * @public
2673
3114
  * <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
2674
3115
  */
2675
3116
  ConfigurationAliases?: Record<string, Record<string, string>>;
2676
3117
  /**
3118
+ * @public
2677
3119
  * <p>The configuration for DASH content.</p>
2678
3120
  */
2679
3121
  DashConfiguration?: DashConfigurationForPut;
2680
3122
  /**
3123
+ * @public
2681
3124
  * <p>The configuration for pre-roll ad insertion.</p>
2682
3125
  */
2683
3126
  LivePreRollConfiguration?: LivePreRollConfiguration;
2684
3127
  /**
3128
+ * @public
2685
3129
  * <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
2686
3130
  */
2687
3131
  ManifestProcessingRules?: ManifestProcessingRules;
2688
3132
  /**
3133
+ * @public
2689
3134
  * <p>The identifier for the playback configuration.</p>
2690
3135
  */
2691
3136
  Name: string | undefined;
2692
3137
  /**
3138
+ * @public
2693
3139
  * <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
2694
3140
  */
2695
3141
  PersonalizationThresholdSeconds?: number;
2696
3142
  /**
3143
+ * @public
2697
3144
  * <p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
2698
3145
  */
2699
3146
  SlateAdUrl?: string;
2700
3147
  /**
3148
+ * @public
2701
3149
  * <p>The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2702
3150
  */
2703
3151
  Tags?: Record<string, string>;
2704
3152
  /**
3153
+ * @public
2705
3154
  * <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
2706
3155
  */
2707
3156
  TranscodeProfileName?: string;
2708
3157
  /**
3158
+ * @public
2709
3159
  * <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
2710
3160
  */
2711
3161
  VideoContentSourceUrl?: string;
@@ -2715,78 +3165,97 @@ export interface PutPlaybackConfigurationRequest {
2715
3165
  */
2716
3166
  export interface PutPlaybackConfigurationResponse {
2717
3167
  /**
3168
+ * @public
2718
3169
  * <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
2719
3170
  */
2720
3171
  AdDecisionServerUrl?: string;
2721
3172
  /**
3173
+ * @public
2722
3174
  * <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
2723
3175
  */
2724
3176
  AvailSuppression?: AvailSuppression;
2725
3177
  /**
3178
+ * @public
2726
3179
  * <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
2727
3180
  */
2728
3181
  Bumper?: Bumper;
2729
3182
  /**
3183
+ * @public
2730
3184
  * <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
2731
3185
  */
2732
3186
  CdnConfiguration?: CdnConfiguration;
2733
3187
  /**
3188
+ * @public
2734
3189
  * <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
2735
3190
  */
2736
3191
  ConfigurationAliases?: Record<string, Record<string, string>>;
2737
3192
  /**
3193
+ * @public
2738
3194
  * <p>The configuration for DASH content.</p>
2739
3195
  */
2740
3196
  DashConfiguration?: DashConfiguration;
2741
3197
  /**
3198
+ * @public
2742
3199
  * <p>The configuration for HLS content.</p>
2743
3200
  */
2744
3201
  HlsConfiguration?: HlsConfiguration;
2745
3202
  /**
3203
+ * @public
2746
3204
  * <p>The configuration for pre-roll ad insertion.</p>
2747
3205
  */
2748
3206
  LivePreRollConfiguration?: LivePreRollConfiguration;
2749
3207
  /**
3208
+ * @public
2750
3209
  * <p>The Amazon CloudWatch log settings for a playback configuration.</p>
2751
3210
  */
2752
3211
  LogConfiguration?: LogConfiguration;
2753
3212
  /**
3213
+ * @public
2754
3214
  * <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
2755
3215
  */
2756
3216
  ManifestProcessingRules?: ManifestProcessingRules;
2757
3217
  /**
3218
+ * @public
2758
3219
  * <p>The identifier for the playback configuration.</p>
2759
3220
  */
2760
3221
  Name?: string;
2761
3222
  /**
3223
+ * @public
2762
3224
  * <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
2763
3225
  */
2764
3226
  PersonalizationThresholdSeconds?: number;
2765
3227
  /**
3228
+ * @public
2766
3229
  * <p>The Amazon Resource Name (ARN) associated with the playback configuration.</p>
2767
3230
  */
2768
3231
  PlaybackConfigurationArn?: string;
2769
3232
  /**
3233
+ * @public
2770
3234
  * <p>The playback endpoint prefix associated with the playback configuration.</p>
2771
3235
  */
2772
3236
  PlaybackEndpointPrefix?: string;
2773
3237
  /**
3238
+ * @public
2774
3239
  * <p>The session initialization endpoint prefix associated with the playback configuration.</p>
2775
3240
  */
2776
3241
  SessionInitializationEndpointPrefix?: string;
2777
3242
  /**
3243
+ * @public
2778
3244
  * <p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
2779
3245
  */
2780
3246
  SlateAdUrl?: string;
2781
3247
  /**
3248
+ * @public
2782
3249
  * <p>The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2783
3250
  */
2784
3251
  Tags?: Record<string, string>;
2785
3252
  /**
3253
+ * @public
2786
3254
  * <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
2787
3255
  */
2788
3256
  TranscodeProfileName?: string;
2789
3257
  /**
3258
+ * @public
2790
3259
  * <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
2791
3260
  */
2792
3261
  VideoContentSourceUrl?: string;
@@ -2796,22 +3265,27 @@ export interface PutPlaybackConfigurationResponse {
2796
3265
  */
2797
3266
  export interface UpdateSourceLocationRequest {
2798
3267
  /**
3268
+ * @public
2799
3269
  * <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
2800
3270
  */
2801
3271
  AccessConfiguration?: AccessConfiguration;
2802
3272
  /**
3273
+ * @public
2803
3274
  * <p>The optional configuration for the host server that serves segments.</p>
2804
3275
  */
2805
3276
  DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
2806
3277
  /**
3278
+ * @public
2807
3279
  * <p>The HTTP configuration for the source location.</p>
2808
3280
  */
2809
3281
  HttpConfiguration: HttpConfiguration | undefined;
2810
3282
  /**
3283
+ * @public
2811
3284
  * <p>A list of the segment delivery configurations associated with this resource.</p>
2812
3285
  */
2813
3286
  SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
2814
3287
  /**
3288
+ * @public
2815
3289
  * <p>The name of the source location.</p>
2816
3290
  */
2817
3291
  SourceLocationName: string | undefined;
@@ -2821,38 +3295,47 @@ export interface UpdateSourceLocationRequest {
2821
3295
  */
2822
3296
  export interface UpdateSourceLocationResponse {
2823
3297
  /**
3298
+ * @public
2824
3299
  * <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
2825
3300
  */
2826
3301
  AccessConfiguration?: AccessConfiguration;
2827
3302
  /**
3303
+ * @public
2828
3304
  * <p>The Amazon Resource Name (ARN) associated with the source location.</p>
2829
3305
  */
2830
3306
  Arn?: string;
2831
3307
  /**
3308
+ * @public
2832
3309
  * <p>The timestamp that indicates when the source location was created.</p>
2833
3310
  */
2834
3311
  CreationTime?: Date;
2835
3312
  /**
3313
+ * @public
2836
3314
  * <p>The optional configuration for the host server that serves segments.</p>
2837
3315
  */
2838
3316
  DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
2839
3317
  /**
3318
+ * @public
2840
3319
  * <p>The HTTP configuration for the source location.</p>
2841
3320
  */
2842
3321
  HttpConfiguration?: HttpConfiguration;
2843
3322
  /**
3323
+ * @public
2844
3324
  * <p>The timestamp that indicates when the source location was last modified.</p>
2845
3325
  */
2846
3326
  LastModifiedTime?: Date;
2847
3327
  /**
3328
+ * @public
2848
3329
  * <p>The segment delivery configurations for the source location. For information about MediaTailor configurations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html">Working with configurations in AWS Elemental MediaTailor</a>.</p>
2849
3330
  */
2850
3331
  SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
2851
3332
  /**
3333
+ * @public
2852
3334
  * <p>The name of the source location.</p>
2853
3335
  */
2854
3336
  SourceLocationName?: string;
2855
3337
  /**
3338
+ * @public
2856
3339
  * <p>The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2857
3340
  */
2858
3341
  Tags?: Record<string, string>;
@@ -2862,10 +3345,12 @@ export interface UpdateSourceLocationResponse {
2862
3345
  */
2863
3346
  export interface TagResourceRequest {
2864
3347
  /**
3348
+ * @public
2865
3349
  * <p>The Amazon Resource Name (ARN) associated with the resource.</p>
2866
3350
  */
2867
3351
  ResourceArn: string | undefined;
2868
3352
  /**
3353
+ * @public
2869
3354
  * <p>The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2870
3355
  */
2871
3356
  Tags: Record<string, string> | undefined;
@@ -2875,10 +3360,12 @@ export interface TagResourceRequest {
2875
3360
  */
2876
3361
  export interface UntagResourceRequest {
2877
3362
  /**
3363
+ * @public
2878
3364
  * <p>The Amazon Resource Name (ARN) of the resource to untag.</p>
2879
3365
  */
2880
3366
  ResourceArn: string | undefined;
2881
3367
  /**
3368
+ * @public
2882
3369
  * <p>The tag keys associated with the resource.</p>
2883
3370
  */
2884
3371
  TagKeys: string[] | undefined;
@@ -2888,14 +3375,17 @@ export interface UntagResourceRequest {
2888
3375
  */
2889
3376
  export interface UpdateVodSourceRequest {
2890
3377
  /**
3378
+ * @public
2891
3379
  * <p>A list of HTTP package configurations for the VOD source on this account.</p>
2892
3380
  */
2893
3381
  HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
2894
3382
  /**
3383
+ * @public
2895
3384
  * <p>The name of the source location associated with this VOD Source.</p>
2896
3385
  */
2897
3386
  SourceLocationName: string | undefined;
2898
3387
  /**
3388
+ * @public
2899
3389
  * <p>The name of the VOD source.</p>
2900
3390
  */
2901
3391
  VodSourceName: string | undefined;
@@ -2905,30 +3395,37 @@ export interface UpdateVodSourceRequest {
2905
3395
  */
2906
3396
  export interface UpdateVodSourceResponse {
2907
3397
  /**
3398
+ * @public
2908
3399
  * <p>The Amazon Resource Name (ARN) associated with the VOD source.</p>
2909
3400
  */
2910
3401
  Arn?: string;
2911
3402
  /**
3403
+ * @public
2912
3404
  * <p>The timestamp that indicates when the VOD source was created.</p>
2913
3405
  */
2914
3406
  CreationTime?: Date;
2915
3407
  /**
3408
+ * @public
2916
3409
  * <p>A list of HTTP package configurations for the VOD source on this account.</p>
2917
3410
  */
2918
3411
  HttpPackageConfigurations?: HttpPackageConfiguration[];
2919
3412
  /**
3413
+ * @public
2920
3414
  * <p>The timestamp that indicates when the VOD source was last modified.</p>
2921
3415
  */
2922
3416
  LastModifiedTime?: Date;
2923
3417
  /**
3418
+ * @public
2924
3419
  * <p>The name of the source location associated with the VOD source.</p>
2925
3420
  */
2926
3421
  SourceLocationName?: string;
2927
3422
  /**
3423
+ * @public
2928
3424
  * <p>The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
2929
3425
  */
2930
3426
  Tags?: Record<string, string>;
2931
3427
  /**
3428
+ * @public
2932
3429
  * <p>The name of the VOD source.</p>
2933
3430
  */
2934
3431
  VodSourceName?: string;