@aws-sdk/client-mediatailor 3.295.0 → 3.297.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.
- package/dist-types/MediaTailor.d.ts +45 -0
- package/dist-types/MediaTailorClient.d.ts +24 -4
- package/dist-types/commands/ConfigureLogsForChannelCommand.d.ts +16 -0
- package/dist-types/commands/ConfigureLogsForPlaybackConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +16 -0
- package/dist-types/commands/CreateLiveSourceCommand.d.ts +16 -0
- package/dist-types/commands/CreatePrefetchScheduleCommand.d.ts +16 -0
- package/dist-types/commands/CreateProgramCommand.d.ts +16 -0
- package/dist-types/commands/CreateSourceLocationCommand.d.ts +16 -0
- package/dist-types/commands/CreateVodSourceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelPolicyCommand.d.ts +16 -0
- package/dist-types/commands/DeleteLiveSourceCommand.d.ts +16 -0
- package/dist-types/commands/DeletePlaybackConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/DeletePrefetchScheduleCommand.d.ts +16 -0
- package/dist-types/commands/DeleteProgramCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSourceLocationCommand.d.ts +16 -0
- package/dist-types/commands/DeleteVodSourceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelCommand.d.ts +16 -0
- package/dist-types/commands/DescribeLiveSourceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeProgramCommand.d.ts +16 -0
- package/dist-types/commands/DescribeSourceLocationCommand.d.ts +16 -0
- package/dist-types/commands/DescribeVodSourceCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelPolicyCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelScheduleCommand.d.ts +16 -0
- package/dist-types/commands/GetPlaybackConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/GetPrefetchScheduleCommand.d.ts +16 -0
- package/dist-types/commands/ListAlertsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListLiveSourcesCommand.d.ts +16 -0
- package/dist-types/commands/ListPlaybackConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/ListPrefetchSchedulesCommand.d.ts +16 -0
- package/dist-types/commands/ListSourceLocationsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ListVodSourcesCommand.d.ts +16 -0
- package/dist-types/commands/PutChannelPolicyCommand.d.ts +16 -0
- package/dist-types/commands/PutPlaybackConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/StartChannelCommand.d.ts +16 -0
- package/dist-types/commands/StopChannelCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
- package/dist-types/commands/UpdateLiveSourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateProgramCommand.d.ts +16 -0
- package/dist-types/commands/UpdateSourceLocationCommand.d.ts +16 -0
- package/dist-types/commands/UpdateVodSourceCommand.d.ts +16 -0
- package/dist-types/models/MediaTailorServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +336 -0
- package/dist-types/pagination/GetChannelSchedulePaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAlertsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListLiveSourcesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListPlaybackConfigurationsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListPrefetchSchedulesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSourceLocationsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListVodSourcesPaginator.d.ts +3 -0
- package/package.json +29 -29
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { MediaTailorServiceException as __BaseException } from "./MediaTailorServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
3
6
|
export declare enum MessageType {
|
|
4
7
|
SPLICE_INSERT = "SPLICE_INSERT",
|
|
5
8
|
TIME_SIGNAL = "TIME_SIGNAL"
|
|
6
9
|
}
|
|
7
10
|
/**
|
|
11
|
+
* @public
|
|
8
12
|
* <p>Slate VOD source configuration.</p>
|
|
9
13
|
*/
|
|
10
14
|
export interface SlateSource {
|
|
@@ -18,6 +22,7 @@ export interface SlateSource {
|
|
|
18
22
|
VodSourceName?: string;
|
|
19
23
|
}
|
|
20
24
|
/**
|
|
25
|
+
* @public
|
|
21
26
|
* <p>Splice insert message configuration.</p>
|
|
22
27
|
*/
|
|
23
28
|
export interface SpliceInsertMessage {
|
|
@@ -39,6 +44,7 @@ export interface SpliceInsertMessage {
|
|
|
39
44
|
UniqueProgramId?: number;
|
|
40
45
|
}
|
|
41
46
|
/**
|
|
47
|
+
* @public
|
|
42
48
|
* <p>The <code>segmentation_descriptor</code> message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the <code>EXT-X-DATERANGE</code> or <code>EventStream</code> ad marker's SCTE-35 data.</p>
|
|
43
49
|
* <p>
|
|
44
50
|
* <code>segmentation_descriptor</code> messages must be sent with the <code>time_signal</code> message type.</p>
|
|
@@ -79,6 +85,7 @@ export interface SegmentationDescriptor {
|
|
|
79
85
|
SubSegmentsExpected?: number;
|
|
80
86
|
}
|
|
81
87
|
/**
|
|
88
|
+
* @public
|
|
82
89
|
* <p>The SCTE-35 <code>time_signal</code> message can be sent with one or more <code>segmentation_descriptor</code> messages. A <code>time_signal</code> message can be sent only if a single <code>segmentation_descriptor</code> message is sent.</p>
|
|
83
90
|
* <p>The <code>time_signal</code> message contains only the <code>splice_time</code> field which is constructed using a given presentation timestamp. When sending a <code>time_signal</code> message, the <code>splice_command_type</code> field in the <code>splice_info_section</code> message is set to 6 (0x06).</p>
|
|
84
91
|
* <p>See the <code>time_signal()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
@@ -90,6 +97,7 @@ export interface TimeSignalMessage {
|
|
|
90
97
|
SegmentationDescriptors?: SegmentationDescriptor[];
|
|
91
98
|
}
|
|
92
99
|
/**
|
|
100
|
+
* @public
|
|
93
101
|
* <p>Ad break configuration parameters.</p>
|
|
94
102
|
*/
|
|
95
103
|
export interface AdBreak {
|
|
@@ -117,6 +125,7 @@ export interface AdBreak {
|
|
|
117
125
|
TimeSignalMessage?: TimeSignalMessage;
|
|
118
126
|
}
|
|
119
127
|
/**
|
|
128
|
+
* @public
|
|
120
129
|
* <p>Alert configuration parameters.</p>
|
|
121
130
|
*/
|
|
122
131
|
export interface Alert {
|
|
@@ -141,10 +150,14 @@ export interface Alert {
|
|
|
141
150
|
*/
|
|
142
151
|
ResourceArn: string | undefined;
|
|
143
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
144
156
|
export declare enum Operator {
|
|
145
157
|
EQUALS = "EQUALS"
|
|
146
158
|
}
|
|
147
159
|
/**
|
|
160
|
+
* @public
|
|
148
161
|
* <p>MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.</p>
|
|
149
162
|
* <p>As an example, let's say that you set <code>DynamicVariable</code> to <code>scte.event_id</code> and <code>Operator</code> to <code>EQUALS</code>, and your playback configuration has an ADS URL of <code>https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]</code>. And the prefetch request to the ADS contains these values <code>https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30</code>. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of <code>my-awesome-event</code>, since it must match the event id that MediaTailor uses to query the ADS.</p>
|
|
150
163
|
* <p>You can specify up to five <code>AvailMatchingCriteria</code>. If you specify multiple <code>AvailMatchingCriteria</code>, MediaTailor combines them to match using a logical <code>AND</code>. You can model logical <code>OR</code> combinations by creating multiple prefetch schedules.</p>
|
|
@@ -160,10 +173,14 @@ export interface AvailMatchingCriteria {
|
|
|
160
173
|
*/
|
|
161
174
|
Operator: Operator | string | undefined;
|
|
162
175
|
}
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
163
179
|
export declare enum LogType {
|
|
164
180
|
AS_RUN = "AS_RUN"
|
|
165
181
|
}
|
|
166
182
|
/**
|
|
183
|
+
* @public
|
|
167
184
|
* <p>The log configuration for the channel.</p>
|
|
168
185
|
*/
|
|
169
186
|
export interface LogConfigurationForChannel {
|
|
@@ -173,6 +190,7 @@ export interface LogConfigurationForChannel {
|
|
|
173
190
|
LogTypes?: (LogType | string)[];
|
|
174
191
|
}
|
|
175
192
|
/**
|
|
193
|
+
* @public
|
|
176
194
|
* <p>Dash manifest configuration parameters.</p>
|
|
177
195
|
*/
|
|
178
196
|
export interface DashPlaylistSettings {
|
|
@@ -194,6 +212,7 @@ export interface DashPlaylistSettings {
|
|
|
194
212
|
SuggestedPresentationDelaySeconds?: number;
|
|
195
213
|
}
|
|
196
214
|
/**
|
|
215
|
+
* @public
|
|
197
216
|
* <p>HLS playlist configuration parameters.</p>
|
|
198
217
|
*/
|
|
199
218
|
export interface HlsPlaylistSettings {
|
|
@@ -203,6 +222,7 @@ export interface HlsPlaylistSettings {
|
|
|
203
222
|
ManifestWindowSeconds?: number;
|
|
204
223
|
}
|
|
205
224
|
/**
|
|
225
|
+
* @public
|
|
206
226
|
* <p>The output item response.</p>
|
|
207
227
|
*/
|
|
208
228
|
export interface ResponseOutputItem {
|
|
@@ -228,6 +248,7 @@ export interface ResponseOutputItem {
|
|
|
228
248
|
SourceGroup: string | undefined;
|
|
229
249
|
}
|
|
230
250
|
/**
|
|
251
|
+
* @public
|
|
231
252
|
* <p>The configuration parameters for a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with channels</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
232
253
|
*/
|
|
233
254
|
export interface Channel {
|
|
@@ -282,11 +303,15 @@ export interface Channel {
|
|
|
282
303
|
*/
|
|
283
304
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
284
305
|
}
|
|
306
|
+
/**
|
|
307
|
+
* @public
|
|
308
|
+
*/
|
|
285
309
|
export declare enum Type {
|
|
286
310
|
DASH = "DASH",
|
|
287
311
|
HLS = "HLS"
|
|
288
312
|
}
|
|
289
313
|
/**
|
|
314
|
+
* @public
|
|
290
315
|
* <p>The HTTP package configuration properties for the requested VOD source.</p>
|
|
291
316
|
*/
|
|
292
317
|
export interface HttpPackageConfiguration {
|
|
@@ -304,6 +329,7 @@ export interface HttpPackageConfiguration {
|
|
|
304
329
|
Type: Type | string | undefined;
|
|
305
330
|
}
|
|
306
331
|
/**
|
|
332
|
+
* @public
|
|
307
333
|
* <p>Live source configuration parameters.</p>
|
|
308
334
|
*/
|
|
309
335
|
export interface LiveSource {
|
|
@@ -336,11 +362,15 @@ export interface LiveSource {
|
|
|
336
362
|
*/
|
|
337
363
|
Tags?: Record<string, string>;
|
|
338
364
|
}
|
|
365
|
+
/**
|
|
366
|
+
* @public
|
|
367
|
+
*/
|
|
339
368
|
export declare enum Mode {
|
|
340
369
|
BEHIND_LIVE_EDGE = "BEHIND_LIVE_EDGE",
|
|
341
370
|
OFF = "OFF"
|
|
342
371
|
}
|
|
343
372
|
/**
|
|
373
|
+
* @public
|
|
344
374
|
* <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>
|
|
345
375
|
*/
|
|
346
376
|
export interface AvailSuppression {
|
|
@@ -354,6 +384,7 @@ export interface AvailSuppression {
|
|
|
354
384
|
Value?: string;
|
|
355
385
|
}
|
|
356
386
|
/**
|
|
387
|
+
* @public
|
|
357
388
|
* <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>
|
|
358
389
|
*/
|
|
359
390
|
export interface Bumper {
|
|
@@ -367,6 +398,7 @@ export interface Bumper {
|
|
|
367
398
|
StartUrl?: string;
|
|
368
399
|
}
|
|
369
400
|
/**
|
|
401
|
+
* @public
|
|
370
402
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
371
403
|
*/
|
|
372
404
|
export interface CdnConfiguration {
|
|
@@ -379,11 +411,15 @@ export interface CdnConfiguration {
|
|
|
379
411
|
*/
|
|
380
412
|
ContentSegmentUrlPrefix?: string;
|
|
381
413
|
}
|
|
414
|
+
/**
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
382
417
|
export declare enum OriginManifestType {
|
|
383
418
|
MULTI_PERIOD = "MULTI_PERIOD",
|
|
384
419
|
SINGLE_PERIOD = "SINGLE_PERIOD"
|
|
385
420
|
}
|
|
386
421
|
/**
|
|
422
|
+
* @public
|
|
387
423
|
* <p>The configuration for DASH content.</p>
|
|
388
424
|
*/
|
|
389
425
|
export interface DashConfiguration {
|
|
@@ -401,6 +437,7 @@ export interface DashConfiguration {
|
|
|
401
437
|
OriginManifestType?: OriginManifestType | string;
|
|
402
438
|
}
|
|
403
439
|
/**
|
|
440
|
+
* @public
|
|
404
441
|
* <p>The configuration for HLS content.</p>
|
|
405
442
|
*/
|
|
406
443
|
export interface HlsConfiguration {
|
|
@@ -410,6 +447,7 @@ export interface HlsConfiguration {
|
|
|
410
447
|
ManifestEndpointPrefix?: string;
|
|
411
448
|
}
|
|
412
449
|
/**
|
|
450
|
+
* @public
|
|
413
451
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
414
452
|
*/
|
|
415
453
|
export interface LivePreRollConfiguration {
|
|
@@ -423,6 +461,7 @@ export interface LivePreRollConfiguration {
|
|
|
423
461
|
MaxDurationSeconds?: number;
|
|
424
462
|
}
|
|
425
463
|
/**
|
|
464
|
+
* @public
|
|
426
465
|
* <p>Returns Amazon CloudWatch log settings for a playback configuration.</p>
|
|
427
466
|
*/
|
|
428
467
|
export interface LogConfiguration {
|
|
@@ -434,6 +473,7 @@ export interface LogConfiguration {
|
|
|
434
473
|
PercentEnabled: number | undefined;
|
|
435
474
|
}
|
|
436
475
|
/**
|
|
476
|
+
* @public
|
|
437
477
|
* <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>
|
|
438
478
|
* <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>
|
|
439
479
|
*/
|
|
@@ -444,6 +484,7 @@ export interface AdMarkerPassthrough {
|
|
|
444
484
|
Enabled?: boolean;
|
|
445
485
|
}
|
|
446
486
|
/**
|
|
487
|
+
* @public
|
|
447
488
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
448
489
|
*/
|
|
449
490
|
export interface ManifestProcessingRules {
|
|
@@ -454,6 +495,7 @@ export interface ManifestProcessingRules {
|
|
|
454
495
|
AdMarkerPassthrough?: AdMarkerPassthrough;
|
|
455
496
|
}
|
|
456
497
|
/**
|
|
498
|
+
* @public
|
|
457
499
|
* <p>A playback configuration. 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>
|
|
458
500
|
*/
|
|
459
501
|
export interface PlaybackConfiguration {
|
|
@@ -535,6 +577,7 @@ export interface PlaybackConfiguration {
|
|
|
535
577
|
VideoContentSourceUrl?: string;
|
|
536
578
|
}
|
|
537
579
|
/**
|
|
580
|
+
* @public
|
|
538
581
|
* <p>A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.</p>
|
|
539
582
|
*/
|
|
540
583
|
export interface PrefetchConsumption {
|
|
@@ -552,6 +595,7 @@ export interface PrefetchConsumption {
|
|
|
552
595
|
StartTime?: Date;
|
|
553
596
|
}
|
|
554
597
|
/**
|
|
598
|
+
* @public
|
|
555
599
|
* <p>A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.</p>
|
|
556
600
|
*/
|
|
557
601
|
export interface PrefetchRetrieval {
|
|
@@ -570,6 +614,7 @@ export interface PrefetchRetrieval {
|
|
|
570
614
|
StartTime?: Date;
|
|
571
615
|
}
|
|
572
616
|
/**
|
|
617
|
+
* @public
|
|
573
618
|
* <p>A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
574
619
|
*/
|
|
575
620
|
export interface PrefetchSchedule {
|
|
@@ -599,6 +644,7 @@ export interface PrefetchSchedule {
|
|
|
599
644
|
StreamId?: string;
|
|
600
645
|
}
|
|
601
646
|
/**
|
|
647
|
+
* @public
|
|
602
648
|
* <p>The schedule's ad break properties.</p>
|
|
603
649
|
*/
|
|
604
650
|
export interface ScheduleAdBreak {
|
|
@@ -619,11 +665,15 @@ export interface ScheduleAdBreak {
|
|
|
619
665
|
*/
|
|
620
666
|
VodSourceName?: string;
|
|
621
667
|
}
|
|
668
|
+
/**
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
622
671
|
export declare enum ScheduleEntryType {
|
|
623
672
|
FILLER_SLATE = "FILLER_SLATE",
|
|
624
673
|
PROGRAM = "PROGRAM"
|
|
625
674
|
}
|
|
626
675
|
/**
|
|
676
|
+
* @public
|
|
627
677
|
* <p>The properties for a schedule.</p>
|
|
628
678
|
*/
|
|
629
679
|
export interface ScheduleEntry {
|
|
@@ -669,6 +719,7 @@ export interface ScheduleEntry {
|
|
|
669
719
|
VodSourceName?: string;
|
|
670
720
|
}
|
|
671
721
|
/**
|
|
722
|
+
* @public
|
|
672
723
|
* <p>The segment delivery configuration settings.</p>
|
|
673
724
|
*/
|
|
674
725
|
export interface SegmentDeliveryConfiguration {
|
|
@@ -681,11 +732,15 @@ export interface SegmentDeliveryConfiguration {
|
|
|
681
732
|
*/
|
|
682
733
|
Name?: string;
|
|
683
734
|
}
|
|
735
|
+
/**
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
684
738
|
export declare enum AccessType {
|
|
685
739
|
S3_SIGV4 = "S3_SIGV4",
|
|
686
740
|
SECRETS_MANAGER_ACCESS_TOKEN = "SECRETS_MANAGER_ACCESS_TOKEN"
|
|
687
741
|
}
|
|
688
742
|
/**
|
|
743
|
+
* @public
|
|
689
744
|
* <p>AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html">Working with AWS Secrets Manager access token authentication</a>.</p>
|
|
690
745
|
*/
|
|
691
746
|
export interface SecretsManagerAccessTokenConfiguration {
|
|
@@ -703,6 +758,7 @@ export interface SecretsManagerAccessTokenConfiguration {
|
|
|
703
758
|
SecretStringKey?: string;
|
|
704
759
|
}
|
|
705
760
|
/**
|
|
761
|
+
* @public
|
|
706
762
|
* <p>Access configuration parameters.</p>
|
|
707
763
|
*/
|
|
708
764
|
export interface AccessConfiguration {
|
|
@@ -722,6 +778,7 @@ export interface AccessConfiguration {
|
|
|
722
778
|
SecretsManagerAccessTokenConfiguration?: SecretsManagerAccessTokenConfiguration;
|
|
723
779
|
}
|
|
724
780
|
/**
|
|
781
|
+
* @public
|
|
725
782
|
* <p>The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.</p>
|
|
726
783
|
*/
|
|
727
784
|
export interface DefaultSegmentDeliveryConfiguration {
|
|
@@ -731,6 +788,7 @@ export interface DefaultSegmentDeliveryConfiguration {
|
|
|
731
788
|
BaseUrl?: string;
|
|
732
789
|
}
|
|
733
790
|
/**
|
|
791
|
+
* @public
|
|
734
792
|
* <p>The HTTP configuration for the source location.</p>
|
|
735
793
|
*/
|
|
736
794
|
export interface HttpConfiguration {
|
|
@@ -740,6 +798,7 @@ export interface HttpConfiguration {
|
|
|
740
798
|
BaseUrl: string | undefined;
|
|
741
799
|
}
|
|
742
800
|
/**
|
|
801
|
+
* @public
|
|
743
802
|
* <p>A source location is a container for sources. For more information about source locations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html">Working with source locations</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
744
803
|
*/
|
|
745
804
|
export interface SourceLocation {
|
|
@@ -781,6 +840,7 @@ export interface SourceLocation {
|
|
|
781
840
|
Tags?: Record<string, string>;
|
|
782
841
|
}
|
|
783
842
|
/**
|
|
843
|
+
* @public
|
|
784
844
|
* <p>VOD source configuration parameters.</p>
|
|
785
845
|
*/
|
|
786
846
|
export interface VodSource {
|
|
@@ -814,6 +874,7 @@ export interface VodSource {
|
|
|
814
874
|
VodSourceName: string | undefined;
|
|
815
875
|
}
|
|
816
876
|
/**
|
|
877
|
+
* @public
|
|
817
878
|
* <p>A request contains unexpected data.</p>
|
|
818
879
|
*/
|
|
819
880
|
export declare class BadRequestException extends __BaseException {
|
|
@@ -825,26 +886,41 @@ export declare class BadRequestException extends __BaseException {
|
|
|
825
886
|
*/
|
|
826
887
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
827
888
|
}
|
|
889
|
+
/**
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
828
892
|
export interface DeleteChannelPolicyRequest {
|
|
829
893
|
/**
|
|
830
894
|
* <p>The name of the channel associated with this channel policy.</p>
|
|
831
895
|
*/
|
|
832
896
|
ChannelName: string | undefined;
|
|
833
897
|
}
|
|
898
|
+
/**
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
834
901
|
export interface DeleteChannelPolicyResponse {
|
|
835
902
|
}
|
|
903
|
+
/**
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
836
906
|
export interface GetChannelPolicyRequest {
|
|
837
907
|
/**
|
|
838
908
|
* <p>The name of the channel associated with this Channel Policy.</p>
|
|
839
909
|
*/
|
|
840
910
|
ChannelName: string | undefined;
|
|
841
911
|
}
|
|
912
|
+
/**
|
|
913
|
+
* @public
|
|
914
|
+
*/
|
|
842
915
|
export interface GetChannelPolicyResponse {
|
|
843
916
|
/**
|
|
844
917
|
* <p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
|
|
845
918
|
*/
|
|
846
919
|
Policy?: string;
|
|
847
920
|
}
|
|
921
|
+
/**
|
|
922
|
+
* @public
|
|
923
|
+
*/
|
|
848
924
|
export interface PutChannelPolicyRequest {
|
|
849
925
|
/**
|
|
850
926
|
* <p>The channel name associated with this Channel Policy.</p>
|
|
@@ -855,8 +931,14 @@ export interface PutChannelPolicyRequest {
|
|
|
855
931
|
*/
|
|
856
932
|
Policy: string | undefined;
|
|
857
933
|
}
|
|
934
|
+
/**
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
858
937
|
export interface PutChannelPolicyResponse {
|
|
859
938
|
}
|
|
939
|
+
/**
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
860
942
|
export interface ConfigureLogsForChannelRequest {
|
|
861
943
|
/**
|
|
862
944
|
* <p>The name of the channel.</p>
|
|
@@ -867,6 +949,9 @@ export interface ConfigureLogsForChannelRequest {
|
|
|
867
949
|
*/
|
|
868
950
|
LogTypes: (LogType | string)[] | undefined;
|
|
869
951
|
}
|
|
952
|
+
/**
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
870
955
|
export interface ConfigureLogsForChannelResponse {
|
|
871
956
|
/**
|
|
872
957
|
* <p>The name of the channel.</p>
|
|
@@ -878,6 +963,7 @@ export interface ConfigureLogsForChannelResponse {
|
|
|
878
963
|
LogTypes?: (LogType | string)[];
|
|
879
964
|
}
|
|
880
965
|
/**
|
|
966
|
+
* @public
|
|
881
967
|
* <p>The output configuration for this channel.</p>
|
|
882
968
|
*/
|
|
883
969
|
export interface RequestOutputItem {
|
|
@@ -898,14 +984,23 @@ export interface RequestOutputItem {
|
|
|
898
984
|
*/
|
|
899
985
|
SourceGroup: string | undefined;
|
|
900
986
|
}
|
|
987
|
+
/**
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
901
990
|
export declare enum PlaybackMode {
|
|
902
991
|
LINEAR = "LINEAR",
|
|
903
992
|
LOOP = "LOOP"
|
|
904
993
|
}
|
|
994
|
+
/**
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
905
997
|
export declare enum Tier {
|
|
906
998
|
BASIC = "BASIC",
|
|
907
999
|
STANDARD = "STANDARD"
|
|
908
1000
|
}
|
|
1001
|
+
/**
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
909
1004
|
export interface CreateChannelRequest {
|
|
910
1005
|
/**
|
|
911
1006
|
* <p>The name of the channel.</p>
|
|
@@ -938,10 +1033,16 @@ export interface CreateChannelRequest {
|
|
|
938
1033
|
*/
|
|
939
1034
|
Tier?: Tier | string;
|
|
940
1035
|
}
|
|
1036
|
+
/**
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
941
1039
|
export declare enum ChannelState {
|
|
942
1040
|
RUNNING = "RUNNING",
|
|
943
1041
|
STOPPED = "STOPPED"
|
|
944
1042
|
}
|
|
1043
|
+
/**
|
|
1044
|
+
* @public
|
|
1045
|
+
*/
|
|
945
1046
|
export interface CreateChannelResponse {
|
|
946
1047
|
/**
|
|
947
1048
|
* <p>The Amazon Resource Name (ARN) to assign to the channel.</p>
|
|
@@ -984,20 +1085,32 @@ export interface CreateChannelResponse {
|
|
|
984
1085
|
*/
|
|
985
1086
|
Tier?: string;
|
|
986
1087
|
}
|
|
1088
|
+
/**
|
|
1089
|
+
* @public
|
|
1090
|
+
*/
|
|
987
1091
|
export interface DeleteChannelRequest {
|
|
988
1092
|
/**
|
|
989
1093
|
* <p>The name of the channel.</p>
|
|
990
1094
|
*/
|
|
991
1095
|
ChannelName: string | undefined;
|
|
992
1096
|
}
|
|
1097
|
+
/**
|
|
1098
|
+
* @public
|
|
1099
|
+
*/
|
|
993
1100
|
export interface DeleteChannelResponse {
|
|
994
1101
|
}
|
|
1102
|
+
/**
|
|
1103
|
+
* @public
|
|
1104
|
+
*/
|
|
995
1105
|
export interface DescribeChannelRequest {
|
|
996
1106
|
/**
|
|
997
1107
|
* <p>The name of the channel.</p>
|
|
998
1108
|
*/
|
|
999
1109
|
ChannelName: string | undefined;
|
|
1000
1110
|
}
|
|
1111
|
+
/**
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1001
1114
|
export interface DescribeChannelResponse {
|
|
1002
1115
|
/**
|
|
1003
1116
|
* <p>The ARN of the channel.</p>
|
|
@@ -1044,6 +1157,9 @@ export interface DescribeChannelResponse {
|
|
|
1044
1157
|
*/
|
|
1045
1158
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
1046
1159
|
}
|
|
1160
|
+
/**
|
|
1161
|
+
* @public
|
|
1162
|
+
*/
|
|
1047
1163
|
export interface GetChannelScheduleRequest {
|
|
1048
1164
|
/**
|
|
1049
1165
|
* <p>The name of the channel associated with this Channel Schedule.</p>
|
|
@@ -1065,6 +1181,9 @@ export interface GetChannelScheduleRequest {
|
|
|
1065
1181
|
*/
|
|
1066
1182
|
NextToken?: string;
|
|
1067
1183
|
}
|
|
1184
|
+
/**
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1068
1187
|
export interface GetChannelScheduleResponse {
|
|
1069
1188
|
/**
|
|
1070
1189
|
* <p>A list of schedule entries for the channel.</p>
|
|
@@ -1075,6 +1194,9 @@ export interface GetChannelScheduleResponse {
|
|
|
1075
1194
|
*/
|
|
1076
1195
|
NextToken?: string;
|
|
1077
1196
|
}
|
|
1197
|
+
/**
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1078
1200
|
export interface ListChannelsRequest {
|
|
1079
1201
|
/**
|
|
1080
1202
|
* <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>
|
|
@@ -1085,6 +1207,9 @@ export interface ListChannelsRequest {
|
|
|
1085
1207
|
*/
|
|
1086
1208
|
NextToken?: string;
|
|
1087
1209
|
}
|
|
1210
|
+
/**
|
|
1211
|
+
* @public
|
|
1212
|
+
*/
|
|
1088
1213
|
export interface ListChannelsResponse {
|
|
1089
1214
|
/**
|
|
1090
1215
|
* <p>A list of channels that are associated with this account.</p>
|
|
@@ -1096,6 +1221,7 @@ export interface ListChannelsResponse {
|
|
|
1096
1221
|
NextToken?: string;
|
|
1097
1222
|
}
|
|
1098
1223
|
/**
|
|
1224
|
+
* @public
|
|
1099
1225
|
* <p>Clip range configuration for the VOD source associated with the program.</p>
|
|
1100
1226
|
*/
|
|
1101
1227
|
export interface ClipRange {
|
|
@@ -1104,11 +1230,15 @@ export interface ClipRange {
|
|
|
1104
1230
|
*/
|
|
1105
1231
|
EndOffsetMillis: number | undefined;
|
|
1106
1232
|
}
|
|
1233
|
+
/**
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1107
1236
|
export declare enum RelativePosition {
|
|
1108
1237
|
AFTER_PROGRAM = "AFTER_PROGRAM",
|
|
1109
1238
|
BEFORE_PROGRAM = "BEFORE_PROGRAM"
|
|
1110
1239
|
}
|
|
1111
1240
|
/**
|
|
1241
|
+
* @public
|
|
1112
1242
|
* <p>Program transition configuration.</p>
|
|
1113
1243
|
*/
|
|
1114
1244
|
export interface Transition {
|
|
@@ -1142,6 +1272,7 @@ export interface Transition {
|
|
|
1142
1272
|
Type: string | undefined;
|
|
1143
1273
|
}
|
|
1144
1274
|
/**
|
|
1275
|
+
* @public
|
|
1145
1276
|
* <p>Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.</p>
|
|
1146
1277
|
*/
|
|
1147
1278
|
export interface ScheduleConfiguration {
|
|
@@ -1154,6 +1285,9 @@ export interface ScheduleConfiguration {
|
|
|
1154
1285
|
*/
|
|
1155
1286
|
ClipRange?: ClipRange;
|
|
1156
1287
|
}
|
|
1288
|
+
/**
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1157
1291
|
export interface CreateProgramRequest {
|
|
1158
1292
|
/**
|
|
1159
1293
|
* <p>The ad break configuration settings.</p>
|
|
@@ -1184,6 +1318,9 @@ export interface CreateProgramRequest {
|
|
|
1184
1318
|
*/
|
|
1185
1319
|
VodSourceName?: string;
|
|
1186
1320
|
}
|
|
1321
|
+
/**
|
|
1322
|
+
* @public
|
|
1323
|
+
*/
|
|
1187
1324
|
export interface CreateProgramResponse {
|
|
1188
1325
|
/**
|
|
1189
1326
|
* <p>The ad break configuration settings.</p>
|
|
@@ -1230,6 +1367,9 @@ export interface CreateProgramResponse {
|
|
|
1230
1367
|
*/
|
|
1231
1368
|
DurationMillis?: number;
|
|
1232
1369
|
}
|
|
1370
|
+
/**
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1233
1373
|
export interface DeleteProgramRequest {
|
|
1234
1374
|
/**
|
|
1235
1375
|
* <p>The name of the channel.</p>
|
|
@@ -1240,8 +1380,14 @@ export interface DeleteProgramRequest {
|
|
|
1240
1380
|
*/
|
|
1241
1381
|
ProgramName: string | undefined;
|
|
1242
1382
|
}
|
|
1383
|
+
/**
|
|
1384
|
+
* @public
|
|
1385
|
+
*/
|
|
1243
1386
|
export interface DeleteProgramResponse {
|
|
1244
1387
|
}
|
|
1388
|
+
/**
|
|
1389
|
+
* @public
|
|
1390
|
+
*/
|
|
1245
1391
|
export interface DescribeProgramRequest {
|
|
1246
1392
|
/**
|
|
1247
1393
|
* <p>The name of the channel associated with this Program.</p>
|
|
@@ -1252,6 +1398,9 @@ export interface DescribeProgramRequest {
|
|
|
1252
1398
|
*/
|
|
1253
1399
|
ProgramName: string | undefined;
|
|
1254
1400
|
}
|
|
1401
|
+
/**
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1255
1404
|
export interface DescribeProgramResponse {
|
|
1256
1405
|
/**
|
|
1257
1406
|
* <p>The ad break configuration settings.</p>
|
|
@@ -1299,6 +1448,7 @@ export interface DescribeProgramResponse {
|
|
|
1299
1448
|
DurationMillis?: number;
|
|
1300
1449
|
}
|
|
1301
1450
|
/**
|
|
1451
|
+
* @public
|
|
1302
1452
|
* <p>Program transition configuration.</p>
|
|
1303
1453
|
*/
|
|
1304
1454
|
export interface UpdateProgramTransition {
|
|
@@ -1312,6 +1462,7 @@ export interface UpdateProgramTransition {
|
|
|
1312
1462
|
DurationMillis?: number;
|
|
1313
1463
|
}
|
|
1314
1464
|
/**
|
|
1465
|
+
* @public
|
|
1315
1466
|
* <p>Schedule configuration parameters.</p>
|
|
1316
1467
|
*/
|
|
1317
1468
|
export interface UpdateProgramScheduleConfiguration {
|
|
@@ -1324,6 +1475,9 @@ export interface UpdateProgramScheduleConfiguration {
|
|
|
1324
1475
|
*/
|
|
1325
1476
|
ClipRange?: ClipRange;
|
|
1326
1477
|
}
|
|
1478
|
+
/**
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1327
1481
|
export interface UpdateProgramRequest {
|
|
1328
1482
|
/**
|
|
1329
1483
|
* <p>The ad break configuration settings.</p>
|
|
@@ -1342,6 +1496,9 @@ export interface UpdateProgramRequest {
|
|
|
1342
1496
|
*/
|
|
1343
1497
|
ScheduleConfiguration: UpdateProgramScheduleConfiguration | undefined;
|
|
1344
1498
|
}
|
|
1499
|
+
/**
|
|
1500
|
+
* @public
|
|
1501
|
+
*/
|
|
1345
1502
|
export interface UpdateProgramResponse {
|
|
1346
1503
|
/**
|
|
1347
1504
|
* <p>The ad break configuration settings.</p>
|
|
@@ -1388,22 +1545,37 @@ export interface UpdateProgramResponse {
|
|
|
1388
1545
|
*/
|
|
1389
1546
|
ScheduledStartTime?: Date;
|
|
1390
1547
|
}
|
|
1548
|
+
/**
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1391
1551
|
export interface StartChannelRequest {
|
|
1392
1552
|
/**
|
|
1393
1553
|
* <p>The name of the channel.</p>
|
|
1394
1554
|
*/
|
|
1395
1555
|
ChannelName: string | undefined;
|
|
1396
1556
|
}
|
|
1557
|
+
/**
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1397
1560
|
export interface StartChannelResponse {
|
|
1398
1561
|
}
|
|
1562
|
+
/**
|
|
1563
|
+
* @public
|
|
1564
|
+
*/
|
|
1399
1565
|
export interface StopChannelRequest {
|
|
1400
1566
|
/**
|
|
1401
1567
|
* <p>The name of the channel.</p>
|
|
1402
1568
|
*/
|
|
1403
1569
|
ChannelName: string | undefined;
|
|
1404
1570
|
}
|
|
1571
|
+
/**
|
|
1572
|
+
* @public
|
|
1573
|
+
*/
|
|
1405
1574
|
export interface StopChannelResponse {
|
|
1406
1575
|
}
|
|
1576
|
+
/**
|
|
1577
|
+
* @public
|
|
1578
|
+
*/
|
|
1407
1579
|
export interface UpdateChannelRequest {
|
|
1408
1580
|
/**
|
|
1409
1581
|
* <p>The name of the channel.</p>
|
|
@@ -1420,6 +1592,9 @@ export interface UpdateChannelRequest {
|
|
|
1420
1592
|
*/
|
|
1421
1593
|
Outputs: RequestOutputItem[] | undefined;
|
|
1422
1594
|
}
|
|
1595
|
+
/**
|
|
1596
|
+
* @public
|
|
1597
|
+
*/
|
|
1423
1598
|
export interface UpdateChannelResponse {
|
|
1424
1599
|
/**
|
|
1425
1600
|
* <p>The Amazon Resource Name (ARN) associated with the channel.</p>
|
|
@@ -1469,6 +1644,7 @@ export interface UpdateChannelResponse {
|
|
|
1469
1644
|
Tier?: string;
|
|
1470
1645
|
}
|
|
1471
1646
|
/**
|
|
1647
|
+
* @public
|
|
1472
1648
|
* <p>Configures Amazon CloudWatch log settings for a playback configuration.</p>
|
|
1473
1649
|
*/
|
|
1474
1650
|
export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
@@ -1483,6 +1659,9 @@ export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
|
1483
1659
|
*/
|
|
1484
1660
|
PlaybackConfigurationName: string | undefined;
|
|
1485
1661
|
}
|
|
1662
|
+
/**
|
|
1663
|
+
* @public
|
|
1664
|
+
*/
|
|
1486
1665
|
export interface ConfigureLogsForPlaybackConfigurationResponse {
|
|
1487
1666
|
/**
|
|
1488
1667
|
* <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.</p>
|
|
@@ -1493,6 +1672,9 @@ export interface ConfigureLogsForPlaybackConfigurationResponse {
|
|
|
1493
1672
|
*/
|
|
1494
1673
|
PlaybackConfigurationName?: string;
|
|
1495
1674
|
}
|
|
1675
|
+
/**
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1496
1678
|
export interface CreateLiveSourceRequest {
|
|
1497
1679
|
/**
|
|
1498
1680
|
* <p>A list of HTTP package configuration parameters for this live source.</p>
|
|
@@ -1511,6 +1693,9 @@ export interface CreateLiveSourceRequest {
|
|
|
1511
1693
|
*/
|
|
1512
1694
|
Tags?: Record<string, string>;
|
|
1513
1695
|
}
|
|
1696
|
+
/**
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1514
1699
|
export interface CreateLiveSourceResponse {
|
|
1515
1700
|
/**
|
|
1516
1701
|
* <p>The ARN to assign to the live source.</p>
|
|
@@ -1541,6 +1726,9 @@ export interface CreateLiveSourceResponse {
|
|
|
1541
1726
|
*/
|
|
1542
1727
|
Tags?: Record<string, string>;
|
|
1543
1728
|
}
|
|
1729
|
+
/**
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1544
1732
|
export interface CreatePrefetchScheduleRequest {
|
|
1545
1733
|
/**
|
|
1546
1734
|
* <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>
|
|
@@ -1563,6 +1751,9 @@ export interface CreatePrefetchScheduleRequest {
|
|
|
1563
1751
|
*/
|
|
1564
1752
|
StreamId?: string;
|
|
1565
1753
|
}
|
|
1754
|
+
/**
|
|
1755
|
+
* @public
|
|
1756
|
+
*/
|
|
1566
1757
|
export interface CreatePrefetchScheduleResponse {
|
|
1567
1758
|
/**
|
|
1568
1759
|
* <p>The ARN to assign to the prefetch schedule.</p>
|
|
@@ -1589,6 +1780,9 @@ export interface CreatePrefetchScheduleResponse {
|
|
|
1589
1780
|
*/
|
|
1590
1781
|
StreamId?: string;
|
|
1591
1782
|
}
|
|
1783
|
+
/**
|
|
1784
|
+
* @public
|
|
1785
|
+
*/
|
|
1592
1786
|
export interface CreateSourceLocationRequest {
|
|
1593
1787
|
/**
|
|
1594
1788
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
@@ -1615,6 +1809,9 @@ export interface CreateSourceLocationRequest {
|
|
|
1615
1809
|
*/
|
|
1616
1810
|
Tags?: Record<string, string>;
|
|
1617
1811
|
}
|
|
1812
|
+
/**
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1618
1815
|
export interface CreateSourceLocationResponse {
|
|
1619
1816
|
/**
|
|
1620
1817
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
@@ -1653,6 +1850,9 @@ export interface CreateSourceLocationResponse {
|
|
|
1653
1850
|
*/
|
|
1654
1851
|
Tags?: Record<string, string>;
|
|
1655
1852
|
}
|
|
1853
|
+
/**
|
|
1854
|
+
* @public
|
|
1855
|
+
*/
|
|
1656
1856
|
export interface CreateVodSourceRequest {
|
|
1657
1857
|
/**
|
|
1658
1858
|
* <p>A list of HTTP package configuration parameters for this VOD source.</p>
|
|
@@ -1671,6 +1871,9 @@ export interface CreateVodSourceRequest {
|
|
|
1671
1871
|
*/
|
|
1672
1872
|
VodSourceName: string | undefined;
|
|
1673
1873
|
}
|
|
1874
|
+
/**
|
|
1875
|
+
* @public
|
|
1876
|
+
*/
|
|
1674
1877
|
export interface CreateVodSourceResponse {
|
|
1675
1878
|
/**
|
|
1676
1879
|
* <p>The ARN to assign to this VOD source.</p>
|
|
@@ -1702,6 +1905,7 @@ export interface CreateVodSourceResponse {
|
|
|
1702
1905
|
VodSourceName?: string;
|
|
1703
1906
|
}
|
|
1704
1907
|
/**
|
|
1908
|
+
* @public
|
|
1705
1909
|
* <p>The configuration for DASH PUT operations.</p>
|
|
1706
1910
|
*/
|
|
1707
1911
|
export interface DashConfigurationForPut {
|
|
@@ -1714,6 +1918,9 @@ export interface DashConfigurationForPut {
|
|
|
1714
1918
|
*/
|
|
1715
1919
|
OriginManifestType?: OriginManifestType | string;
|
|
1716
1920
|
}
|
|
1921
|
+
/**
|
|
1922
|
+
* @public
|
|
1923
|
+
*/
|
|
1717
1924
|
export interface DeleteLiveSourceRequest {
|
|
1718
1925
|
/**
|
|
1719
1926
|
* <p>The name of the live source.</p>
|
|
@@ -1724,16 +1931,28 @@ export interface DeleteLiveSourceRequest {
|
|
|
1724
1931
|
*/
|
|
1725
1932
|
SourceLocationName: string | undefined;
|
|
1726
1933
|
}
|
|
1934
|
+
/**
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1727
1937
|
export interface DeleteLiveSourceResponse {
|
|
1728
1938
|
}
|
|
1939
|
+
/**
|
|
1940
|
+
* @public
|
|
1941
|
+
*/
|
|
1729
1942
|
export interface DeletePlaybackConfigurationRequest {
|
|
1730
1943
|
/**
|
|
1731
1944
|
* <p>The name of the playback configuration.</p>
|
|
1732
1945
|
*/
|
|
1733
1946
|
Name: string | undefined;
|
|
1734
1947
|
}
|
|
1948
|
+
/**
|
|
1949
|
+
* @public
|
|
1950
|
+
*/
|
|
1735
1951
|
export interface DeletePlaybackConfigurationResponse {
|
|
1736
1952
|
}
|
|
1953
|
+
/**
|
|
1954
|
+
* @public
|
|
1955
|
+
*/
|
|
1737
1956
|
export interface DeletePrefetchScheduleRequest {
|
|
1738
1957
|
/**
|
|
1739
1958
|
* <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>
|
|
@@ -1744,16 +1963,28 @@ export interface DeletePrefetchScheduleRequest {
|
|
|
1744
1963
|
*/
|
|
1745
1964
|
PlaybackConfigurationName: string | undefined;
|
|
1746
1965
|
}
|
|
1966
|
+
/**
|
|
1967
|
+
* @public
|
|
1968
|
+
*/
|
|
1747
1969
|
export interface DeletePrefetchScheduleResponse {
|
|
1748
1970
|
}
|
|
1971
|
+
/**
|
|
1972
|
+
* @public
|
|
1973
|
+
*/
|
|
1749
1974
|
export interface DeleteSourceLocationRequest {
|
|
1750
1975
|
/**
|
|
1751
1976
|
* <p>The name of the source location.</p>
|
|
1752
1977
|
*/
|
|
1753
1978
|
SourceLocationName: string | undefined;
|
|
1754
1979
|
}
|
|
1980
|
+
/**
|
|
1981
|
+
* @public
|
|
1982
|
+
*/
|
|
1755
1983
|
export interface DeleteSourceLocationResponse {
|
|
1756
1984
|
}
|
|
1985
|
+
/**
|
|
1986
|
+
* @public
|
|
1987
|
+
*/
|
|
1757
1988
|
export interface DeleteVodSourceRequest {
|
|
1758
1989
|
/**
|
|
1759
1990
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
@@ -1764,8 +1995,14 @@ export interface DeleteVodSourceRequest {
|
|
|
1764
1995
|
*/
|
|
1765
1996
|
VodSourceName: string | undefined;
|
|
1766
1997
|
}
|
|
1998
|
+
/**
|
|
1999
|
+
* @public
|
|
2000
|
+
*/
|
|
1767
2001
|
export interface DeleteVodSourceResponse {
|
|
1768
2002
|
}
|
|
2003
|
+
/**
|
|
2004
|
+
* @public
|
|
2005
|
+
*/
|
|
1769
2006
|
export interface DescribeLiveSourceRequest {
|
|
1770
2007
|
/**
|
|
1771
2008
|
* <p>The name of the live source.</p>
|
|
@@ -1776,6 +2013,9 @@ export interface DescribeLiveSourceRequest {
|
|
|
1776
2013
|
*/
|
|
1777
2014
|
SourceLocationName: string | undefined;
|
|
1778
2015
|
}
|
|
2016
|
+
/**
|
|
2017
|
+
* @public
|
|
2018
|
+
*/
|
|
1779
2019
|
export interface DescribeLiveSourceResponse {
|
|
1780
2020
|
/**
|
|
1781
2021
|
* <p>The ARN of the live source.</p>
|
|
@@ -1806,12 +2046,18 @@ export interface DescribeLiveSourceResponse {
|
|
|
1806
2046
|
*/
|
|
1807
2047
|
Tags?: Record<string, string>;
|
|
1808
2048
|
}
|
|
2049
|
+
/**
|
|
2050
|
+
* @public
|
|
2051
|
+
*/
|
|
1809
2052
|
export interface DescribeSourceLocationRequest {
|
|
1810
2053
|
/**
|
|
1811
2054
|
* <p>The name of the source location.</p>
|
|
1812
2055
|
*/
|
|
1813
2056
|
SourceLocationName: string | undefined;
|
|
1814
2057
|
}
|
|
2058
|
+
/**
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
1815
2061
|
export interface DescribeSourceLocationResponse {
|
|
1816
2062
|
/**
|
|
1817
2063
|
* <p>The access configuration for the source location.</p>
|
|
@@ -1850,6 +2096,9 @@ export interface DescribeSourceLocationResponse {
|
|
|
1850
2096
|
*/
|
|
1851
2097
|
Tags?: Record<string, string>;
|
|
1852
2098
|
}
|
|
2099
|
+
/**
|
|
2100
|
+
* @public
|
|
2101
|
+
*/
|
|
1853
2102
|
export interface DescribeVodSourceRequest {
|
|
1854
2103
|
/**
|
|
1855
2104
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
@@ -1860,6 +2109,9 @@ export interface DescribeVodSourceRequest {
|
|
|
1860
2109
|
*/
|
|
1861
2110
|
VodSourceName: string | undefined;
|
|
1862
2111
|
}
|
|
2112
|
+
/**
|
|
2113
|
+
* @public
|
|
2114
|
+
*/
|
|
1863
2115
|
export interface DescribeVodSourceResponse {
|
|
1864
2116
|
/**
|
|
1865
2117
|
* <p>The ARN of the VOD source.</p>
|
|
@@ -1890,12 +2142,18 @@ export interface DescribeVodSourceResponse {
|
|
|
1890
2142
|
*/
|
|
1891
2143
|
VodSourceName?: string;
|
|
1892
2144
|
}
|
|
2145
|
+
/**
|
|
2146
|
+
* @public
|
|
2147
|
+
*/
|
|
1893
2148
|
export interface GetPlaybackConfigurationRequest {
|
|
1894
2149
|
/**
|
|
1895
2150
|
* <p>The identifier for the playback configuration.</p>
|
|
1896
2151
|
*/
|
|
1897
2152
|
Name: string | undefined;
|
|
1898
2153
|
}
|
|
2154
|
+
/**
|
|
2155
|
+
* @public
|
|
2156
|
+
*/
|
|
1899
2157
|
export interface GetPlaybackConfigurationResponse {
|
|
1900
2158
|
/**
|
|
1901
2159
|
* <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>
|
|
@@ -1974,6 +2232,9 @@ export interface GetPlaybackConfigurationResponse {
|
|
|
1974
2232
|
*/
|
|
1975
2233
|
VideoContentSourceUrl?: string;
|
|
1976
2234
|
}
|
|
2235
|
+
/**
|
|
2236
|
+
* @public
|
|
2237
|
+
*/
|
|
1977
2238
|
export interface GetPrefetchScheduleRequest {
|
|
1978
2239
|
/**
|
|
1979
2240
|
* <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>
|
|
@@ -1984,6 +2245,9 @@ export interface GetPrefetchScheduleRequest {
|
|
|
1984
2245
|
*/
|
|
1985
2246
|
PlaybackConfigurationName: string | undefined;
|
|
1986
2247
|
}
|
|
2248
|
+
/**
|
|
2249
|
+
* @public
|
|
2250
|
+
*/
|
|
1987
2251
|
export interface GetPrefetchScheduleResponse {
|
|
1988
2252
|
/**
|
|
1989
2253
|
* <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
|
|
@@ -2010,6 +2274,9 @@ export interface GetPrefetchScheduleResponse {
|
|
|
2010
2274
|
*/
|
|
2011
2275
|
StreamId?: string;
|
|
2012
2276
|
}
|
|
2277
|
+
/**
|
|
2278
|
+
* @public
|
|
2279
|
+
*/
|
|
2013
2280
|
export interface ListAlertsRequest {
|
|
2014
2281
|
/**
|
|
2015
2282
|
* <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>
|
|
@@ -2024,6 +2291,9 @@ export interface ListAlertsRequest {
|
|
|
2024
2291
|
*/
|
|
2025
2292
|
ResourceArn: string | undefined;
|
|
2026
2293
|
}
|
|
2294
|
+
/**
|
|
2295
|
+
* @public
|
|
2296
|
+
*/
|
|
2027
2297
|
export interface ListAlertsResponse {
|
|
2028
2298
|
/**
|
|
2029
2299
|
* <p>A list of alerts that are associated with this resource.</p>
|
|
@@ -2034,6 +2304,9 @@ export interface ListAlertsResponse {
|
|
|
2034
2304
|
*/
|
|
2035
2305
|
NextToken?: string;
|
|
2036
2306
|
}
|
|
2307
|
+
/**
|
|
2308
|
+
* @public
|
|
2309
|
+
*/
|
|
2037
2310
|
export interface ListLiveSourcesRequest {
|
|
2038
2311
|
/**
|
|
2039
2312
|
* <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>
|
|
@@ -2048,6 +2321,9 @@ export interface ListLiveSourcesRequest {
|
|
|
2048
2321
|
*/
|
|
2049
2322
|
SourceLocationName: string | undefined;
|
|
2050
2323
|
}
|
|
2324
|
+
/**
|
|
2325
|
+
* @public
|
|
2326
|
+
*/
|
|
2051
2327
|
export interface ListLiveSourcesResponse {
|
|
2052
2328
|
/**
|
|
2053
2329
|
* <p>Lists the live sources.</p>
|
|
@@ -2058,6 +2334,9 @@ export interface ListLiveSourcesResponse {
|
|
|
2058
2334
|
*/
|
|
2059
2335
|
NextToken?: string;
|
|
2060
2336
|
}
|
|
2337
|
+
/**
|
|
2338
|
+
* @public
|
|
2339
|
+
*/
|
|
2061
2340
|
export interface ListPlaybackConfigurationsRequest {
|
|
2062
2341
|
/**
|
|
2063
2342
|
* <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>
|
|
@@ -2068,6 +2347,9 @@ export interface ListPlaybackConfigurationsRequest {
|
|
|
2068
2347
|
*/
|
|
2069
2348
|
NextToken?: string;
|
|
2070
2349
|
}
|
|
2350
|
+
/**
|
|
2351
|
+
* @public
|
|
2352
|
+
*/
|
|
2071
2353
|
export interface ListPlaybackConfigurationsResponse {
|
|
2072
2354
|
/**
|
|
2073
2355
|
* <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>
|
|
@@ -2078,6 +2360,9 @@ export interface ListPlaybackConfigurationsResponse {
|
|
|
2078
2360
|
*/
|
|
2079
2361
|
NextToken?: string;
|
|
2080
2362
|
}
|
|
2363
|
+
/**
|
|
2364
|
+
* @public
|
|
2365
|
+
*/
|
|
2081
2366
|
export interface ListPrefetchSchedulesRequest {
|
|
2082
2367
|
/**
|
|
2083
2368
|
* <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>
|
|
@@ -2099,6 +2384,9 @@ export interface ListPrefetchSchedulesRequest {
|
|
|
2099
2384
|
*/
|
|
2100
2385
|
StreamId?: string;
|
|
2101
2386
|
}
|
|
2387
|
+
/**
|
|
2388
|
+
* @public
|
|
2389
|
+
*/
|
|
2102
2390
|
export interface ListPrefetchSchedulesResponse {
|
|
2103
2391
|
/**
|
|
2104
2392
|
* <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>
|
|
@@ -2109,6 +2397,9 @@ export interface ListPrefetchSchedulesResponse {
|
|
|
2109
2397
|
*/
|
|
2110
2398
|
NextToken?: string;
|
|
2111
2399
|
}
|
|
2400
|
+
/**
|
|
2401
|
+
* @public
|
|
2402
|
+
*/
|
|
2112
2403
|
export interface ListSourceLocationsRequest {
|
|
2113
2404
|
/**
|
|
2114
2405
|
* <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>
|
|
@@ -2119,6 +2410,9 @@ export interface ListSourceLocationsRequest {
|
|
|
2119
2410
|
*/
|
|
2120
2411
|
NextToken?: string;
|
|
2121
2412
|
}
|
|
2413
|
+
/**
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2122
2416
|
export interface ListSourceLocationsResponse {
|
|
2123
2417
|
/**
|
|
2124
2418
|
* <p>A list of source locations.</p>
|
|
@@ -2129,18 +2423,27 @@ export interface ListSourceLocationsResponse {
|
|
|
2129
2423
|
*/
|
|
2130
2424
|
NextToken?: string;
|
|
2131
2425
|
}
|
|
2426
|
+
/**
|
|
2427
|
+
* @public
|
|
2428
|
+
*/
|
|
2132
2429
|
export interface ListTagsForResourceRequest {
|
|
2133
2430
|
/**
|
|
2134
2431
|
* <p>The Amazon Resource Name (ARN) associated with this resource.</p>
|
|
2135
2432
|
*/
|
|
2136
2433
|
ResourceArn: string | undefined;
|
|
2137
2434
|
}
|
|
2435
|
+
/**
|
|
2436
|
+
* @public
|
|
2437
|
+
*/
|
|
2138
2438
|
export interface ListTagsForResourceResponse {
|
|
2139
2439
|
/**
|
|
2140
2440
|
* <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>
|
|
2141
2441
|
*/
|
|
2142
2442
|
Tags?: Record<string, string>;
|
|
2143
2443
|
}
|
|
2444
|
+
/**
|
|
2445
|
+
* @public
|
|
2446
|
+
*/
|
|
2144
2447
|
export interface ListVodSourcesRequest {
|
|
2145
2448
|
/**
|
|
2146
2449
|
* <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>
|
|
@@ -2155,6 +2458,9 @@ export interface ListVodSourcesRequest {
|
|
|
2155
2458
|
*/
|
|
2156
2459
|
SourceLocationName: string | undefined;
|
|
2157
2460
|
}
|
|
2461
|
+
/**
|
|
2462
|
+
* @public
|
|
2463
|
+
*/
|
|
2158
2464
|
export interface ListVodSourcesResponse {
|
|
2159
2465
|
/**
|
|
2160
2466
|
* <p>Lists the VOD sources.</p>
|
|
@@ -2165,6 +2471,9 @@ export interface ListVodSourcesResponse {
|
|
|
2165
2471
|
*/
|
|
2166
2472
|
NextToken?: string;
|
|
2167
2473
|
}
|
|
2474
|
+
/**
|
|
2475
|
+
* @public
|
|
2476
|
+
*/
|
|
2168
2477
|
export interface UpdateLiveSourceRequest {
|
|
2169
2478
|
/**
|
|
2170
2479
|
* <p>A list of HTTP package configurations for the live source on this account.</p>
|
|
@@ -2179,6 +2488,9 @@ export interface UpdateLiveSourceRequest {
|
|
|
2179
2488
|
*/
|
|
2180
2489
|
SourceLocationName: string | undefined;
|
|
2181
2490
|
}
|
|
2491
|
+
/**
|
|
2492
|
+
* @public
|
|
2493
|
+
*/
|
|
2182
2494
|
export interface UpdateLiveSourceResponse {
|
|
2183
2495
|
/**
|
|
2184
2496
|
* <p>The Amazon Resource Name (ARN) associated with this live source.</p>
|
|
@@ -2209,6 +2521,9 @@ export interface UpdateLiveSourceResponse {
|
|
|
2209
2521
|
*/
|
|
2210
2522
|
Tags?: Record<string, string>;
|
|
2211
2523
|
}
|
|
2524
|
+
/**
|
|
2525
|
+
* @public
|
|
2526
|
+
*/
|
|
2212
2527
|
export interface PutPlaybackConfigurationRequest {
|
|
2213
2528
|
/**
|
|
2214
2529
|
* <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>
|
|
@@ -2267,6 +2582,9 @@ export interface PutPlaybackConfigurationRequest {
|
|
|
2267
2582
|
*/
|
|
2268
2583
|
VideoContentSourceUrl?: string;
|
|
2269
2584
|
}
|
|
2585
|
+
/**
|
|
2586
|
+
* @public
|
|
2587
|
+
*/
|
|
2270
2588
|
export interface PutPlaybackConfigurationResponse {
|
|
2271
2589
|
/**
|
|
2272
2590
|
* <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>
|
|
@@ -2345,6 +2663,9 @@ export interface PutPlaybackConfigurationResponse {
|
|
|
2345
2663
|
*/
|
|
2346
2664
|
VideoContentSourceUrl?: string;
|
|
2347
2665
|
}
|
|
2666
|
+
/**
|
|
2667
|
+
* @public
|
|
2668
|
+
*/
|
|
2348
2669
|
export interface UpdateSourceLocationRequest {
|
|
2349
2670
|
/**
|
|
2350
2671
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
@@ -2367,6 +2688,9 @@ export interface UpdateSourceLocationRequest {
|
|
|
2367
2688
|
*/
|
|
2368
2689
|
SourceLocationName: string | undefined;
|
|
2369
2690
|
}
|
|
2691
|
+
/**
|
|
2692
|
+
* @public
|
|
2693
|
+
*/
|
|
2370
2694
|
export interface UpdateSourceLocationResponse {
|
|
2371
2695
|
/**
|
|
2372
2696
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
@@ -2405,6 +2729,9 @@ export interface UpdateSourceLocationResponse {
|
|
|
2405
2729
|
*/
|
|
2406
2730
|
Tags?: Record<string, string>;
|
|
2407
2731
|
}
|
|
2732
|
+
/**
|
|
2733
|
+
* @public
|
|
2734
|
+
*/
|
|
2408
2735
|
export interface TagResourceRequest {
|
|
2409
2736
|
/**
|
|
2410
2737
|
* <p>The Amazon Resource Name (ARN) associated with the resource.</p>
|
|
@@ -2415,6 +2742,9 @@ export interface TagResourceRequest {
|
|
|
2415
2742
|
*/
|
|
2416
2743
|
Tags: Record<string, string> | undefined;
|
|
2417
2744
|
}
|
|
2745
|
+
/**
|
|
2746
|
+
* @public
|
|
2747
|
+
*/
|
|
2418
2748
|
export interface UntagResourceRequest {
|
|
2419
2749
|
/**
|
|
2420
2750
|
* <p>The Amazon Resource Name (ARN) of the resource to untag.</p>
|
|
@@ -2425,6 +2755,9 @@ export interface UntagResourceRequest {
|
|
|
2425
2755
|
*/
|
|
2426
2756
|
TagKeys: string[] | undefined;
|
|
2427
2757
|
}
|
|
2758
|
+
/**
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2428
2761
|
export interface UpdateVodSourceRequest {
|
|
2429
2762
|
/**
|
|
2430
2763
|
* <p>A list of HTTP package configurations for the VOD source on this account.</p>
|
|
@@ -2439,6 +2772,9 @@ export interface UpdateVodSourceRequest {
|
|
|
2439
2772
|
*/
|
|
2440
2773
|
VodSourceName: string | undefined;
|
|
2441
2774
|
}
|
|
2775
|
+
/**
|
|
2776
|
+
* @public
|
|
2777
|
+
*/
|
|
2442
2778
|
export interface UpdateVodSourceResponse {
|
|
2443
2779
|
/**
|
|
2444
2780
|
* <p>The Amazon Resource Name (ARN) associated with the VOD source.</p>
|