mediatailor.d.ts
25.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class MediaTailor extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: MediaTailor.Types.ClientConfiguration)
config: Config & MediaTailor.Types.ClientConfiguration;
/**
* Deletes the playback configuration for the specified name.
*/
deletePlaybackConfiguration(params: MediaTailor.Types.DeletePlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request<MediaTailor.Types.DeletePlaybackConfigurationResponse, AWSError>;
/**
* Deletes the playback configuration for the specified name.
*/
deletePlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.DeletePlaybackConfigurationResponse) => void): Request<MediaTailor.Types.DeletePlaybackConfigurationResponse, AWSError>;
/**
* Returns the playback configuration for the specified name.
*/
getPlaybackConfiguration(params: MediaTailor.Types.GetPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.GetPlaybackConfigurationResponse, AWSError>;
/**
* Returns the playback configuration for the specified name.
*/
getPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.GetPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.GetPlaybackConfigurationResponse, AWSError>;
/**
* Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.
*/
listPlaybackConfigurations(params: MediaTailor.Types.ListPlaybackConfigurationsRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request<MediaTailor.Types.ListPlaybackConfigurationsResponse, AWSError>;
/**
* Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.
*/
listPlaybackConfigurations(callback?: (err: AWSError, data: MediaTailor.Types.ListPlaybackConfigurationsResponse) => void): Request<MediaTailor.Types.ListPlaybackConfigurationsResponse, AWSError>;
/**
* Returns a list of the tags assigned to the specified playback configuration resource.
*/
listTagsForResource(params: MediaTailor.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request<MediaTailor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of the tags assigned to the specified playback configuration resource.
*/
listTagsForResource(callback?: (err: AWSError, data: MediaTailor.Types.ListTagsForResourceResponse) => void): Request<MediaTailor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Adds a new playback configuration to AWS Elemental MediaTailor.
*/
putPlaybackConfiguration(params: MediaTailor.Types.PutPlaybackConfigurationRequest, callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.PutPlaybackConfigurationResponse, AWSError>;
/**
* Adds a new playback configuration to AWS Elemental MediaTailor.
*/
putPlaybackConfiguration(callback?: (err: AWSError, data: MediaTailor.Types.PutPlaybackConfigurationResponse) => void): Request<MediaTailor.Types.PutPlaybackConfigurationResponse, AWSError>;
/**
* Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
*/
tagResource(params: MediaTailor.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
*/
untagResource(params: MediaTailor.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace MediaTailor {
export interface AvailSuppression {
/**
* Sets the mode for avail suppression, also known as ad suppression. By default, ad suppression is off and all ad breaks are filled by MediaTailor with ads or slate.
*/
Mode?: Mode;
/**
* The avail suppression value is 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.
*/
Value?: __string;
}
export interface Bumper {
/**
* The URL for the end bumper asset.
*/
EndUrl?: __string;
/**
* The URL for the start bumper asset.
*/
StartUrl?: __string;
}
export interface CdnConfiguration {
/**
* 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 following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
*/
AdSegmentUrlPrefix?: __string;
/**
* 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 ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
*/
ContentSegmentUrlPrefix?: __string;
}
export interface DashConfiguration {
/**
* The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
*/
ManifestEndpointPrefix?: __string;
/**
* 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 DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
*/
MpdLocation?: __string;
/**
* 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 SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
*/
OriginManifestType?: OriginManifestType;
}
export interface DashConfigurationForPut {
/**
* 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 DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
*/
MpdLocation?: __string;
/**
* 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 SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
*/
OriginManifestType?: OriginManifestType;
}
export interface DeletePlaybackConfigurationRequest {
/**
* The identifier for the playback configuration.
*/
Name: __string;
}
export interface DeletePlaybackConfigurationResponse {
}
export interface GetPlaybackConfigurationRequest {
/**
* The identifier for the playback configuration.
*/
Name: __string;
}
export interface GetPlaybackConfigurationResponse {
/**
* 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.
*/
AdDecisionServerUrl?: __string;
/**
* The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
*/
AvailSuppression?: AvailSuppression;
/**
* The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.
*/
Bumper?: Bumper;
/**
* The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
*/
CdnConfiguration?: CdnConfiguration;
/**
* The configuration for DASH content.
*/
DashConfiguration?: DashConfiguration;
/**
* The configuration for HLS content.
*/
HlsConfiguration?: HlsConfiguration;
/**
* The configuration for pre-roll ad insertion.
*/
LivePreRollConfiguration?: LivePreRollConfiguration;
/**
* The identifier for the playback configuration.
*/
Name?: __string;
/**
* The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
*/
PersonalizationThresholdSeconds?: __integerMin1;
/**
* The Amazon Resource Name (ARN) for the playback configuration.
*/
PlaybackConfigurationArn?: __string;
/**
* The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
*/
PlaybackEndpointPrefix?: __string;
/**
* The URL that the player uses to initialize a session that uses client-side reporting.
*/
SessionInitializationEndpointPrefix?: __string;
/**
* 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.
*/
SlateAdUrl?: __string;
/**
* The tags assigned to the playback configuration.
*/
Tags?: __mapOf__string;
/**
* 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.
*/
TranscodeProfileName?: __string;
/**
* The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
*/
VideoContentSourceUrl?: __string;
}
export interface HlsConfiguration {
/**
* The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
*/
ManifestEndpointPrefix?: __string;
}
export interface ListPlaybackConfigurationsRequest {
/**
* Maximum number of records to return.
*/
MaxResults?: __integerMin1Max100;
/**
* Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
*/
NextToken?: __string;
}
export interface ListPlaybackConfigurationsResponse {
/**
* 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.
*/
Items?: __listOfPlaybackConfigurations;
/**
* Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
*/
NextToken?: __string;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.
*/
ResourceArn: __string;
}
export interface ListTagsForResourceResponse {
/**
* A comma-separated list of tag key:value pairs. For example:
{
"Key1": "Value1",
"Key2": "Value2"
}
*/
Tags?: __mapOf__string;
}
export type OriginManifestType = "SINGLE_PERIOD"|"MULTI_PERIOD"|string;
export type Mode = "OFF"|"BEHIND_LIVE_EDGE"|string;
export interface PlaybackConfiguration {
/**
* 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.
*/
AdDecisionServerUrl?: __string;
/**
* The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
*/
AvailSuppression?: AvailSuppression;
/**
* The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.
*/
Bumper?: Bumper;
/**
* The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
*/
CdnConfiguration?: CdnConfiguration;
/**
* The configuration for DASH content.
*/
DashConfiguration?: DashConfiguration;
/**
* The configuration for HLS content.
*/
HlsConfiguration?: HlsConfiguration;
/**
* The identifier for the playback configuration.
*/
Name?: __string;
/**
* The Amazon Resource Name (ARN) for the playback configuration.
*/
PlaybackConfigurationArn?: __string;
/**
* The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
*/
PlaybackEndpointPrefix?: __string;
/**
* The URL that the player uses to initialize a session that uses client-side reporting.
*/
SessionInitializationEndpointPrefix?: __string;
/**
* 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.
*/
SlateAdUrl?: __string;
/**
* The tags assigned to the playback configuration.
*/
Tags?: __mapOf__string;
/**
* 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.
*/
TranscodeProfileName?: __string;
/**
* The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
*/
PersonalizationThresholdSeconds?: __integerMin1;
/**
* The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
*/
VideoContentSourceUrl?: __string;
}
export interface LivePreRollConfiguration {
/**
* 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.
*/
AdDecisionServerUrl?: __string;
/**
* 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.
*/
MaxDurationSeconds?: __integer;
}
export interface PutPlaybackConfigurationRequest {
/**
* 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.
*/
AdDecisionServerUrl?: __string;
/**
* The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
*/
AvailSuppression?: AvailSuppression;
/**
* The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.
*/
Bumper?: Bumper;
/**
* The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
*/
CdnConfiguration?: CdnConfiguration;
/**
* The configuration for DASH content.
*/
DashConfiguration?: DashConfigurationForPut;
/**
* The configuration for pre-roll ad insertion.
*/
LivePreRollConfiguration?: LivePreRollConfiguration;
/**
* The identifier for the playback configuration.
*/
Name?: __string;
/**
* The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
*/
PersonalizationThresholdSeconds?: __integerMin1;
/**
* 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.
*/
SlateAdUrl?: __string;
/**
* The tags to assign to the playback configuration.
*/
Tags?: __mapOf__string;
/**
* 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.
*/
TranscodeProfileName?: __string;
/**
* The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
*/
VideoContentSourceUrl?: __string;
}
export interface PutPlaybackConfigurationResponse {
/**
* 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.
*/
AdDecisionServerUrl?: __string;
/**
* The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.
*/
AvailSuppression?: AvailSuppression;
/**
* The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.
*/
Bumper?: Bumper;
/**
* The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
*/
CdnConfiguration?: CdnConfiguration;
/**
* The configuration for DASH content.
*/
DashConfiguration?: DashConfiguration;
/**
* The configuration for HLS content.
*/
HlsConfiguration?: HlsConfiguration;
/**
* The configuration for pre-roll ad insertion.
*/
LivePreRollConfiguration?: LivePreRollConfiguration;
/**
* The identifier for the playback configuration.
*/
Name?: __string;
/**
* The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
*/
PersonalizationThresholdSeconds?: __integerMin1;
/**
* The Amazon Resource Name (ARN) for the playback configuration.
*/
PlaybackConfigurationArn?: __string;
/**
* The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
*/
PlaybackEndpointPrefix?: __string;
/**
* The URL that the player uses to initialize a session that uses client-side reporting.
*/
SessionInitializationEndpointPrefix?: __string;
/**
* 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.
*/
SlateAdUrl?: __string;
/**
* The tags assigned to the playback configuration.
*/
Tags?: __mapOf__string;
/**
* 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.
*/
TranscodeProfileName?: __string;
/**
* The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
*/
VideoContentSourceUrl?: __string;
}
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.
*/
ResourceArn: __string;
/**
* A comma-separated list of tag key:value pairs. For example:
{
"Key1": "Value1",
"Key2": "Value2"
}
*/
Tags: __mapOf__string;
}
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.
*/
ResourceArn: __string;
/**
* A comma-separated list of the tag keys to remove from the playback configuration.
*/
TagKeys: __listOf__string;
}
export type __integer = number;
export type __integerMin1 = number;
export type __integerMin1Max100 = number;
export type __listOfPlaybackConfigurations = PlaybackConfiguration[];
export type __listOf__string = __string[];
export type __mapOf__string = {[key: string]: __string};
export type __string = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-04-23"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the MediaTailor client.
*/
export import Types = MediaTailor;
}
export = MediaTailor;