aws-sdk-mediatailor 1.36.0 → 1.37.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mediatailor.rb +2 -2
- data/lib/aws-sdk-mediatailor/client.rb +1173 -21
- data/lib/aws-sdk-mediatailor/client_api.rb +706 -14
- data/lib/aws-sdk-mediatailor/types.rb +2638 -366
- metadata +2 -2
@@ -10,6 +10,111 @@
|
|
10
10
|
module Aws::MediaTailor
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Access configuration parameters.
|
14
|
+
#
|
15
|
+
# @note When making an API call, you may pass AccessConfiguration
|
16
|
+
# data as a hash:
|
17
|
+
#
|
18
|
+
# {
|
19
|
+
# access_type: "S3_SIGV4", # accepts S3_SIGV4
|
20
|
+
# }
|
21
|
+
#
|
22
|
+
# @!attribute [rw] access_type
|
23
|
+
# The type of authentication used to access content from
|
24
|
+
# HttpConfiguration::BaseUrl on your source location. Accepted value:
|
25
|
+
# S3\_SIGV4.
|
26
|
+
#
|
27
|
+
# S3\_SIGV4 - AWS Signature Version 4 authentication for Amazon S3
|
28
|
+
# hosted virtual-style access. If your source location base URL is an
|
29
|
+
# Amazon S3 bucket, MediaTailor can use AWS Signature Version 4
|
30
|
+
# (SigV4) authentication to access the bucket where your source
|
31
|
+
# content is stored. Your MediaTailor source location baseURL must
|
32
|
+
# follow the S3 virtual hosted-style request URL format. For example,
|
33
|
+
# https://bucket-name.s3.Region.amazonaws.com/key-name.
|
34
|
+
#
|
35
|
+
# Before you can use S3\_SIGV4, you must meet these requirements:
|
36
|
+
#
|
37
|
+
# • You must allow MediaTailor to access your S3 bucket by granting
|
38
|
+
# mediatailor.amazonaws.com principal access in IAM. For information
|
39
|
+
# about configuring access in IAM, see Access management in the IAM
|
40
|
+
# User Guide.
|
41
|
+
#
|
42
|
+
# • The mediatailor.amazonaws.com service principal must have
|
43
|
+
# permissions to read all top level manifests referenced by the
|
44
|
+
# VodSource packaging configurations.
|
45
|
+
#
|
46
|
+
# • The caller of the API must have s3:GetObject IAM permissions to
|
47
|
+
# read all top level manifests referenced by your MediaTailor
|
48
|
+
# VodSource packaging configurations.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AccessConfiguration AWS API Documentation
|
52
|
+
#
|
53
|
+
class AccessConfiguration < Struct.new(
|
54
|
+
:access_type)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
59
|
+
# Ad break configuration parameters.
|
60
|
+
#
|
61
|
+
# @note When making an API call, you may pass AdBreak
|
62
|
+
# data as a hash:
|
63
|
+
#
|
64
|
+
# {
|
65
|
+
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
|
66
|
+
# offset_millis: 1,
|
67
|
+
# slate: {
|
68
|
+
# source_location_name: "__string",
|
69
|
+
# vod_source_name: "__string",
|
70
|
+
# },
|
71
|
+
# splice_insert_message: {
|
72
|
+
# avail_num: 1,
|
73
|
+
# avails_expected: 1,
|
74
|
+
# splice_event_id: 1,
|
75
|
+
# unique_program_id: 1,
|
76
|
+
# },
|
77
|
+
# }
|
78
|
+
#
|
79
|
+
# @!attribute [rw] message_type
|
80
|
+
# The SCTE-35 ad insertion type. Accepted value: SPLICE\_INSERT.
|
81
|
+
# @return [String]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] offset_millis
|
84
|
+
# How long (in milliseconds) after the beginning of the program that
|
85
|
+
# an ad starts. This value must fall within 100ms of a segment
|
86
|
+
# boundary, otherwise the ad break will be skipped.
|
87
|
+
# @return [Integer]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] slate
|
90
|
+
# Ad break slate configuration.
|
91
|
+
# @return [Types::SlateSource]
|
92
|
+
#
|
93
|
+
# @!attribute [rw] splice_insert_message
|
94
|
+
# This defines the SCTE-35 splice\_insert() message inserted around
|
95
|
+
# the ad. For information about using splice\_insert(), see the
|
96
|
+
# SCTE-35 specficiaiton, section 9.7.3.1.
|
97
|
+
# @return [Types::SpliceInsertMessage]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdBreak AWS API Documentation
|
100
|
+
#
|
101
|
+
class AdBreak < Struct.new(
|
102
|
+
:message_type,
|
103
|
+
:offset_millis,
|
104
|
+
:slate,
|
105
|
+
:splice_insert_message)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN,
|
111
|
+
# EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin
|
112
|
+
# manifest to the MediaTailor personalized manifest.
|
113
|
+
#
|
114
|
+
# No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT
|
115
|
+
# has a value of 60, but no ads are filled for that ad break,
|
116
|
+
# MediaTailor will not set the value to 0.
|
117
|
+
#
|
13
118
|
# @note When making an API call, you may pass AdMarkerPassthrough
|
14
119
|
# data as a hash:
|
15
120
|
#
|
@@ -18,6 +123,7 @@ module Aws::MediaTailor
|
|
18
123
|
# }
|
19
124
|
#
|
20
125
|
# @!attribute [rw] enabled
|
126
|
+
# Enables ad marker passthrough for your configuration.
|
21
127
|
# @return [Boolean]
|
22
128
|
#
|
23
129
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdMarkerPassthrough AWS API Documentation
|
@@ -28,6 +134,13 @@ module Aws::MediaTailor
|
|
28
134
|
include Aws::Structure
|
29
135
|
end
|
30
136
|
|
137
|
+
# The configuration for avail suppression, also known as ad suppression.
|
138
|
+
# For more information about ad suppression, see [Ad Suppression][1].
|
139
|
+
#
|
140
|
+
#
|
141
|
+
#
|
142
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
143
|
+
#
|
31
144
|
# @note When making an API call, you may pass AvailSuppression
|
32
145
|
# data as a hash:
|
33
146
|
#
|
@@ -37,12 +150,23 @@ module Aws::MediaTailor
|
|
37
150
|
# }
|
38
151
|
#
|
39
152
|
# @!attribute [rw] mode
|
153
|
+
# Sets the ad suppression mode. By default, ad suppression is off and
|
154
|
+
# all ad breaks are filled with ads or slate. When Mode is set to
|
155
|
+
# BEHIND\_LIVE\_EDGE, ad suppression is active and MediaTailor won't
|
156
|
+
# fill ad breaks on or behind the ad suppression Value time in the
|
157
|
+
# manifest lookback window.
|
40
158
|
# @return [String]
|
41
159
|
#
|
42
160
|
# @!attribute [rw] value
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
161
|
+
# A live edge offset time in HH:MM:SS. MediaTailor won't fill ad
|
162
|
+
# breaks on or behind this time in the manifest lookback window. If
|
163
|
+
# Value is set to 00:00:00, it is in sync with the live edge, and
|
164
|
+
# MediaTailor won't fill any ad breaks on or behind the live edge. If
|
165
|
+
# you set a Value time, MediaTailor won't fill any ad breaks on or
|
166
|
+
# behind this time in the manifest lookback window. For example, if
|
167
|
+
# you set 00:45:00, then MediaTailor will fill ad breaks that occur
|
168
|
+
# within 45 minutes behind the live edge, but won't fill ad breaks on
|
169
|
+
# or behind 45 minutes behind the live edge.
|
46
170
|
# @return [String]
|
47
171
|
#
|
48
172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AvailSuppression AWS API Documentation
|
@@ -54,10 +178,11 @@ module Aws::MediaTailor
|
|
54
178
|
include Aws::Structure
|
55
179
|
end
|
56
180
|
|
57
|
-
#
|
181
|
+
# A request contains unexpected data.
|
58
182
|
#
|
59
183
|
# @!attribute [rw] message
|
60
|
-
#
|
184
|
+
# Constructs a new BadRequestException with the specified error
|
185
|
+
# message.
|
61
186
|
# @return [String]
|
62
187
|
#
|
63
188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/BadRequestException AWS API Documentation
|
@@ -69,7 +194,12 @@ module Aws::MediaTailor
|
|
69
194
|
end
|
70
195
|
|
71
196
|
# The configuration for bumpers. Bumpers are short audio or video clips
|
72
|
-
# that play at the start or before the end of an ad break.
|
197
|
+
# that play at the start or before the end of an ad break. To learn more
|
198
|
+
# about bumpers, see [Bumpers][1].
|
199
|
+
#
|
200
|
+
#
|
201
|
+
#
|
202
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
|
73
203
|
#
|
74
204
|
# @note When making an API call, you may pass Bumper
|
75
205
|
# data as a hash:
|
@@ -80,9 +210,11 @@ module Aws::MediaTailor
|
|
80
210
|
# }
|
81
211
|
#
|
82
212
|
# @!attribute [rw] end_url
|
213
|
+
# The URL for the end bumper asset.
|
83
214
|
# @return [String]
|
84
215
|
#
|
85
216
|
# @!attribute [rw] start_url
|
217
|
+
# The URL for the start bumper asset.
|
86
218
|
# @return [String]
|
87
219
|
#
|
88
220
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Bumper AWS API Documentation
|
@@ -109,11 +241,11 @@ module Aws::MediaTailor
|
|
109
241
|
# A non-default content delivery network (CDN) to serve ad segments.
|
110
242
|
# By default, AWS Elemental MediaTailor uses Amazon CloudFront with
|
111
243
|
# default cache settings as its CDN for ad segments. To set up an
|
112
|
-
# alternate CDN, create a rule in your CDN for the
|
113
|
-
# ads.mediatailor.<region
|
114
|
-
# name in this AdSegmentUrlPrefix. When AWS Elemental
|
115
|
-
# serves a manifest, it reports your CDN as the source for
|
116
|
-
# segments.
|
244
|
+
# alternate CDN, create a rule in your CDN for the origin
|
245
|
+
# ads.mediatailor.&lt;region>.amazonaws.com. Then specify the
|
246
|
+
# rule's name in this AdSegmentUrlPrefix. When AWS Elemental
|
247
|
+
# MediaTailor serves a manifest, it reports your CDN as the source for
|
248
|
+
# ad segments.
|
117
249
|
# @return [String]
|
118
250
|
#
|
119
251
|
# @!attribute [rw] content_segment_url_prefix
|
@@ -134,6 +266,438 @@ module Aws::MediaTailor
|
|
134
266
|
include Aws::Structure
|
135
267
|
end
|
136
268
|
|
269
|
+
# The configuration parameters for a channel.
|
270
|
+
#
|
271
|
+
# @!attribute [rw] arn
|
272
|
+
# The ARN of the channel.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] channel_name
|
276
|
+
# The name of the channel.
|
277
|
+
# @return [String]
|
278
|
+
#
|
279
|
+
# @!attribute [rw] channel_state
|
280
|
+
# Returns the state whether the channel is running or not.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] creation_time
|
284
|
+
# The timestamp of when the channel was created.
|
285
|
+
# @return [Time]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] last_modified_time
|
288
|
+
# The timestamp of when the channel was last modified.
|
289
|
+
# @return [Time]
|
290
|
+
#
|
291
|
+
# @!attribute [rw] outputs
|
292
|
+
# The channel's output properties.
|
293
|
+
# @return [Array<Types::ResponseOutputItem>]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] playback_mode
|
296
|
+
# The type of playback mode for this channel. Possible values: ONCE or
|
297
|
+
# LOOP.
|
298
|
+
# @return [String]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] tags
|
301
|
+
# The tags to assign to the channel.
|
302
|
+
# @return [Hash<String,String>]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Channel AWS API Documentation
|
305
|
+
#
|
306
|
+
class Channel < Struct.new(
|
307
|
+
:arn,
|
308
|
+
:channel_name,
|
309
|
+
:channel_state,
|
310
|
+
:creation_time,
|
311
|
+
:last_modified_time,
|
312
|
+
:outputs,
|
313
|
+
:playback_mode,
|
314
|
+
:tags)
|
315
|
+
SENSITIVE = []
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# The configuration for this channel.
|
320
|
+
#
|
321
|
+
# @note When making an API call, you may pass CreateChannelRequest
|
322
|
+
# data as a hash:
|
323
|
+
#
|
324
|
+
# {
|
325
|
+
# channel_name: "__string", # required
|
326
|
+
# outputs: [ # required
|
327
|
+
# {
|
328
|
+
# dash_playlist_settings: {
|
329
|
+
# manifest_window_seconds: 1,
|
330
|
+
# min_buffer_time_seconds: 1,
|
331
|
+
# min_update_period_seconds: 1,
|
332
|
+
# suggested_presentation_delay_seconds: 1,
|
333
|
+
# },
|
334
|
+
# hls_playlist_settings: {
|
335
|
+
# manifest_window_seconds: 1,
|
336
|
+
# },
|
337
|
+
# manifest_name: "__string", # required
|
338
|
+
# source_group: "__string", # required
|
339
|
+
# },
|
340
|
+
# ],
|
341
|
+
# playback_mode: "LOOP", # required, accepts LOOP
|
342
|
+
# tags: {
|
343
|
+
# "__string" => "__string",
|
344
|
+
# },
|
345
|
+
# }
|
346
|
+
#
|
347
|
+
# @!attribute [rw] channel_name
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] outputs
|
351
|
+
# The channel's output properties.
|
352
|
+
# @return [Array<Types::RequestOutputItem>]
|
353
|
+
#
|
354
|
+
# @!attribute [rw] playback_mode
|
355
|
+
# The type of playback mode for this channel. The only supported value
|
356
|
+
# is LOOP.
|
357
|
+
# @return [String]
|
358
|
+
#
|
359
|
+
# @!attribute [rw] tags
|
360
|
+
# The tags to assign to the channel.
|
361
|
+
# @return [Hash<String,String>]
|
362
|
+
#
|
363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannelRequest AWS API Documentation
|
364
|
+
#
|
365
|
+
class CreateChannelRequest < Struct.new(
|
366
|
+
:channel_name,
|
367
|
+
:outputs,
|
368
|
+
:playback_mode,
|
369
|
+
:tags)
|
370
|
+
SENSITIVE = []
|
371
|
+
include Aws::Structure
|
372
|
+
end
|
373
|
+
|
374
|
+
# @!attribute [rw] arn
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @!attribute [rw] channel_name
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] channel_state
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] creation_time
|
384
|
+
# @return [Time]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] last_modified_time
|
387
|
+
# @return [Time]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] outputs
|
390
|
+
# @return [Array<Types::ResponseOutputItem>]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] playback_mode
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] tags
|
396
|
+
# @return [Hash<String,String>]
|
397
|
+
#
|
398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannelResponse AWS API Documentation
|
399
|
+
#
|
400
|
+
class CreateChannelResponse < Struct.new(
|
401
|
+
:arn,
|
402
|
+
:channel_name,
|
403
|
+
:channel_state,
|
404
|
+
:creation_time,
|
405
|
+
:last_modified_time,
|
406
|
+
:outputs,
|
407
|
+
:playback_mode,
|
408
|
+
:tags)
|
409
|
+
SENSITIVE = []
|
410
|
+
include Aws::Structure
|
411
|
+
end
|
412
|
+
|
413
|
+
# Program configuration parameters.
|
414
|
+
#
|
415
|
+
# @note When making an API call, you may pass CreateProgramRequest
|
416
|
+
# data as a hash:
|
417
|
+
#
|
418
|
+
# {
|
419
|
+
# ad_breaks: [
|
420
|
+
# {
|
421
|
+
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
|
422
|
+
# offset_millis: 1,
|
423
|
+
# slate: {
|
424
|
+
# source_location_name: "__string",
|
425
|
+
# vod_source_name: "__string",
|
426
|
+
# },
|
427
|
+
# splice_insert_message: {
|
428
|
+
# avail_num: 1,
|
429
|
+
# avails_expected: 1,
|
430
|
+
# splice_event_id: 1,
|
431
|
+
# unique_program_id: 1,
|
432
|
+
# },
|
433
|
+
# },
|
434
|
+
# ],
|
435
|
+
# channel_name: "__string", # required
|
436
|
+
# program_name: "__string", # required
|
437
|
+
# schedule_configuration: { # required
|
438
|
+
# transition: { # required
|
439
|
+
# relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
|
440
|
+
# relative_program: "__string",
|
441
|
+
# type: "__string", # required
|
442
|
+
# },
|
443
|
+
# },
|
444
|
+
# source_location_name: "__string", # required
|
445
|
+
# vod_source_name: "__string", # required
|
446
|
+
# }
|
447
|
+
#
|
448
|
+
# @!attribute [rw] ad_breaks
|
449
|
+
# The ad break configuration settings.
|
450
|
+
# @return [Array<Types::AdBreak>]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] channel_name
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] program_name
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] schedule_configuration
|
459
|
+
# The schedule configuration settings.
|
460
|
+
# @return [Types::ScheduleConfiguration]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] source_location_name
|
463
|
+
# The name of the source location.
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] vod_source_name
|
467
|
+
# The name that's used to refer to a VOD source.
|
468
|
+
# @return [String]
|
469
|
+
#
|
470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateProgramRequest AWS API Documentation
|
471
|
+
#
|
472
|
+
class CreateProgramRequest < Struct.new(
|
473
|
+
:ad_breaks,
|
474
|
+
:channel_name,
|
475
|
+
:program_name,
|
476
|
+
:schedule_configuration,
|
477
|
+
:source_location_name,
|
478
|
+
:vod_source_name)
|
479
|
+
SENSITIVE = []
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
482
|
+
|
483
|
+
# @!attribute [rw] ad_breaks
|
484
|
+
# @return [Array<Types::AdBreak>]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] arn
|
487
|
+
# @return [String]
|
488
|
+
#
|
489
|
+
# @!attribute [rw] channel_name
|
490
|
+
# @return [String]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] creation_time
|
493
|
+
# @return [Time]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] program_name
|
496
|
+
# @return [String]
|
497
|
+
#
|
498
|
+
# @!attribute [rw] source_location_name
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] vod_source_name
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateProgramResponse AWS API Documentation
|
505
|
+
#
|
506
|
+
class CreateProgramResponse < Struct.new(
|
507
|
+
:ad_breaks,
|
508
|
+
:arn,
|
509
|
+
:channel_name,
|
510
|
+
:creation_time,
|
511
|
+
:program_name,
|
512
|
+
:source_location_name,
|
513
|
+
:vod_source_name)
|
514
|
+
SENSITIVE = []
|
515
|
+
include Aws::Structure
|
516
|
+
end
|
517
|
+
|
518
|
+
# Source location configuration parameters.
|
519
|
+
#
|
520
|
+
# @note When making an API call, you may pass CreateSourceLocationRequest
|
521
|
+
# data as a hash:
|
522
|
+
#
|
523
|
+
# {
|
524
|
+
# access_configuration: {
|
525
|
+
# access_type: "S3_SIGV4", # accepts S3_SIGV4
|
526
|
+
# },
|
527
|
+
# default_segment_delivery_configuration: {
|
528
|
+
# base_url: "__string",
|
529
|
+
# },
|
530
|
+
# http_configuration: { # required
|
531
|
+
# base_url: "__string", # required
|
532
|
+
# },
|
533
|
+
# source_location_name: "__string", # required
|
534
|
+
# tags: {
|
535
|
+
# "__string" => "__string",
|
536
|
+
# },
|
537
|
+
# }
|
538
|
+
#
|
539
|
+
# @!attribute [rw] access_configuration
|
540
|
+
# Access configuration parameters. Configures the type of
|
541
|
+
# authentication used to access content from your source location.
|
542
|
+
# @return [Types::AccessConfiguration]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] default_segment_delivery_configuration
|
545
|
+
# The optional configuration for the server that serves segments.
|
546
|
+
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] http_configuration
|
549
|
+
# The source's HTTP package configurations.
|
550
|
+
# @return [Types::HttpConfiguration]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] source_location_name
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] tags
|
556
|
+
# The tags to assign to the source location.
|
557
|
+
# @return [Hash<String,String>]
|
558
|
+
#
|
559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationRequest AWS API Documentation
|
560
|
+
#
|
561
|
+
class CreateSourceLocationRequest < Struct.new(
|
562
|
+
:access_configuration,
|
563
|
+
:default_segment_delivery_configuration,
|
564
|
+
:http_configuration,
|
565
|
+
:source_location_name,
|
566
|
+
:tags)
|
567
|
+
SENSITIVE = []
|
568
|
+
include Aws::Structure
|
569
|
+
end
|
570
|
+
|
571
|
+
# @!attribute [rw] access_configuration
|
572
|
+
# Access configuration parameters.
|
573
|
+
# @return [Types::AccessConfiguration]
|
574
|
+
#
|
575
|
+
# @!attribute [rw] arn
|
576
|
+
# @return [String]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] creation_time
|
579
|
+
# @return [Time]
|
580
|
+
#
|
581
|
+
# @!attribute [rw] default_segment_delivery_configuration
|
582
|
+
# The optional configuration for a server that serves segments. Use
|
583
|
+
# this if you want the segment delivery server to be different from
|
584
|
+
# the source location server. For example, you can configure your
|
585
|
+
# source location server to be an origination server, such as
|
586
|
+
# MediaPackage, and the segment delivery server to be a content
|
587
|
+
# delivery network (CDN), such as CloudFront. If you don't specify a
|
588
|
+
# segment delivery server, then the source location server is used.
|
589
|
+
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] http_configuration
|
592
|
+
# The HTTP configuration for the source location.
|
593
|
+
# @return [Types::HttpConfiguration]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] last_modified_time
|
596
|
+
# @return [Time]
|
597
|
+
#
|
598
|
+
# @!attribute [rw] source_location_name
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] tags
|
602
|
+
# @return [Hash<String,String>]
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationResponse AWS API Documentation
|
605
|
+
#
|
606
|
+
class CreateSourceLocationResponse < Struct.new(
|
607
|
+
:access_configuration,
|
608
|
+
:arn,
|
609
|
+
:creation_time,
|
610
|
+
:default_segment_delivery_configuration,
|
611
|
+
:http_configuration,
|
612
|
+
:last_modified_time,
|
613
|
+
:source_location_name,
|
614
|
+
:tags)
|
615
|
+
SENSITIVE = []
|
616
|
+
include Aws::Structure
|
617
|
+
end
|
618
|
+
|
619
|
+
# The VOD source configuration parameters.
|
620
|
+
#
|
621
|
+
# @note When making an API call, you may pass CreateVodSourceRequest
|
622
|
+
# data as a hash:
|
623
|
+
#
|
624
|
+
# {
|
625
|
+
# http_package_configurations: [ # required
|
626
|
+
# {
|
627
|
+
# path: "__string", # required
|
628
|
+
# source_group: "__string", # required
|
629
|
+
# type: "DASH", # required, accepts DASH, HLS
|
630
|
+
# },
|
631
|
+
# ],
|
632
|
+
# source_location_name: "__string", # required
|
633
|
+
# tags: {
|
634
|
+
# "__string" => "__string",
|
635
|
+
# },
|
636
|
+
# vod_source_name: "__string", # required
|
637
|
+
# }
|
638
|
+
#
|
639
|
+
# @!attribute [rw] http_package_configurations
|
640
|
+
# An array of HTTP package configuration parameters for this VOD
|
641
|
+
# source.
|
642
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] source_location_name
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @!attribute [rw] tags
|
648
|
+
# The tags to assign to the VOD source.
|
649
|
+
# @return [Hash<String,String>]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] vod_source_name
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceRequest AWS API Documentation
|
655
|
+
#
|
656
|
+
class CreateVodSourceRequest < Struct.new(
|
657
|
+
:http_package_configurations,
|
658
|
+
:source_location_name,
|
659
|
+
:tags,
|
660
|
+
:vod_source_name)
|
661
|
+
SENSITIVE = []
|
662
|
+
include Aws::Structure
|
663
|
+
end
|
664
|
+
|
665
|
+
# @!attribute [rw] arn
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] creation_time
|
669
|
+
# @return [Time]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] http_package_configurations
|
672
|
+
# The VOD source's HTTP package configuration settings.
|
673
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] last_modified_time
|
676
|
+
# @return [Time]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] source_location_name
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] tags
|
682
|
+
# @return [Hash<String,String>]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] vod_source_name
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceResponse AWS API Documentation
|
688
|
+
#
|
689
|
+
class CreateVodSourceResponse < Struct.new(
|
690
|
+
:arn,
|
691
|
+
:creation_time,
|
692
|
+
:http_package_configurations,
|
693
|
+
:last_modified_time,
|
694
|
+
:source_location_name,
|
695
|
+
:tags,
|
696
|
+
:vod_source_name)
|
697
|
+
SENSITIVE = []
|
698
|
+
include Aws::Structure
|
699
|
+
end
|
700
|
+
|
137
701
|
# The configuration for DASH content.
|
138
702
|
#
|
139
703
|
# @!attribute [rw] manifest_endpoint_prefix
|
@@ -213,448 +777,636 @@ module Aws::MediaTailor
|
|
213
777
|
include Aws::Structure
|
214
778
|
end
|
215
779
|
|
216
|
-
#
|
780
|
+
# Dash manifest configuration parameters.
|
781
|
+
#
|
782
|
+
# @note When making an API call, you may pass DashPlaylistSettings
|
217
783
|
# data as a hash:
|
218
784
|
#
|
219
785
|
# {
|
220
|
-
#
|
786
|
+
# manifest_window_seconds: 1,
|
787
|
+
# min_buffer_time_seconds: 1,
|
788
|
+
# min_update_period_seconds: 1,
|
789
|
+
# suggested_presentation_delay_seconds: 1,
|
221
790
|
# }
|
222
791
|
#
|
223
|
-
# @!attribute [rw]
|
224
|
-
#
|
792
|
+
# @!attribute [rw] manifest_window_seconds
|
793
|
+
# The total duration (in seconds) of each manifest. Minimum value: 30
|
794
|
+
# seconds. Maximum value: 3600 seconds.
|
795
|
+
# @return [Integer]
|
225
796
|
#
|
226
|
-
#
|
797
|
+
# @!attribute [rw] min_buffer_time_seconds
|
798
|
+
# Minimum amount of content (measured in seconds) that a player must
|
799
|
+
# keep available in the buffer. Minimum value: 2 seconds. Maximum
|
800
|
+
# value: 60 seconds.
|
801
|
+
# @return [Integer]
|
227
802
|
#
|
228
|
-
|
229
|
-
|
803
|
+
# @!attribute [rw] min_update_period_seconds
|
804
|
+
# Minimum amount of time (in seconds) that the player should wait
|
805
|
+
# before requesting updates to the manifest. Minimum value: 2 seconds.
|
806
|
+
# Maximum value: 60 seconds.
|
807
|
+
# @return [Integer]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] suggested_presentation_delay_seconds
|
810
|
+
# Amount of time (in seconds) that the player should be from the live
|
811
|
+
# point at the end of the manifest. Minimum value: 2 seconds. Maximum
|
812
|
+
# value: 60 seconds.
|
813
|
+
# @return [Integer]
|
814
|
+
#
|
815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashPlaylistSettings AWS API Documentation
|
816
|
+
#
|
817
|
+
class DashPlaylistSettings < Struct.new(
|
818
|
+
:manifest_window_seconds,
|
819
|
+
:min_buffer_time_seconds,
|
820
|
+
:min_update_period_seconds,
|
821
|
+
:suggested_presentation_delay_seconds)
|
230
822
|
SENSITIVE = []
|
231
823
|
include Aws::Structure
|
232
824
|
end
|
233
825
|
|
234
|
-
#
|
235
|
-
#
|
236
|
-
|
237
|
-
|
238
|
-
#
|
826
|
+
# The optional configuration for a server that serves segments. Use this
|
827
|
+
# if you want the segment delivery server to be different from the
|
828
|
+
# source location server. For example, you can configure your source
|
829
|
+
# location server to be an origination server, such as MediaPackage, and
|
830
|
+
# the segment delivery server to be a content delivery network (CDN),
|
831
|
+
# such as CloudFront. If you don't specify a segment delivery server,
|
832
|
+
# then the source location server is used.
|
833
|
+
#
|
834
|
+
# @note When making an API call, you may pass DefaultSegmentDeliveryConfiguration
|
239
835
|
# data as a hash:
|
240
836
|
#
|
241
837
|
# {
|
242
|
-
#
|
838
|
+
# base_url: "__string",
|
243
839
|
# }
|
244
840
|
#
|
245
|
-
# @!attribute [rw]
|
841
|
+
# @!attribute [rw] base_url
|
842
|
+
# The hostname of the server that will be used to serve segments. This
|
843
|
+
# string must include the protocol, such as **https://**.
|
246
844
|
# @return [String]
|
247
845
|
#
|
248
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DefaultSegmentDeliveryConfiguration AWS API Documentation
|
249
847
|
#
|
250
|
-
class
|
251
|
-
:
|
848
|
+
class DefaultSegmentDeliveryConfiguration < Struct.new(
|
849
|
+
:base_url)
|
252
850
|
SENSITIVE = []
|
253
851
|
include Aws::Structure
|
254
852
|
end
|
255
853
|
|
256
|
-
#
|
257
|
-
# The URL for the ad decision server (ADS). This includes the
|
258
|
-
# specification of static parameters and placeholders for dynamic
|
259
|
-
# parameters. AWS Elemental MediaTailor substitutes player-specific
|
260
|
-
# and session-specific parameters as needed when calling the ADS.
|
261
|
-
# Alternately, for testing, you can provide a static VAST URL. The
|
262
|
-
# maximum length is 25,000 characters.
|
263
|
-
# @return [String]
|
264
|
-
#
|
265
|
-
# @!attribute [rw] avail_suppression
|
266
|
-
# The configuration for Avail Suppression.
|
267
|
-
# @return [Types::AvailSuppression]
|
268
|
-
#
|
269
|
-
# @!attribute [rw] bumper
|
270
|
-
# The configuration for bumpers. Bumpers are short audio or video
|
271
|
-
# clips that play at the start or before the end of an ad break.
|
272
|
-
# @return [Types::Bumper]
|
854
|
+
# This response includes only the "type" : "object" property.
|
273
855
|
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
# Amazon CloudFront, for content and ad segment management.
|
277
|
-
# @return [Types::CdnConfiguration]
|
856
|
+
# @note When making an API call, you may pass DeleteChannelPolicyRequest
|
857
|
+
# data as a hash:
|
278
858
|
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
# @return [Integer]
|
859
|
+
# {
|
860
|
+
# channel_name: "__string", # required
|
861
|
+
# }
|
283
862
|
#
|
284
|
-
# @!attribute [rw]
|
285
|
-
#
|
286
|
-
# @return [Hash<String,Hash<String,String>>]
|
863
|
+
# @!attribute [rw] channel_name
|
864
|
+
# @return [String]
|
287
865
|
#
|
288
|
-
#
|
289
|
-
# The configuration for DASH content.
|
290
|
-
# @return [Types::DashConfiguration]
|
866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyRequest AWS API Documentation
|
291
867
|
#
|
292
|
-
|
293
|
-
|
294
|
-
|
868
|
+
class DeleteChannelPolicyRequest < Struct.new(
|
869
|
+
:channel_name)
|
870
|
+
SENSITIVE = []
|
871
|
+
include Aws::Structure
|
872
|
+
end
|
873
|
+
|
874
|
+
# This response includes only the "type" : "object" property.
|
295
875
|
#
|
296
|
-
#
|
297
|
-
# The configuration for pre-roll ad insertion.
|
298
|
-
# @return [Types::LivePreRollConfiguration]
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyResponse AWS API Documentation
|
299
877
|
#
|
300
|
-
|
301
|
-
|
302
|
-
#
|
303
|
-
#
|
304
|
-
# @return [Types::ManifestProcessingRules]
|
878
|
+
class DeleteChannelPolicyResponse < Aws::EmptyStructure; end
|
879
|
+
|
880
|
+
# @note When making an API call, you may pass DeleteChannelRequest
|
881
|
+
# data as a hash:
|
305
882
|
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
883
|
+
# {
|
884
|
+
# channel_name: "__string", # required
|
885
|
+
# }
|
309
886
|
#
|
310
|
-
# @!attribute [rw]
|
311
|
-
# The Amazon Resource Name (ARN) for the playback configuration.
|
887
|
+
# @!attribute [rw] channel_name
|
312
888
|
# @return [String]
|
313
889
|
#
|
314
|
-
#
|
315
|
-
# The URL that the player accesses to get a manifest from AWS
|
316
|
-
# Elemental MediaTailor. This session will use server-side reporting.
|
317
|
-
# @return [String]
|
890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelRequest AWS API Documentation
|
318
891
|
#
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
892
|
+
class DeleteChannelRequest < Struct.new(
|
893
|
+
:channel_name)
|
894
|
+
SENSITIVE = []
|
895
|
+
include Aws::Structure
|
896
|
+
end
|
897
|
+
|
898
|
+
# This response includes only the "type" : "object" property.
|
323
899
|
#
|
324
|
-
#
|
325
|
-
# The URL for a high-quality video asset to transcode and use to fill
|
326
|
-
# in time that's not used by ads. AWS Elemental MediaTailor shows the
|
327
|
-
# slate to fill in gaps in media content. Configuring the slate is
|
328
|
-
# optional for non-VPAID playback configurations. For VPAID, the slate
|
329
|
-
# is required because MediaTailor provides it in the slots designated
|
330
|
-
# for dynamic ad content. The slate must be a high-quality asset that
|
331
|
-
# contains both audio and video.
|
332
|
-
# @return [String]
|
900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelResponse AWS API Documentation
|
333
901
|
#
|
334
|
-
|
335
|
-
|
336
|
-
#
|
902
|
+
class DeleteChannelResponse < Aws::EmptyStructure; end
|
903
|
+
|
904
|
+
# @note When making an API call, you may pass DeletePlaybackConfigurationRequest
|
905
|
+
# data as a hash:
|
337
906
|
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
# defaults of MediaTailor. Use this only if you have already set up
|
342
|
-
# custom profiles with the help of AWS Support.
|
343
|
-
# @return [String]
|
907
|
+
# {
|
908
|
+
# name: "__string", # required
|
909
|
+
# }
|
344
910
|
#
|
345
|
-
# @!attribute [rw]
|
346
|
-
# The URL prefix for the master playlist for the stream, minus the
|
347
|
-
# asset ID. The maximum length is 512 characters.
|
911
|
+
# @!attribute [rw] name
|
348
912
|
# @return [String]
|
349
913
|
#
|
350
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfigurationRequest AWS API Documentation
|
351
915
|
#
|
352
|
-
class
|
353
|
-
:
|
354
|
-
:avail_suppression,
|
355
|
-
:bumper,
|
356
|
-
:cdn_configuration,
|
357
|
-
:personalization_threshold_seconds,
|
358
|
-
:configuration_aliases,
|
359
|
-
:dash_configuration,
|
360
|
-
:hls_configuration,
|
361
|
-
:live_pre_roll_configuration,
|
362
|
-
:manifest_processing_rules,
|
363
|
-
:name,
|
364
|
-
:playback_configuration_arn,
|
365
|
-
:playback_endpoint_prefix,
|
366
|
-
:session_initialization_endpoint_prefix,
|
367
|
-
:slate_ad_url,
|
368
|
-
:tags,
|
369
|
-
:transcode_profile_name,
|
370
|
-
:video_content_source_url)
|
916
|
+
class DeletePlaybackConfigurationRequest < Struct.new(
|
917
|
+
:name)
|
371
918
|
SENSITIVE = []
|
372
919
|
include Aws::Structure
|
373
920
|
end
|
374
921
|
|
375
|
-
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfigurationResponse AWS API Documentation
|
376
923
|
#
|
377
|
-
|
378
|
-
|
379
|
-
#
|
924
|
+
class DeletePlaybackConfigurationResponse < Aws::EmptyStructure; end
|
925
|
+
|
926
|
+
# @note When making an API call, you may pass DeleteProgramRequest
|
927
|
+
# data as a hash:
|
928
|
+
#
|
929
|
+
# {
|
930
|
+
# channel_name: "__string", # required
|
931
|
+
# program_name: "__string", # required
|
932
|
+
# }
|
933
|
+
#
|
934
|
+
# @!attribute [rw] channel_name
|
380
935
|
# @return [String]
|
381
936
|
#
|
382
|
-
#
|
937
|
+
# @!attribute [rw] program_name
|
938
|
+
# @return [String]
|
383
939
|
#
|
384
|
-
|
385
|
-
|
940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramRequest AWS API Documentation
|
941
|
+
#
|
942
|
+
class DeleteProgramRequest < Struct.new(
|
943
|
+
:channel_name,
|
944
|
+
:program_name)
|
386
945
|
SENSITIVE = []
|
387
946
|
include Aws::Structure
|
388
947
|
end
|
389
948
|
|
390
|
-
#
|
949
|
+
# This response includes only the "type" : "object" property.
|
950
|
+
#
|
951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramResponse AWS API Documentation
|
952
|
+
#
|
953
|
+
class DeleteProgramResponse < Aws::EmptyStructure; end
|
954
|
+
|
955
|
+
# @note When making an API call, you may pass DeleteSourceLocationRequest
|
391
956
|
# data as a hash:
|
392
957
|
#
|
393
958
|
# {
|
394
|
-
#
|
395
|
-
# next_token: "__string",
|
959
|
+
# source_location_name: "__string", # required
|
396
960
|
# }
|
397
961
|
#
|
398
|
-
# @!attribute [rw]
|
399
|
-
# @return [Integer]
|
400
|
-
#
|
401
|
-
# @!attribute [rw] next_token
|
962
|
+
# @!attribute [rw] source_location_name
|
402
963
|
# @return [String]
|
403
964
|
#
|
404
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationRequest AWS API Documentation
|
405
966
|
#
|
406
|
-
class
|
407
|
-
:
|
408
|
-
:next_token)
|
967
|
+
class DeleteSourceLocationRequest < Struct.new(
|
968
|
+
:source_location_name)
|
409
969
|
SENSITIVE = []
|
410
970
|
include Aws::Structure
|
411
971
|
end
|
412
972
|
|
413
|
-
#
|
414
|
-
# Array of playback configurations. This might be all the available
|
415
|
-
# configurations or a subset, depending on the settings that you
|
416
|
-
# provide and the total number of configurations stored.
|
417
|
-
# @return [Array<Types::PlaybackConfiguration>]
|
973
|
+
# This response includes only the "type" : "object" property.
|
418
974
|
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
|
422
|
-
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationResponse AWS API Documentation
|
976
|
+
#
|
977
|
+
class DeleteSourceLocationResponse < Aws::EmptyStructure; end
|
978
|
+
|
979
|
+
# @note When making an API call, you may pass DeleteVodSourceRequest
|
980
|
+
# data as a hash:
|
981
|
+
#
|
982
|
+
# {
|
983
|
+
# source_location_name: "__string", # required
|
984
|
+
# vod_source_name: "__string", # required
|
985
|
+
# }
|
986
|
+
#
|
987
|
+
# @!attribute [rw] source_location_name
|
423
988
|
# @return [String]
|
424
989
|
#
|
425
|
-
#
|
990
|
+
# @!attribute [rw] vod_source_name
|
991
|
+
# @return [String]
|
426
992
|
#
|
427
|
-
|
428
|
-
|
429
|
-
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceRequest AWS API Documentation
|
994
|
+
#
|
995
|
+
class DeleteVodSourceRequest < Struct.new(
|
996
|
+
:source_location_name,
|
997
|
+
:vod_source_name)
|
430
998
|
SENSITIVE = []
|
431
999
|
include Aws::Structure
|
432
1000
|
end
|
433
1001
|
|
434
|
-
#
|
1002
|
+
# This response includes only the "type" : "object" property.
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceResponse AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class DeleteVodSourceResponse < Aws::EmptyStructure; end
|
1007
|
+
|
1008
|
+
# @note When making an API call, you may pass DescribeChannelRequest
|
435
1009
|
# data as a hash:
|
436
1010
|
#
|
437
1011
|
# {
|
438
|
-
#
|
1012
|
+
# channel_name: "__string", # required
|
439
1013
|
# }
|
440
1014
|
#
|
441
|
-
# @!attribute [rw]
|
1015
|
+
# @!attribute [rw] channel_name
|
442
1016
|
# @return [String]
|
443
1017
|
#
|
444
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
1018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannelRequest AWS API Documentation
|
445
1019
|
#
|
446
|
-
class
|
447
|
-
:
|
1020
|
+
class DescribeChannelRequest < Struct.new(
|
1021
|
+
:channel_name)
|
448
1022
|
SENSITIVE = []
|
449
1023
|
include Aws::Structure
|
450
1024
|
end
|
451
1025
|
|
1026
|
+
# Returns a channel's properties.
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] arn
|
1029
|
+
# The ARN of the channel.
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] channel_name
|
1033
|
+
# The name of the channel.
|
1034
|
+
# @return [String]
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] channel_state
|
1037
|
+
# Indicates whether the channel is in a running state or not.
|
1038
|
+
# @return [String]
|
1039
|
+
#
|
1040
|
+
# @!attribute [rw] creation_time
|
1041
|
+
# The timestamp of when the channel was created.
|
1042
|
+
# @return [Time]
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] last_modified_time
|
1045
|
+
# The timestamp of when the channel was last modified.
|
1046
|
+
# @return [Time]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] outputs
|
1049
|
+
# The channel's output properties.
|
1050
|
+
# @return [Array<Types::ResponseOutputItem>]
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] playback_mode
|
1053
|
+
# The type of playback for this channel. The only supported value is
|
1054
|
+
# LOOP.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
452
1057
|
# @!attribute [rw] tags
|
1058
|
+
# The tags assigned to the channel.
|
453
1059
|
# @return [Hash<String,String>]
|
454
1060
|
#
|
455
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
1061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannelResponse AWS API Documentation
|
456
1062
|
#
|
457
|
-
class
|
1063
|
+
class DescribeChannelResponse < Struct.new(
|
1064
|
+
:arn,
|
1065
|
+
:channel_name,
|
1066
|
+
:channel_state,
|
1067
|
+
:creation_time,
|
1068
|
+
:last_modified_time,
|
1069
|
+
:outputs,
|
1070
|
+
:playback_mode,
|
458
1071
|
:tags)
|
459
1072
|
SENSITIVE = []
|
460
1073
|
include Aws::Structure
|
461
1074
|
end
|
462
1075
|
|
463
|
-
#
|
464
|
-
# rules enable customization of the personalized manifests created by
|
465
|
-
# MediaTailor.
|
466
|
-
#
|
467
|
-
# @note When making an API call, you may pass ManifestProcessingRules
|
1076
|
+
# @note When making an API call, you may pass DescribeProgramRequest
|
468
1077
|
# data as a hash:
|
469
1078
|
#
|
470
1079
|
# {
|
471
|
-
#
|
472
|
-
#
|
473
|
-
# },
|
1080
|
+
# channel_name: "__string", # required
|
1081
|
+
# program_name: "__string", # required
|
474
1082
|
# }
|
475
1083
|
#
|
476
|
-
# @!attribute [rw]
|
477
|
-
#
|
478
|
-
# EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers
|
479
|
-
# from the origin manifest to the MediaTailor personalized manifest.
|
1084
|
+
# @!attribute [rw] channel_name
|
1085
|
+
# @return [String]
|
480
1086
|
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
# break, MediaTailor will not set the value to 0.
|
484
|
-
# @return [Types::AdMarkerPassthrough]
|
1087
|
+
# @!attribute [rw] program_name
|
1088
|
+
# @return [String]
|
485
1089
|
#
|
486
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
1090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeProgramRequest AWS API Documentation
|
487
1091
|
#
|
488
|
-
class
|
489
|
-
:
|
1092
|
+
class DescribeProgramRequest < Struct.new(
|
1093
|
+
:channel_name,
|
1094
|
+
:program_name)
|
490
1095
|
SENSITIVE = []
|
491
1096
|
include Aws::Structure
|
492
1097
|
end
|
493
1098
|
|
494
|
-
#
|
495
|
-
# @return [String]
|
496
|
-
#
|
497
|
-
# @!attribute [rw] cdn_configuration
|
498
|
-
# The configuration for using a content delivery network (CDN), like
|
499
|
-
# Amazon CloudFront, for content and ad segment management.
|
500
|
-
# @return [Types::CdnConfiguration]
|
1099
|
+
# This program's configuration parameters.
|
501
1100
|
#
|
502
|
-
# @!attribute [rw]
|
503
|
-
#
|
1101
|
+
# @!attribute [rw] ad_breaks
|
1102
|
+
# The ad break configuration settings.
|
1103
|
+
# @return [Array<Types::AdBreak>]
|
504
1104
|
#
|
505
|
-
# @!attribute [rw]
|
506
|
-
#
|
507
|
-
# @return [
|
1105
|
+
# @!attribute [rw] arn
|
1106
|
+
# The ARN of the program.
|
1107
|
+
# @return [String]
|
508
1108
|
#
|
509
|
-
# @!attribute [rw]
|
510
|
-
# The
|
511
|
-
# @return [
|
1109
|
+
# @!attribute [rw] channel_name
|
1110
|
+
# The name of the channel that the program belongs to.
|
1111
|
+
# @return [String]
|
512
1112
|
#
|
513
|
-
# @!attribute [rw]
|
514
|
-
# The
|
515
|
-
# @return [
|
1113
|
+
# @!attribute [rw] creation_time
|
1114
|
+
# The timestamp of when the program was created.
|
1115
|
+
# @return [Time]
|
516
1116
|
#
|
517
|
-
# @!attribute [rw]
|
1117
|
+
# @!attribute [rw] program_name
|
1118
|
+
# The name of the program.
|
518
1119
|
# @return [String]
|
519
1120
|
#
|
520
|
-
# @!attribute [rw]
|
1121
|
+
# @!attribute [rw] source_location_name
|
1122
|
+
# The source location name.
|
521
1123
|
# @return [String]
|
522
1124
|
#
|
523
|
-
# @!attribute [rw]
|
1125
|
+
# @!attribute [rw] vod_source_name
|
1126
|
+
# The name that's used to refer to a VOD source.
|
524
1127
|
# @return [String]
|
525
1128
|
#
|
526
|
-
#
|
527
|
-
# @return [String]
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeProgramResponse AWS API Documentation
|
528
1130
|
#
|
529
|
-
|
530
|
-
|
1131
|
+
class DescribeProgramResponse < Struct.new(
|
1132
|
+
:ad_breaks,
|
1133
|
+
:arn,
|
1134
|
+
:channel_name,
|
1135
|
+
:creation_time,
|
1136
|
+
:program_name,
|
1137
|
+
:source_location_name,
|
1138
|
+
:vod_source_name)
|
1139
|
+
SENSITIVE = []
|
1140
|
+
include Aws::Structure
|
1141
|
+
end
|
1142
|
+
|
1143
|
+
# @note When making an API call, you may pass DescribeSourceLocationRequest
|
1144
|
+
# data as a hash:
|
531
1145
|
#
|
532
|
-
#
|
533
|
-
#
|
1146
|
+
# {
|
1147
|
+
# source_location_name: "__string", # required
|
1148
|
+
# }
|
534
1149
|
#
|
535
|
-
# @!attribute [rw]
|
1150
|
+
# @!attribute [rw] source_location_name
|
536
1151
|
# @return [String]
|
537
1152
|
#
|
538
|
-
#
|
1153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationRequest AWS API Documentation
|
1154
|
+
#
|
1155
|
+
class DescribeSourceLocationRequest < Struct.new(
|
1156
|
+
:source_location_name)
|
1157
|
+
SENSITIVE = []
|
1158
|
+
include Aws::Structure
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# This response includes only the "type" : "object" property.
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] access_configuration
|
1164
|
+
# The access configuration for the source location.
|
1165
|
+
# @return [Types::AccessConfiguration]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] arn
|
1168
|
+
# The ARN of the source location.
|
539
1169
|
# @return [String]
|
540
1170
|
#
|
541
|
-
#
|
1171
|
+
# @!attribute [rw] creation_time
|
1172
|
+
# The timestamp that indicates when the source location was created.
|
1173
|
+
# @return [Time]
|
542
1174
|
#
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
1175
|
+
# @!attribute [rw] default_segment_delivery_configuration
|
1176
|
+
# The default segment delivery configuration settings.
|
1177
|
+
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] http_configuration
|
1180
|
+
# The HTTP package configuration settings for the source location.
|
1181
|
+
# @return [Types::HttpConfiguration]
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] last_modified_time
|
1184
|
+
# The timestamp that indicates when the source location was last
|
1185
|
+
# modified.
|
1186
|
+
# @return [Time]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] source_location_name
|
1189
|
+
# The name of the source location.
|
1190
|
+
# @return [String]
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] tags
|
1193
|
+
# The tags assigned to the source location.
|
1194
|
+
# @return [Hash<String,String>]
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationResponse AWS API Documentation
|
1197
|
+
#
|
1198
|
+
class DescribeSourceLocationResponse < Struct.new(
|
1199
|
+
:access_configuration,
|
1200
|
+
:arn,
|
1201
|
+
:creation_time,
|
1202
|
+
:default_segment_delivery_configuration,
|
1203
|
+
:http_configuration,
|
1204
|
+
:last_modified_time,
|
1205
|
+
:source_location_name,
|
1206
|
+
:tags)
|
1207
|
+
SENSITIVE = []
|
1208
|
+
include Aws::Structure
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# @note When making an API call, you may pass DescribeVodSourceRequest
|
1212
|
+
# data as a hash:
|
1213
|
+
#
|
1214
|
+
# {
|
1215
|
+
# source_location_name: "__string", # required
|
1216
|
+
# vod_source_name: "__string", # required
|
1217
|
+
# }
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] source_location_name
|
1220
|
+
# @return [String]
|
1221
|
+
#
|
1222
|
+
# @!attribute [rw] vod_source_name
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSourceRequest AWS API Documentation
|
1226
|
+
#
|
1227
|
+
class DescribeVodSourceRequest < Struct.new(
|
1228
|
+
:source_location_name,
|
1229
|
+
:vod_source_name)
|
1230
|
+
SENSITIVE = []
|
1231
|
+
include Aws::Structure
|
1232
|
+
end
|
1233
|
+
|
1234
|
+
# This response includes only the "type" : "object" property.
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] arn
|
1237
|
+
# The ARN of the VOD source.
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] creation_time
|
1241
|
+
# The timestamp that indicates when the VOD source was created.
|
1242
|
+
# @return [Time]
|
1243
|
+
#
|
1244
|
+
# @!attribute [rw] http_package_configurations
|
1245
|
+
# The HTTP package configurations.
|
1246
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
1247
|
+
#
|
1248
|
+
# @!attribute [rw] last_modified_time
|
1249
|
+
# The ARN for the VOD source.
|
1250
|
+
# @return [Time]
|
1251
|
+
#
|
1252
|
+
# @!attribute [rw] source_location_name
|
1253
|
+
# The name of the source location associated with the VOD source.
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] tags
|
1257
|
+
# The tags assigned to the VOD source.
|
1258
|
+
# @return [Hash<String,String>]
|
1259
|
+
#
|
1260
|
+
# @!attribute [rw] vod_source_name
|
1261
|
+
# The name of the VOD source.
|
1262
|
+
# @return [String]
|
1263
|
+
#
|
1264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSourceResponse AWS API Documentation
|
1265
|
+
#
|
1266
|
+
class DescribeVodSourceResponse < Struct.new(
|
1267
|
+
:arn,
|
1268
|
+
:creation_time,
|
1269
|
+
:http_package_configurations,
|
1270
|
+
:last_modified_time,
|
1271
|
+
:source_location_name,
|
555
1272
|
:tags,
|
556
|
-
:
|
557
|
-
:video_content_source_url)
|
1273
|
+
:vod_source_name)
|
558
1274
|
SENSITIVE = []
|
559
1275
|
include Aws::Structure
|
560
1276
|
end
|
561
1277
|
|
562
|
-
#
|
1278
|
+
# @note When making an API call, you may pass GetChannelPolicyRequest
|
1279
|
+
# data as a hash:
|
563
1280
|
#
|
564
|
-
#
|
1281
|
+
# {
|
1282
|
+
# channel_name: "__string", # required
|
1283
|
+
# }
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] channel_name
|
1286
|
+
# @return [String]
|
1287
|
+
#
|
1288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyRequest AWS API Documentation
|
1289
|
+
#
|
1290
|
+
class GetChannelPolicyRequest < Struct.new(
|
1291
|
+
:channel_name)
|
1292
|
+
SENSITIVE = []
|
1293
|
+
include Aws::Structure
|
1294
|
+
end
|
1295
|
+
|
1296
|
+
# Returns the channel's IAM policy.
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] policy
|
1299
|
+
# The IAM policy for the channel.
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyResponse AWS API Documentation
|
1303
|
+
#
|
1304
|
+
class GetChannelPolicyResponse < Struct.new(
|
1305
|
+
:policy)
|
1306
|
+
SENSITIVE = []
|
1307
|
+
include Aws::Structure
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
# @note When making an API call, you may pass GetChannelScheduleRequest
|
565
1311
|
# data as a hash:
|
566
1312
|
#
|
567
1313
|
# {
|
568
|
-
#
|
569
|
-
#
|
1314
|
+
# channel_name: "__string", # required
|
1315
|
+
# duration_minutes: "__string",
|
1316
|
+
# max_results: 1,
|
1317
|
+
# next_token: "__string",
|
570
1318
|
# }
|
571
1319
|
#
|
572
|
-
# @!attribute [rw]
|
573
|
-
# The URL for the ad decision server (ADS) for pre-roll ads. This
|
574
|
-
# includes the specification of static parameters and placeholders for
|
575
|
-
# dynamic parameters. AWS Elemental MediaTailor substitutes
|
576
|
-
# player-specific and session-specific parameters as needed when
|
577
|
-
# calling the ADS. Alternately, for testing, you can provide a static
|
578
|
-
# VAST URL. The maximum length is 25,000 characters.
|
1320
|
+
# @!attribute [rw] channel_name
|
579
1321
|
# @return [String]
|
580
1322
|
#
|
581
|
-
# @!attribute [rw]
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
# returns.
|
1323
|
+
# @!attribute [rw] duration_minutes
|
1324
|
+
# @return [String]
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] max_results
|
586
1327
|
# @return [Integer]
|
587
1328
|
#
|
588
|
-
#
|
1329
|
+
# @!attribute [rw] next_token
|
1330
|
+
# @return [String]
|
589
1331
|
#
|
590
|
-
|
591
|
-
|
592
|
-
|
1332
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleRequest AWS API Documentation
|
1333
|
+
#
|
1334
|
+
class GetChannelScheduleRequest < Struct.new(
|
1335
|
+
:channel_name,
|
1336
|
+
:duration_minutes,
|
1337
|
+
:max_results,
|
1338
|
+
:next_token)
|
593
1339
|
SENSITIVE = []
|
594
1340
|
include Aws::Structure
|
595
1341
|
end
|
596
1342
|
|
597
|
-
#
|
1343
|
+
# Returns the schedule entries for the channel.
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] items
|
1346
|
+
# An array of schedule entries for the channel.
|
1347
|
+
# @return [Array<Types::ScheduleEntry>]
|
1348
|
+
#
|
1349
|
+
# @!attribute [rw] next_token
|
1350
|
+
# Pagination token from the GET list request. Use the token to fetch
|
1351
|
+
# the next page of results.
|
1352
|
+
# @return [String]
|
1353
|
+
#
|
1354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleResponse AWS API Documentation
|
1355
|
+
#
|
1356
|
+
class GetChannelScheduleResponse < Struct.new(
|
1357
|
+
:items,
|
1358
|
+
:next_token)
|
1359
|
+
SENSITIVE = []
|
1360
|
+
include Aws::Structure
|
1361
|
+
end
|
1362
|
+
|
1363
|
+
# @note When making an API call, you may pass GetPlaybackConfigurationRequest
|
598
1364
|
# data as a hash:
|
599
1365
|
#
|
600
1366
|
# {
|
601
|
-
#
|
602
|
-
# avail_suppression: {
|
603
|
-
# mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE
|
604
|
-
# value: "__string",
|
605
|
-
# },
|
606
|
-
# bumper: {
|
607
|
-
# end_url: "__string",
|
608
|
-
# start_url: "__string",
|
609
|
-
# },
|
610
|
-
# cdn_configuration: {
|
611
|
-
# ad_segment_url_prefix: "__string",
|
612
|
-
# content_segment_url_prefix: "__string",
|
613
|
-
# },
|
614
|
-
# personalization_threshold_seconds: 1,
|
615
|
-
# configuration_aliases: {
|
616
|
-
# "__string" => {
|
617
|
-
# "__string" => "__string",
|
618
|
-
# },
|
619
|
-
# },
|
620
|
-
# dash_configuration: {
|
621
|
-
# mpd_location: "__string",
|
622
|
-
# origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
|
623
|
-
# },
|
624
|
-
# live_pre_roll_configuration: {
|
625
|
-
# ad_decision_server_url: "__string",
|
626
|
-
# max_duration_seconds: 1,
|
627
|
-
# },
|
628
|
-
# manifest_processing_rules: {
|
629
|
-
# ad_marker_passthrough: {
|
630
|
-
# enabled: false,
|
631
|
-
# },
|
632
|
-
# },
|
633
|
-
# name: "__string",
|
634
|
-
# slate_ad_url: "__string",
|
635
|
-
# tags: {
|
636
|
-
# "__string" => "__string",
|
637
|
-
# },
|
638
|
-
# transcode_profile_name: "__string",
|
639
|
-
# video_content_source_url: "__string",
|
1367
|
+
# name: "__string", # required
|
640
1368
|
# }
|
641
1369
|
#
|
1370
|
+
# @!attribute [rw] name
|
1371
|
+
# @return [String]
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfigurationRequest AWS API Documentation
|
1374
|
+
#
|
1375
|
+
class GetPlaybackConfigurationRequest < Struct.new(
|
1376
|
+
:name)
|
1377
|
+
SENSITIVE = []
|
1378
|
+
include Aws::Structure
|
1379
|
+
end
|
1380
|
+
|
1381
|
+
# Returns the playback configuration for the specified name.
|
1382
|
+
#
|
642
1383
|
# @!attribute [rw] ad_decision_server_url
|
643
1384
|
# The URL for the ad decision server (ADS). This includes the
|
644
1385
|
# specification of static parameters and placeholders for dynamic
|
645
1386
|
# parameters. AWS Elemental MediaTailor substitutes player-specific
|
646
1387
|
# and session-specific parameters as needed when calling the ADS.
|
647
|
-
# Alternately, for testing you can provide a static VAST URL. The
|
1388
|
+
# Alternately, for testing, you can provide a static VAST URL. The
|
648
1389
|
# maximum length is 25,000 characters.
|
649
1390
|
# @return [String]
|
650
1391
|
#
|
651
1392
|
# @!attribute [rw] avail_suppression
|
652
|
-
# The configuration for
|
1393
|
+
# The configuration for avail suppression, also known as ad
|
1394
|
+
# suppression. For more information about ad suppression, see [Ad
|
1395
|
+
# Suppression][1].
|
1396
|
+
#
|
1397
|
+
#
|
1398
|
+
#
|
1399
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
653
1400
|
# @return [Types::AvailSuppression]
|
654
1401
|
#
|
655
1402
|
# @!attribute [rw] bumper
|
656
1403
|
# The configuration for bumpers. Bumpers are short audio or video
|
657
|
-
# clips that play at the start or before the end of an ad break.
|
1404
|
+
# clips that play at the start or before the end of an ad break. To
|
1405
|
+
# learn more about bumpers, see [Bumpers][1].
|
1406
|
+
#
|
1407
|
+
#
|
1408
|
+
#
|
1409
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
|
658
1410
|
# @return [Types::Bumper]
|
659
1411
|
#
|
660
1412
|
# @!attribute [rw] cdn_configuration
|
@@ -662,18 +1414,23 @@ module Aws::MediaTailor
|
|
662
1414
|
# Amazon CloudFront, for content and ad segment management.
|
663
1415
|
# @return [Types::CdnConfiguration]
|
664
1416
|
#
|
665
|
-
# @!attribute [rw] personalization_threshold_seconds
|
666
|
-
# The maximum duration of underfilled ad time (in seconds) allowed in
|
667
|
-
# an ad break.
|
668
|
-
# @return [Integer]
|
669
|
-
#
|
670
1417
|
# @!attribute [rw] configuration_aliases
|
671
|
-
#
|
1418
|
+
# The player parameters and aliases used as dynamic variables during
|
1419
|
+
# session initialization. For more information, see [Domain
|
1420
|
+
# Variables][1].
|
1421
|
+
#
|
1422
|
+
#
|
1423
|
+
#
|
1424
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
|
672
1425
|
# @return [Hash<String,Hash<String,String>>]
|
673
1426
|
#
|
674
1427
|
# @!attribute [rw] dash_configuration
|
675
1428
|
# The configuration for DASH content.
|
676
|
-
# @return [Types::
|
1429
|
+
# @return [Types::DashConfiguration]
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] hls_configuration
|
1432
|
+
# The configuration for HLS content.
|
1433
|
+
# @return [Types::HlsConfiguration]
|
677
1434
|
#
|
678
1435
|
# @!attribute [rw] live_pre_roll_configuration
|
679
1436
|
# The configuration for pre-roll ad insertion.
|
@@ -689,18 +1446,48 @@ module Aws::MediaTailor
|
|
689
1446
|
# The identifier for the playback configuration.
|
690
1447
|
# @return [String]
|
691
1448
|
#
|
1449
|
+
# @!attribute [rw] personalization_threshold_seconds
|
1450
|
+
# Defines the maximum duration of underfilled ad time (in seconds)
|
1451
|
+
# allowed in an ad break. If the duration of underfilled ad time
|
1452
|
+
# exceeds the personalization threshold, then the personalization of
|
1453
|
+
# the ad break is abandoned and the underlying content is shown. This
|
1454
|
+
# feature applies to *ad replacement* in live and VOD streams, rather
|
1455
|
+
# than ad insertion, because it relies on an underlying content
|
1456
|
+
# stream. For more information about ad break behavior, including ad
|
1457
|
+
# replacement and insertion, see [Ad Behavior in AWS Elemental
|
1458
|
+
# MediaTailor][1].
|
1459
|
+
#
|
1460
|
+
#
|
1461
|
+
#
|
1462
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
1463
|
+
# @return [Integer]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] playback_configuration_arn
|
1466
|
+
# The Amazon Resource Name (ARN) for the playback configuration.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] playback_endpoint_prefix
|
1470
|
+
# The URL that the player accesses to get a manifest from AWS
|
1471
|
+
# Elemental MediaTailor. This session will use server-side reporting.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] session_initialization_endpoint_prefix
|
1475
|
+
# The URL that the player uses to initialize a session that uses
|
1476
|
+
# client-side reporting.
|
1477
|
+
# @return [String]
|
1478
|
+
#
|
692
1479
|
# @!attribute [rw] slate_ad_url
|
693
1480
|
# The URL for a high-quality video asset to transcode and use to fill
|
694
1481
|
# in time that's not used by ads. AWS Elemental MediaTailor shows the
|
695
1482
|
# slate to fill in gaps in media content. Configuring the slate is
|
696
|
-
# optional for non-VPAID configurations. For VPAID, the slate
|
697
|
-
# required because MediaTailor provides it in the slots
|
698
|
-
#
|
699
|
-
#
|
1483
|
+
# optional for non-VPAID playback configurations. For VPAID, the slate
|
1484
|
+
# is required because MediaTailor provides it in the slots designated
|
1485
|
+
# for dynamic ad content. The slate must be a high-quality asset that
|
1486
|
+
# contains both audio and video.
|
700
1487
|
# @return [String]
|
701
1488
|
#
|
702
1489
|
# @!attribute [rw] tags
|
703
|
-
# The tags
|
1490
|
+
# The tags assigned to the playback configuration.
|
704
1491
|
# @return [Hash<String,String>]
|
705
1492
|
#
|
706
1493
|
# @!attribute [rw] transcode_profile_name
|
@@ -711,23 +1498,27 @@ module Aws::MediaTailor
|
|
711
1498
|
# @return [String]
|
712
1499
|
#
|
713
1500
|
# @!attribute [rw] video_content_source_url
|
714
|
-
# The URL prefix for the
|
1501
|
+
# The URL prefix for the parent manifest for the stream, minus the
|
715
1502
|
# asset ID. The maximum length is 512 characters.
|
716
1503
|
# @return [String]
|
717
1504
|
#
|
718
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
1505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfigurationResponse AWS API Documentation
|
719
1506
|
#
|
720
|
-
class
|
1507
|
+
class GetPlaybackConfigurationResponse < Struct.new(
|
721
1508
|
:ad_decision_server_url,
|
722
1509
|
:avail_suppression,
|
723
1510
|
:bumper,
|
724
1511
|
:cdn_configuration,
|
725
|
-
:personalization_threshold_seconds,
|
726
1512
|
:configuration_aliases,
|
727
1513
|
:dash_configuration,
|
1514
|
+
:hls_configuration,
|
728
1515
|
:live_pre_roll_configuration,
|
729
1516
|
:manifest_processing_rules,
|
730
1517
|
:name,
|
1518
|
+
:personalization_threshold_seconds,
|
1519
|
+
:playback_configuration_arn,
|
1520
|
+
:playback_endpoint_prefix,
|
1521
|
+
:session_initialization_endpoint_prefix,
|
731
1522
|
:slate_ad_url,
|
732
1523
|
:tags,
|
733
1524
|
:transcode_profile_name,
|
@@ -736,92 +1527,1260 @@ module Aws::MediaTailor
|
|
736
1527
|
include Aws::Structure
|
737
1528
|
end
|
738
1529
|
|
739
|
-
#
|
1530
|
+
# The configuration for HLS content.
|
1531
|
+
#
|
1532
|
+
# @!attribute [rw] manifest_endpoint_prefix
|
1533
|
+
# The URL that is used to initiate a playback session for devices that
|
1534
|
+
# support Apple HLS. The session uses server-side reporting.
|
740
1535
|
# @return [String]
|
741
1536
|
#
|
742
|
-
#
|
743
|
-
# @return [Types::AvailSuppression]
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HlsConfiguration AWS API Documentation
|
744
1538
|
#
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
1539
|
+
class HlsConfiguration < Struct.new(
|
1540
|
+
:manifest_endpoint_prefix)
|
1541
|
+
SENSITIVE = []
|
1542
|
+
include Aws::Structure
|
1543
|
+
end
|
1544
|
+
|
1545
|
+
# HLS playlist configuration parameters.
|
749
1546
|
#
|
750
|
-
#
|
751
|
-
#
|
752
|
-
# Amazon CloudFront, for content and ad segment management.
|
753
|
-
# @return [Types::CdnConfiguration]
|
1547
|
+
# @note When making an API call, you may pass HlsPlaylistSettings
|
1548
|
+
# data as a hash:
|
754
1549
|
#
|
755
|
-
#
|
756
|
-
#
|
1550
|
+
# {
|
1551
|
+
# manifest_window_seconds: 1,
|
1552
|
+
# }
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] manifest_window_seconds
|
1555
|
+
# The total duration (in seconds) of each manifest. Minimum value: 30
|
1556
|
+
# seconds. Maximum value: 3600 seconds.
|
1557
|
+
# @return [Integer]
|
1558
|
+
#
|
1559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HlsPlaylistSettings AWS API Documentation
|
1560
|
+
#
|
1561
|
+
class HlsPlaylistSettings < Struct.new(
|
1562
|
+
:manifest_window_seconds)
|
1563
|
+
SENSITIVE = []
|
1564
|
+
include Aws::Structure
|
1565
|
+
end
|
1566
|
+
|
1567
|
+
# The HTTP configuration for the source location.
|
1568
|
+
#
|
1569
|
+
# @note When making an API call, you may pass HttpConfiguration
|
1570
|
+
# data as a hash:
|
1571
|
+
#
|
1572
|
+
# {
|
1573
|
+
# base_url: "__string", # required
|
1574
|
+
# }
|
1575
|
+
#
|
1576
|
+
# @!attribute [rw] base_url
|
1577
|
+
# The base URL for the source location host server. This string must
|
1578
|
+
# include the protocol, such as **https://**.
|
1579
|
+
# @return [String]
|
1580
|
+
#
|
1581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HttpConfiguration AWS API Documentation
|
1582
|
+
#
|
1583
|
+
class HttpConfiguration < Struct.new(
|
1584
|
+
:base_url)
|
1585
|
+
SENSITIVE = []
|
1586
|
+
include Aws::Structure
|
1587
|
+
end
|
1588
|
+
|
1589
|
+
# The HTTP package configuration properties for the requested VOD
|
1590
|
+
# source.
|
1591
|
+
#
|
1592
|
+
# @note When making an API call, you may pass HttpPackageConfiguration
|
1593
|
+
# data as a hash:
|
1594
|
+
#
|
1595
|
+
# {
|
1596
|
+
# path: "__string", # required
|
1597
|
+
# source_group: "__string", # required
|
1598
|
+
# type: "DASH", # required, accepts DASH, HLS
|
1599
|
+
# }
|
1600
|
+
#
|
1601
|
+
# @!attribute [rw] path
|
1602
|
+
# The relative path to the URL for this VOD source. This is combined
|
1603
|
+
# with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
|
1604
|
+
# @return [String]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] source_group
|
1607
|
+
# The name of the source group. This has to match one of the
|
1608
|
+
# Channel::Outputs::SourceGroup.
|
1609
|
+
# @return [String]
|
1610
|
+
#
|
1611
|
+
# @!attribute [rw] type
|
1612
|
+
# The streaming protocol for this package configuration. Supported
|
1613
|
+
# values are HLS and DASH.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HttpPackageConfiguration AWS API Documentation
|
1617
|
+
#
|
1618
|
+
class HttpPackageConfiguration < Struct.new(
|
1619
|
+
:path,
|
1620
|
+
:source_group,
|
1621
|
+
:type)
|
1622
|
+
SENSITIVE = []
|
1623
|
+
include Aws::Structure
|
1624
|
+
end
|
1625
|
+
|
1626
|
+
# @note When making an API call, you may pass ListChannelsRequest
|
1627
|
+
# data as a hash:
|
1628
|
+
#
|
1629
|
+
# {
|
1630
|
+
# max_results: 1,
|
1631
|
+
# next_token: "__string",
|
1632
|
+
# }
|
1633
|
+
#
|
1634
|
+
# @!attribute [rw] max_results
|
1635
|
+
# @return [Integer]
|
1636
|
+
#
|
1637
|
+
# @!attribute [rw] next_token
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannelsRequest AWS API Documentation
|
1641
|
+
#
|
1642
|
+
class ListChannelsRequest < Struct.new(
|
1643
|
+
:max_results,
|
1644
|
+
:next_token)
|
1645
|
+
SENSITIVE = []
|
1646
|
+
include Aws::Structure
|
1647
|
+
end
|
1648
|
+
|
1649
|
+
# Returns a list of channels.
|
1650
|
+
#
|
1651
|
+
# @!attribute [rw] items
|
1652
|
+
# An array of channels that are associated with this account.
|
1653
|
+
# @return [Array<Types::Channel>]
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] next_token
|
1656
|
+
# Pagination token returned by the list request when results exceed
|
1657
|
+
# the maximum allowed. Use the token to fetch the next page of
|
1658
|
+
# results.
|
1659
|
+
# @return [String]
|
1660
|
+
#
|
1661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannelsResponse AWS API Documentation
|
1662
|
+
#
|
1663
|
+
class ListChannelsResponse < Struct.new(
|
1664
|
+
:items,
|
1665
|
+
:next_token)
|
1666
|
+
SENSITIVE = []
|
1667
|
+
include Aws::Structure
|
1668
|
+
end
|
1669
|
+
|
1670
|
+
# @note When making an API call, you may pass ListPlaybackConfigurationsRequest
|
1671
|
+
# data as a hash:
|
1672
|
+
#
|
1673
|
+
# {
|
1674
|
+
# max_results: 1,
|
1675
|
+
# next_token: "__string",
|
1676
|
+
# }
|
1677
|
+
#
|
1678
|
+
# @!attribute [rw] max_results
|
1679
|
+
# @return [Integer]
|
1680
|
+
#
|
1681
|
+
# @!attribute [rw] next_token
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurationsRequest AWS API Documentation
|
1685
|
+
#
|
1686
|
+
class ListPlaybackConfigurationsRequest < Struct.new(
|
1687
|
+
:max_results,
|
1688
|
+
:next_token)
|
1689
|
+
SENSITIVE = []
|
1690
|
+
include Aws::Structure
|
1691
|
+
end
|
1692
|
+
|
1693
|
+
# Returns a list of playback configurations.
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] items
|
1696
|
+
# Array of playback configurations. This might be all the available
|
1697
|
+
# configurations or a subset, depending on the settings that you
|
1698
|
+
# provide and the total number of configurations stored.
|
1699
|
+
# @return [Array<Types::PlaybackConfiguration>]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] next_token
|
1702
|
+
# Pagination token returned by the GET list request when results
|
1703
|
+
# exceed the maximum allowed. Use the token to fetch the next page of
|
1704
|
+
# results.
|
1705
|
+
# @return [String]
|
1706
|
+
#
|
1707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurationsResponse AWS API Documentation
|
1708
|
+
#
|
1709
|
+
class ListPlaybackConfigurationsResponse < Struct.new(
|
1710
|
+
:items,
|
1711
|
+
:next_token)
|
1712
|
+
SENSITIVE = []
|
1713
|
+
include Aws::Structure
|
1714
|
+
end
|
1715
|
+
|
1716
|
+
# @note When making an API call, you may pass ListProgramsRequest
|
1717
|
+
# data as a hash:
|
1718
|
+
#
|
1719
|
+
# {
|
1720
|
+
# channel_name: "__string", # required
|
1721
|
+
# max_results: 1,
|
1722
|
+
# next_token: "__string",
|
1723
|
+
# }
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] channel_name
|
1726
|
+
# @return [String]
|
1727
|
+
#
|
1728
|
+
# @!attribute [rw] max_results
|
1729
|
+
# @return [Integer]
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] next_token
|
1732
|
+
# @return [String]
|
1733
|
+
#
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListProgramsRequest AWS API Documentation
|
1735
|
+
#
|
1736
|
+
class ListProgramsRequest < Struct.new(
|
1737
|
+
:channel_name,
|
1738
|
+
:max_results,
|
1739
|
+
:next_token)
|
1740
|
+
SENSITIVE = []
|
1741
|
+
include Aws::Structure
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
# Returns a list of programs for a channel.
|
1745
|
+
#
|
1746
|
+
# @!attribute [rw] items
|
1747
|
+
# An array containing the programs for a channel.
|
1748
|
+
# @return [Array<Types::Program>]
|
1749
|
+
#
|
1750
|
+
# @!attribute [rw] next_token
|
1751
|
+
# Pagination token from the list request. Use the token to fetch the
|
1752
|
+
# next page of results.
|
1753
|
+
# @return [String]
|
1754
|
+
#
|
1755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListProgramsResponse AWS API Documentation
|
1756
|
+
#
|
1757
|
+
class ListProgramsResponse < Struct.new(
|
1758
|
+
:items,
|
1759
|
+
:next_token)
|
1760
|
+
SENSITIVE = []
|
1761
|
+
include Aws::Structure
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# @note When making an API call, you may pass ListSourceLocationsRequest
|
1765
|
+
# data as a hash:
|
1766
|
+
#
|
1767
|
+
# {
|
1768
|
+
# max_results: 1,
|
1769
|
+
# next_token: "__string",
|
1770
|
+
# }
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] max_results
|
1773
|
+
# @return [Integer]
|
1774
|
+
#
|
1775
|
+
# @!attribute [rw] next_token
|
1776
|
+
# @return [String]
|
1777
|
+
#
|
1778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsRequest AWS API Documentation
|
1779
|
+
#
|
1780
|
+
class ListSourceLocationsRequest < Struct.new(
|
1781
|
+
:max_results,
|
1782
|
+
:next_token)
|
1783
|
+
SENSITIVE = []
|
1784
|
+
include Aws::Structure
|
1785
|
+
end
|
1786
|
+
|
1787
|
+
# Lists the source locations.
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] items
|
1790
|
+
# An array of source locations.
|
1791
|
+
# @return [Array<Types::SourceLocation>]
|
1792
|
+
#
|
1793
|
+
# @!attribute [rw] next_token
|
1794
|
+
# Pagination token from the list request. Use the token to fetch the
|
1795
|
+
# next page of results.
|
1796
|
+
# @return [String]
|
1797
|
+
#
|
1798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsResponse AWS API Documentation
|
1799
|
+
#
|
1800
|
+
class ListSourceLocationsResponse < Struct.new(
|
1801
|
+
:items,
|
1802
|
+
:next_token)
|
1803
|
+
SENSITIVE = []
|
1804
|
+
include Aws::Structure
|
1805
|
+
end
|
1806
|
+
|
1807
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1808
|
+
# data as a hash:
|
1809
|
+
#
|
1810
|
+
# {
|
1811
|
+
# resource_arn: "__string", # required
|
1812
|
+
# }
|
1813
|
+
#
|
1814
|
+
# @!attribute [rw] resource_arn
|
1815
|
+
# @return [String]
|
1816
|
+
#
|
1817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceRequest AWS API Documentation
|
1818
|
+
#
|
1819
|
+
class ListTagsForResourceRequest < Struct.new(
|
1820
|
+
:resource_arn)
|
1821
|
+
SENSITIVE = []
|
1822
|
+
include Aws::Structure
|
1823
|
+
end
|
1824
|
+
|
1825
|
+
# @!attribute [rw] tags
|
1826
|
+
# @return [Hash<String,String>]
|
1827
|
+
#
|
1828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceResponse AWS API Documentation
|
1829
|
+
#
|
1830
|
+
class ListTagsForResourceResponse < Struct.new(
|
1831
|
+
:tags)
|
1832
|
+
SENSITIVE = []
|
1833
|
+
include Aws::Structure
|
1834
|
+
end
|
1835
|
+
|
1836
|
+
# @note When making an API call, you may pass ListVodSourcesRequest
|
1837
|
+
# data as a hash:
|
1838
|
+
#
|
1839
|
+
# {
|
1840
|
+
# max_results: 1,
|
1841
|
+
# next_token: "__string",
|
1842
|
+
# source_location_name: "__string", # required
|
1843
|
+
# }
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] max_results
|
1846
|
+
# @return [Integer]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] next_token
|
1849
|
+
# @return [String]
|
1850
|
+
#
|
1851
|
+
# @!attribute [rw] source_location_name
|
1852
|
+
# @return [String]
|
1853
|
+
#
|
1854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesRequest AWS API Documentation
|
1855
|
+
#
|
1856
|
+
class ListVodSourcesRequest < Struct.new(
|
1857
|
+
:max_results,
|
1858
|
+
:next_token,
|
1859
|
+
:source_location_name)
|
1860
|
+
SENSITIVE = []
|
1861
|
+
include Aws::Structure
|
1862
|
+
end
|
1863
|
+
|
1864
|
+
# An array of VOD sources.
|
1865
|
+
#
|
1866
|
+
# @!attribute [rw] items
|
1867
|
+
# Lists the VOD sources.
|
1868
|
+
# @return [Array<Types::VodSource>]
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] next_token
|
1871
|
+
# Pagination token from the list request. Use the token to fetch the
|
1872
|
+
# next page of results.
|
1873
|
+
# @return [String]
|
1874
|
+
#
|
1875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesResponse AWS API Documentation
|
1876
|
+
#
|
1877
|
+
class ListVodSourcesResponse < Struct.new(
|
1878
|
+
:items,
|
1879
|
+
:next_token)
|
1880
|
+
SENSITIVE = []
|
1881
|
+
include Aws::Structure
|
1882
|
+
end
|
1883
|
+
|
1884
|
+
# The configuration for pre-roll ad insertion.
|
1885
|
+
#
|
1886
|
+
# @note When making an API call, you may pass LivePreRollConfiguration
|
1887
|
+
# data as a hash:
|
1888
|
+
#
|
1889
|
+
# {
|
1890
|
+
# ad_decision_server_url: "__string",
|
1891
|
+
# max_duration_seconds: 1,
|
1892
|
+
# }
|
1893
|
+
#
|
1894
|
+
# @!attribute [rw] ad_decision_server_url
|
1895
|
+
# The URL for the ad decision server (ADS) for pre-roll ads. This
|
1896
|
+
# includes the specification of static parameters and placeholders for
|
1897
|
+
# dynamic parameters. AWS Elemental MediaTailor substitutes
|
1898
|
+
# player-specific and session-specific parameters as needed when
|
1899
|
+
# calling the ADS. Alternately, for testing, you can provide a static
|
1900
|
+
# VAST URL. The maximum length is 25,000 characters.
|
1901
|
+
# @return [String]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] max_duration_seconds
|
1904
|
+
# The maximum allowed duration for the pre-roll ad avail. AWS
|
1905
|
+
# Elemental MediaTailor won't play pre-roll ads to exceed this
|
1906
|
+
# duration, regardless of the total duration of ads that the ADS
|
1907
|
+
# returns.
|
1908
|
+
# @return [Integer]
|
1909
|
+
#
|
1910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LivePreRollConfiguration AWS API Documentation
|
1911
|
+
#
|
1912
|
+
class LivePreRollConfiguration < Struct.new(
|
1913
|
+
:ad_decision_server_url,
|
1914
|
+
:max_duration_seconds)
|
1915
|
+
SENSITIVE = []
|
1916
|
+
include Aws::Structure
|
1917
|
+
end
|
1918
|
+
|
1919
|
+
# The configuration for manifest processing rules. Manifest processing
|
1920
|
+
# rules enable customization of the personalized manifests created by
|
1921
|
+
# MediaTailor.
|
1922
|
+
#
|
1923
|
+
# @note When making an API call, you may pass ManifestProcessingRules
|
1924
|
+
# data as a hash:
|
1925
|
+
#
|
1926
|
+
# {
|
1927
|
+
# ad_marker_passthrough: {
|
1928
|
+
# enabled: false,
|
1929
|
+
# },
|
1930
|
+
# }
|
1931
|
+
#
|
1932
|
+
# @!attribute [rw] ad_marker_passthrough
|
1933
|
+
# For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN,
|
1934
|
+
# EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the
|
1935
|
+
# origin manifest to the MediaTailor personalized manifest.
|
1936
|
+
#
|
1937
|
+
# No logic is applied to these ad markers. For example, if
|
1938
|
+
# EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad
|
1939
|
+
# break, MediaTailor will not set the value to 0.
|
1940
|
+
# @return [Types::AdMarkerPassthrough]
|
1941
|
+
#
|
1942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ManifestProcessingRules AWS API Documentation
|
1943
|
+
#
|
1944
|
+
class ManifestProcessingRules < Struct.new(
|
1945
|
+
:ad_marker_passthrough)
|
1946
|
+
SENSITIVE = []
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# Creates a playback configuration. For information about MediaTailor
|
1951
|
+
# configurations, see [Working with configurations in AWS Elemental
|
1952
|
+
# MediaTailor][1].
|
1953
|
+
#
|
1954
|
+
#
|
1955
|
+
#
|
1956
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1957
|
+
#
|
1958
|
+
# @!attribute [rw] ad_decision_server_url
|
1959
|
+
# The URL for the ad decision server (ADS). This includes the
|
1960
|
+
# specification of static parameters and placeholders for dynamic
|
1961
|
+
# parameters. AWS Elemental MediaTailor substitutes player-specific
|
1962
|
+
# and session-specific parameters as needed when calling the ADS.
|
1963
|
+
# Alternately, for testing you can provide a static VAST URL. The
|
1964
|
+
# maximum length is 25,000 characters.
|
1965
|
+
# @return [String]
|
1966
|
+
#
|
1967
|
+
# @!attribute [rw] avail_suppression
|
1968
|
+
# The configuration for avail suppression, also known as ad
|
1969
|
+
# suppression. For more information about ad suppression, see [Ad
|
1970
|
+
# Suppression][1].
|
1971
|
+
#
|
1972
|
+
#
|
1973
|
+
#
|
1974
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
1975
|
+
# @return [Types::AvailSuppression]
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] bumper
|
1978
|
+
# The configuration for bumpers. Bumpers are short audio or video
|
1979
|
+
# clips that play at the start or before the end of an ad break. To
|
1980
|
+
# learn more about bumpers, see [Bumpers][1].
|
1981
|
+
#
|
1982
|
+
#
|
1983
|
+
#
|
1984
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
|
1985
|
+
# @return [Types::Bumper]
|
1986
|
+
#
|
1987
|
+
# @!attribute [rw] cdn_configuration
|
1988
|
+
# The configuration for using a content delivery network (CDN), like
|
1989
|
+
# Amazon CloudFront, for content and ad segment management.
|
1990
|
+
# @return [Types::CdnConfiguration]
|
1991
|
+
#
|
1992
|
+
# @!attribute [rw] configuration_aliases
|
1993
|
+
# The player parameters and aliases used as dynamic variables during
|
1994
|
+
# session initialization. For more information, see [Domain
|
1995
|
+
# Variables][1].
|
1996
|
+
#
|
1997
|
+
#
|
1998
|
+
#
|
1999
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
|
2000
|
+
# @return [Hash<String,Hash<String,String>>]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] dash_configuration
|
2003
|
+
# The configuration for a DASH source.
|
2004
|
+
# @return [Types::DashConfiguration]
|
2005
|
+
#
|
2006
|
+
# @!attribute [rw] hls_configuration
|
2007
|
+
# The configuration for HLS content.
|
2008
|
+
# @return [Types::HlsConfiguration]
|
2009
|
+
#
|
2010
|
+
# @!attribute [rw] live_pre_roll_configuration
|
2011
|
+
# The configuration for pre-roll ad insertion.
|
2012
|
+
# @return [Types::LivePreRollConfiguration]
|
2013
|
+
#
|
2014
|
+
# @!attribute [rw] manifest_processing_rules
|
2015
|
+
# The configuration for manifest processing rules. Manifest processing
|
2016
|
+
# rules enable customization of the personalized manifests created by
|
2017
|
+
# MediaTailor.
|
2018
|
+
# @return [Types::ManifestProcessingRules]
|
2019
|
+
#
|
2020
|
+
# @!attribute [rw] name
|
2021
|
+
# The identifier for the playback configuration.
|
2022
|
+
# @return [String]
|
2023
|
+
#
|
2024
|
+
# @!attribute [rw] personalization_threshold_seconds
|
2025
|
+
# Defines the maximum duration of underfilled ad time (in seconds)
|
2026
|
+
# allowed in an ad break. If the duration of underfilled ad time
|
2027
|
+
# exceeds the personalization threshold, then the personalization of
|
2028
|
+
# the ad break is abandoned and the underlying content is shown. This
|
2029
|
+
# feature applies to *ad replacement* in live and VOD streams, rather
|
2030
|
+
# than ad insertion, because it relies on an underlying content
|
2031
|
+
# stream. For more information about ad break behavior, including ad
|
2032
|
+
# replacement and insertion, see [Ad Behavior in AWS Elemental
|
2033
|
+
# MediaTailor][1].
|
2034
|
+
#
|
2035
|
+
#
|
2036
|
+
#
|
2037
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
2038
|
+
# @return [Integer]
|
2039
|
+
#
|
2040
|
+
# @!attribute [rw] playback_configuration_arn
|
2041
|
+
# The Amazon Resource Name (ARN) for the playback configuration.
|
2042
|
+
# @return [String]
|
2043
|
+
#
|
2044
|
+
# @!attribute [rw] playback_endpoint_prefix
|
2045
|
+
# The URL that the player accesses to get a manifest from AWS
|
2046
|
+
# Elemental MediaTailor.
|
2047
|
+
# @return [String]
|
2048
|
+
#
|
2049
|
+
# @!attribute [rw] session_initialization_endpoint_prefix
|
2050
|
+
# The URL that the player uses to initialize a session that uses
|
2051
|
+
# client-side reporting.
|
2052
|
+
# @return [String]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] slate_ad_url
|
2055
|
+
# The URL for a video asset to transcode and use to fill in time
|
2056
|
+
# that's not used by ads. AWS Elemental MediaTailor shows the slate
|
2057
|
+
# to fill in gaps in media content. Configuring the slate is optional
|
2058
|
+
# for non-VPAID playback configurations. For VPAID, the slate is
|
2059
|
+
# required because MediaTailor provides it in the slots designated for
|
2060
|
+
# dynamic ad content. The slate must be a high-quality asset that
|
2061
|
+
# contains both audio and video.
|
2062
|
+
# @return [String]
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] tags
|
2065
|
+
# The tags to assign to the playback configuration.
|
2066
|
+
# @return [Hash<String,String>]
|
2067
|
+
#
|
2068
|
+
# @!attribute [rw] transcode_profile_name
|
2069
|
+
# The name that is used to associate this playback configuration with
|
2070
|
+
# a custom transcode profile. This overrides the dynamic transcoding
|
2071
|
+
# defaults of MediaTailor. Use this only if you have already set up
|
2072
|
+
# custom profiles with the help of AWS Support.
|
2073
|
+
# @return [String]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] video_content_source_url
|
2076
|
+
# The URL prefix for the parent manifest for the stream, minus the
|
2077
|
+
# asset ID. The maximum length is 512 characters.
|
2078
|
+
# @return [String]
|
2079
|
+
#
|
2080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PlaybackConfiguration AWS API Documentation
|
2081
|
+
#
|
2082
|
+
class PlaybackConfiguration < Struct.new(
|
2083
|
+
:ad_decision_server_url,
|
2084
|
+
:avail_suppression,
|
2085
|
+
:bumper,
|
2086
|
+
:cdn_configuration,
|
2087
|
+
:configuration_aliases,
|
2088
|
+
:dash_configuration,
|
2089
|
+
:hls_configuration,
|
2090
|
+
:live_pre_roll_configuration,
|
2091
|
+
:manifest_processing_rules,
|
2092
|
+
:name,
|
2093
|
+
:personalization_threshold_seconds,
|
2094
|
+
:playback_configuration_arn,
|
2095
|
+
:playback_endpoint_prefix,
|
2096
|
+
:session_initialization_endpoint_prefix,
|
2097
|
+
:slate_ad_url,
|
2098
|
+
:tags,
|
2099
|
+
:transcode_profile_name,
|
2100
|
+
:video_content_source_url)
|
2101
|
+
SENSITIVE = []
|
2102
|
+
include Aws::Structure
|
2103
|
+
end
|
2104
|
+
|
2105
|
+
# Program configuration parameters.
|
2106
|
+
#
|
2107
|
+
# @!attribute [rw] ad_breaks
|
2108
|
+
# The ad break configuration settings.
|
2109
|
+
# @return [Array<Types::AdBreak>]
|
2110
|
+
#
|
2111
|
+
# @!attribute [rw] arn
|
2112
|
+
# The ARN of the program.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] channel_name
|
2116
|
+
# The name of the channel that the program belongs to.
|
2117
|
+
# @return [String]
|
2118
|
+
#
|
2119
|
+
# @!attribute [rw] creation_time
|
2120
|
+
# The timestamp of when the program was created.
|
2121
|
+
# @return [Time]
|
2122
|
+
#
|
2123
|
+
# @!attribute [rw] last_modified_time
|
2124
|
+
# The timestamp of when the program was last modified.
|
2125
|
+
# @return [Time]
|
2126
|
+
#
|
2127
|
+
# @!attribute [rw] program_name
|
2128
|
+
# The name of the program.
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] source_location_name
|
2132
|
+
# The name of the source location.
|
2133
|
+
# @return [String]
|
2134
|
+
#
|
2135
|
+
# @!attribute [rw] vod_source_name
|
2136
|
+
# The name that's used to refer to a VOD source.
|
2137
|
+
# @return [String]
|
2138
|
+
#
|
2139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Program AWS API Documentation
|
2140
|
+
#
|
2141
|
+
class Program < Struct.new(
|
2142
|
+
:ad_breaks,
|
2143
|
+
:arn,
|
2144
|
+
:channel_name,
|
2145
|
+
:creation_time,
|
2146
|
+
:last_modified_time,
|
2147
|
+
:program_name,
|
2148
|
+
:source_location_name,
|
2149
|
+
:vod_source_name)
|
2150
|
+
SENSITIVE = []
|
2151
|
+
include Aws::Structure
|
2152
|
+
end
|
2153
|
+
|
2154
|
+
# Adds an IAM policy for the channel.
|
2155
|
+
#
|
2156
|
+
# @note When making an API call, you may pass PutChannelPolicyRequest
|
2157
|
+
# data as a hash:
|
2158
|
+
#
|
2159
|
+
# {
|
2160
|
+
# channel_name: "__string", # required
|
2161
|
+
# policy: "__string", # required
|
2162
|
+
# }
|
2163
|
+
#
|
2164
|
+
# @!attribute [rw] channel_name
|
2165
|
+
# @return [String]
|
2166
|
+
#
|
2167
|
+
# @!attribute [rw] policy
|
2168
|
+
# Adds an IAM role that determines the permissions of your channel.
|
2169
|
+
# @return [String]
|
2170
|
+
#
|
2171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutChannelPolicyRequest AWS API Documentation
|
2172
|
+
#
|
2173
|
+
class PutChannelPolicyRequest < Struct.new(
|
2174
|
+
:channel_name,
|
2175
|
+
:policy)
|
2176
|
+
SENSITIVE = []
|
2177
|
+
include Aws::Structure
|
2178
|
+
end
|
2179
|
+
|
2180
|
+
# This response includes only the "type" : "object" property.
|
2181
|
+
#
|
2182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutChannelPolicyResponse AWS API Documentation
|
2183
|
+
#
|
2184
|
+
class PutChannelPolicyResponse < Aws::EmptyStructure; end
|
2185
|
+
|
2186
|
+
# The configuration for creating a playback configuration.
|
2187
|
+
#
|
2188
|
+
# @note When making an API call, you may pass PutPlaybackConfigurationRequest
|
2189
|
+
# data as a hash:
|
2190
|
+
#
|
2191
|
+
# {
|
2192
|
+
# ad_decision_server_url: "__string",
|
2193
|
+
# avail_suppression: {
|
2194
|
+
# mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE
|
2195
|
+
# value: "__string",
|
2196
|
+
# },
|
2197
|
+
# bumper: {
|
2198
|
+
# end_url: "__string",
|
2199
|
+
# start_url: "__string",
|
2200
|
+
# },
|
2201
|
+
# cdn_configuration: {
|
2202
|
+
# ad_segment_url_prefix: "__string",
|
2203
|
+
# content_segment_url_prefix: "__string",
|
2204
|
+
# },
|
2205
|
+
# configuration_aliases: {
|
2206
|
+
# "__string" => {
|
2207
|
+
# "__string" => "__string",
|
2208
|
+
# },
|
2209
|
+
# },
|
2210
|
+
# dash_configuration: {
|
2211
|
+
# mpd_location: "__string",
|
2212
|
+
# origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
|
2213
|
+
# },
|
2214
|
+
# live_pre_roll_configuration: {
|
2215
|
+
# ad_decision_server_url: "__string",
|
2216
|
+
# max_duration_seconds: 1,
|
2217
|
+
# },
|
2218
|
+
# manifest_processing_rules: {
|
2219
|
+
# ad_marker_passthrough: {
|
2220
|
+
# enabled: false,
|
2221
|
+
# },
|
2222
|
+
# },
|
2223
|
+
# name: "__string",
|
2224
|
+
# personalization_threshold_seconds: 1,
|
2225
|
+
# slate_ad_url: "__string",
|
2226
|
+
# tags: {
|
2227
|
+
# "__string" => "__string",
|
2228
|
+
# },
|
2229
|
+
# transcode_profile_name: "__string",
|
2230
|
+
# video_content_source_url: "__string",
|
2231
|
+
# }
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] ad_decision_server_url
|
2234
|
+
# The URL for the ad decision server (ADS). This includes the
|
2235
|
+
# specification of static parameters and placeholders for dynamic
|
2236
|
+
# parameters. AWS Elemental MediaTailor substitutes player-specific
|
2237
|
+
# and session-specific parameters as needed when calling the ADS.
|
2238
|
+
# Alternately, for testing you can provide a static VAST URL. The
|
2239
|
+
# maximum length is 25,000 characters.
|
2240
|
+
# @return [String]
|
2241
|
+
#
|
2242
|
+
# @!attribute [rw] avail_suppression
|
2243
|
+
# The configuration for avail suppression, also known as ad
|
2244
|
+
# suppression. For more information about ad suppression, see [Ad
|
2245
|
+
# Suppression][1].
|
2246
|
+
#
|
2247
|
+
#
|
2248
|
+
#
|
2249
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
2250
|
+
# @return [Types::AvailSuppression]
|
2251
|
+
#
|
2252
|
+
# @!attribute [rw] bumper
|
2253
|
+
# The configuration for bumpers. Bumpers are short audio or video
|
2254
|
+
# clips that play at the start or before the end of an ad break. To
|
2255
|
+
# learn more about bumpers, see [Bumpers][1].
|
2256
|
+
#
|
2257
|
+
#
|
2258
|
+
#
|
2259
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
|
2260
|
+
# @return [Types::Bumper]
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] cdn_configuration
|
2263
|
+
# The configuration for using a content delivery network (CDN), like
|
2264
|
+
# Amazon CloudFront, for content and ad segment management.
|
2265
|
+
# @return [Types::CdnConfiguration]
|
2266
|
+
#
|
2267
|
+
# @!attribute [rw] configuration_aliases
|
2268
|
+
# The player parameters and aliases used as dynamic variables during
|
2269
|
+
# session initialization. For more information, see [Domain
|
2270
|
+
# Variables][1].
|
2271
|
+
#
|
2272
|
+
#
|
2273
|
+
#
|
2274
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
|
2275
|
+
# @return [Hash<String,Hash<String,String>>]
|
2276
|
+
#
|
2277
|
+
# @!attribute [rw] dash_configuration
|
2278
|
+
# The configuration for DASH content.
|
2279
|
+
# @return [Types::DashConfigurationForPut]
|
2280
|
+
#
|
2281
|
+
# @!attribute [rw] live_pre_roll_configuration
|
2282
|
+
# The configuration for pre-roll ad insertion.
|
2283
|
+
# @return [Types::LivePreRollConfiguration]
|
2284
|
+
#
|
2285
|
+
# @!attribute [rw] manifest_processing_rules
|
2286
|
+
# The configuration for manifest processing rules. Manifest processing
|
2287
|
+
# rules enable customization of the personalized manifests created by
|
2288
|
+
# MediaTailor.
|
2289
|
+
# @return [Types::ManifestProcessingRules]
|
2290
|
+
#
|
2291
|
+
# @!attribute [rw] name
|
2292
|
+
# The identifier for the playback configuration.
|
2293
|
+
# @return [String]
|
2294
|
+
#
|
2295
|
+
# @!attribute [rw] personalization_threshold_seconds
|
2296
|
+
# Defines the maximum duration of underfilled ad time (in seconds)
|
2297
|
+
# allowed in an ad break. If the duration of underfilled ad time
|
2298
|
+
# exceeds the personalization threshold, then the personalization of
|
2299
|
+
# the ad break is abandoned and the underlying content is shown. This
|
2300
|
+
# feature applies to *ad replacement* in live and VOD streams, rather
|
2301
|
+
# than ad insertion, because it relies on an underlying content
|
2302
|
+
# stream. For more information about ad break behavior, including ad
|
2303
|
+
# replacement and insertion, see [Ad Behavior in AWS Elemental
|
2304
|
+
# MediaTailor][1].
|
2305
|
+
#
|
2306
|
+
#
|
2307
|
+
#
|
2308
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
2309
|
+
# @return [Integer]
|
2310
|
+
#
|
2311
|
+
# @!attribute [rw] slate_ad_url
|
2312
|
+
# The URL for a high-quality video asset to transcode and use to fill
|
2313
|
+
# in time that's not used by ads. AWS Elemental MediaTailor shows the
|
2314
|
+
# slate to fill in gaps in media content. Configuring the slate is
|
2315
|
+
# optional for non-VPAID configurations. For VPAID, the slate is
|
2316
|
+
# required because MediaTailor provides it in the slots that are
|
2317
|
+
# designated for dynamic ad content. The slate must be a high-quality
|
2318
|
+
# asset that contains both audio and video.
|
2319
|
+
# @return [String]
|
2320
|
+
#
|
2321
|
+
# @!attribute [rw] tags
|
2322
|
+
# The tags to assign to the playback configuration.
|
2323
|
+
# @return [Hash<String,String>]
|
2324
|
+
#
|
2325
|
+
# @!attribute [rw] transcode_profile_name
|
2326
|
+
# The name that is used to associate this playback configuration with
|
2327
|
+
# a custom transcode profile. This overrides the dynamic transcoding
|
2328
|
+
# defaults of MediaTailor. Use this only if you have already set up
|
2329
|
+
# custom profiles with the help of AWS Support.
|
2330
|
+
# @return [String]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] video_content_source_url
|
2333
|
+
# The URL prefix for the parent manifest for the stream, minus the
|
2334
|
+
# asset ID. The maximum length is 512 characters.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfigurationRequest AWS API Documentation
|
2338
|
+
#
|
2339
|
+
class PutPlaybackConfigurationRequest < Struct.new(
|
2340
|
+
:ad_decision_server_url,
|
2341
|
+
:avail_suppression,
|
2342
|
+
:bumper,
|
2343
|
+
:cdn_configuration,
|
2344
|
+
:configuration_aliases,
|
2345
|
+
:dash_configuration,
|
2346
|
+
:live_pre_roll_configuration,
|
2347
|
+
:manifest_processing_rules,
|
2348
|
+
:name,
|
2349
|
+
:personalization_threshold_seconds,
|
2350
|
+
:slate_ad_url,
|
2351
|
+
:tags,
|
2352
|
+
:transcode_profile_name,
|
2353
|
+
:video_content_source_url)
|
2354
|
+
SENSITIVE = []
|
2355
|
+
include Aws::Structure
|
2356
|
+
end
|
2357
|
+
|
2358
|
+
# @!attribute [rw] ad_decision_server_url
|
2359
|
+
# @return [String]
|
2360
|
+
#
|
2361
|
+
# @!attribute [rw] avail_suppression
|
2362
|
+
# The configuration for avail suppression, also known as ad
|
2363
|
+
# suppression. For more information about ad suppression, see [Ad
|
2364
|
+
# Suppression][1].
|
2365
|
+
#
|
2366
|
+
#
|
2367
|
+
#
|
2368
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
2369
|
+
# @return [Types::AvailSuppression]
|
2370
|
+
#
|
2371
|
+
# @!attribute [rw] bumper
|
2372
|
+
# The configuration for bumpers. Bumpers are short audio or video
|
2373
|
+
# clips that play at the start or before the end of an ad break. To
|
2374
|
+
# learn more about bumpers, see [Bumpers][1].
|
2375
|
+
#
|
2376
|
+
#
|
2377
|
+
#
|
2378
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
|
2379
|
+
# @return [Types::Bumper]
|
2380
|
+
#
|
2381
|
+
# @!attribute [rw] cdn_configuration
|
2382
|
+
# The configuration for using a content delivery network (CDN), like
|
2383
|
+
# Amazon CloudFront, for content and ad segment management.
|
2384
|
+
# @return [Types::CdnConfiguration]
|
2385
|
+
#
|
2386
|
+
# @!attribute [rw] configuration_aliases
|
2387
|
+
# The predefined aliases for dynamic variables.
|
757
2388
|
# @return [Hash<String,Hash<String,String>>]
|
758
2389
|
#
|
759
|
-
# @!attribute [rw] dash_configuration
|
760
|
-
# The configuration for DASH content.
|
761
|
-
# @return [Types::DashConfiguration]
|
2390
|
+
# @!attribute [rw] dash_configuration
|
2391
|
+
# The configuration for DASH content.
|
2392
|
+
# @return [Types::DashConfiguration]
|
2393
|
+
#
|
2394
|
+
# @!attribute [rw] hls_configuration
|
2395
|
+
# The configuration for HLS content.
|
2396
|
+
# @return [Types::HlsConfiguration]
|
2397
|
+
#
|
2398
|
+
# @!attribute [rw] live_pre_roll_configuration
|
2399
|
+
# The configuration for pre-roll ad insertion.
|
2400
|
+
# @return [Types::LivePreRollConfiguration]
|
2401
|
+
#
|
2402
|
+
# @!attribute [rw] manifest_processing_rules
|
2403
|
+
# The configuration for manifest processing rules. Manifest processing
|
2404
|
+
# rules enable customization of the personalized manifests created by
|
2405
|
+
# MediaTailor.
|
2406
|
+
# @return [Types::ManifestProcessingRules]
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] name
|
2409
|
+
# @return [String]
|
2410
|
+
#
|
2411
|
+
# @!attribute [rw] personalization_threshold_seconds
|
2412
|
+
# @return [Integer]
|
2413
|
+
#
|
2414
|
+
# @!attribute [rw] playback_configuration_arn
|
2415
|
+
# @return [String]
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] playback_endpoint_prefix
|
2418
|
+
# @return [String]
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] session_initialization_endpoint_prefix
|
2421
|
+
# @return [String]
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] slate_ad_url
|
2424
|
+
# @return [String]
|
2425
|
+
#
|
2426
|
+
# @!attribute [rw] tags
|
2427
|
+
# @return [Hash<String,String>]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] transcode_profile_name
|
2430
|
+
# @return [String]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] video_content_source_url
|
2433
|
+
# @return [String]
|
2434
|
+
#
|
2435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfigurationResponse AWS API Documentation
|
2436
|
+
#
|
2437
|
+
class PutPlaybackConfigurationResponse < Struct.new(
|
2438
|
+
:ad_decision_server_url,
|
2439
|
+
:avail_suppression,
|
2440
|
+
:bumper,
|
2441
|
+
:cdn_configuration,
|
2442
|
+
:configuration_aliases,
|
2443
|
+
:dash_configuration,
|
2444
|
+
:hls_configuration,
|
2445
|
+
:live_pre_roll_configuration,
|
2446
|
+
:manifest_processing_rules,
|
2447
|
+
:name,
|
2448
|
+
:personalization_threshold_seconds,
|
2449
|
+
:playback_configuration_arn,
|
2450
|
+
:playback_endpoint_prefix,
|
2451
|
+
:session_initialization_endpoint_prefix,
|
2452
|
+
:slate_ad_url,
|
2453
|
+
:tags,
|
2454
|
+
:transcode_profile_name,
|
2455
|
+
:video_content_source_url)
|
2456
|
+
SENSITIVE = []
|
2457
|
+
include Aws::Structure
|
2458
|
+
end
|
2459
|
+
|
2460
|
+
# The ouput configuration for this channel.
|
2461
|
+
#
|
2462
|
+
# @note When making an API call, you may pass RequestOutputItem
|
2463
|
+
# data as a hash:
|
2464
|
+
#
|
2465
|
+
# {
|
2466
|
+
# dash_playlist_settings: {
|
2467
|
+
# manifest_window_seconds: 1,
|
2468
|
+
# min_buffer_time_seconds: 1,
|
2469
|
+
# min_update_period_seconds: 1,
|
2470
|
+
# suggested_presentation_delay_seconds: 1,
|
2471
|
+
# },
|
2472
|
+
# hls_playlist_settings: {
|
2473
|
+
# manifest_window_seconds: 1,
|
2474
|
+
# },
|
2475
|
+
# manifest_name: "__string", # required
|
2476
|
+
# source_group: "__string", # required
|
2477
|
+
# }
|
2478
|
+
#
|
2479
|
+
# @!attribute [rw] dash_playlist_settings
|
2480
|
+
# DASH manifest configuration parameters.
|
2481
|
+
# @return [Types::DashPlaylistSettings]
|
2482
|
+
#
|
2483
|
+
# @!attribute [rw] hls_playlist_settings
|
2484
|
+
# HLS playlist configuration parameters.
|
2485
|
+
# @return [Types::HlsPlaylistSettings]
|
2486
|
+
#
|
2487
|
+
# @!attribute [rw] manifest_name
|
2488
|
+
# The name of the manifest for the channel. The name appears in the
|
2489
|
+
# PlaybackUrl.
|
2490
|
+
# @return [String]
|
2491
|
+
#
|
2492
|
+
# @!attribute [rw] source_group
|
2493
|
+
# A string used to match which HttpPackageConfiguration is used for
|
2494
|
+
# each VodSource.
|
2495
|
+
# @return [String]
|
2496
|
+
#
|
2497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RequestOutputItem AWS API Documentation
|
2498
|
+
#
|
2499
|
+
class RequestOutputItem < Struct.new(
|
2500
|
+
:dash_playlist_settings,
|
2501
|
+
:hls_playlist_settings,
|
2502
|
+
:manifest_name,
|
2503
|
+
:source_group)
|
2504
|
+
SENSITIVE = []
|
2505
|
+
include Aws::Structure
|
2506
|
+
end
|
2507
|
+
|
2508
|
+
# This response includes only the "property" : "type" property.
|
2509
|
+
#
|
2510
|
+
# @!attribute [rw] dash_playlist_settings
|
2511
|
+
# DASH manifest configuration settings.
|
2512
|
+
# @return [Types::DashPlaylistSettings]
|
2513
|
+
#
|
2514
|
+
# @!attribute [rw] hls_playlist_settings
|
2515
|
+
# HLS manifest configuration settings.
|
2516
|
+
# @return [Types::HlsPlaylistSettings]
|
2517
|
+
#
|
2518
|
+
# @!attribute [rw] manifest_name
|
2519
|
+
# The name of the manifest for the channel that will appear in the
|
2520
|
+
# channel output's playback URL.
|
2521
|
+
# @return [String]
|
2522
|
+
#
|
2523
|
+
# @!attribute [rw] playback_url
|
2524
|
+
# The URL used for playback by content players.
|
2525
|
+
# @return [String]
|
2526
|
+
#
|
2527
|
+
# @!attribute [rw] source_group
|
2528
|
+
# A string used to associate a package configuration source group with
|
2529
|
+
# a channel output.
|
2530
|
+
# @return [String]
|
2531
|
+
#
|
2532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ResponseOutputItem AWS API Documentation
|
2533
|
+
#
|
2534
|
+
class ResponseOutputItem < Struct.new(
|
2535
|
+
:dash_playlist_settings,
|
2536
|
+
:hls_playlist_settings,
|
2537
|
+
:manifest_name,
|
2538
|
+
:playback_url,
|
2539
|
+
:source_group)
|
2540
|
+
SENSITIVE = []
|
2541
|
+
include Aws::Structure
|
2542
|
+
end
|
2543
|
+
|
2544
|
+
# Schedule configuration parameters. A channel must be stopped before
|
2545
|
+
# changes can be made to the schedule.
|
2546
|
+
#
|
2547
|
+
# @note When making an API call, you may pass ScheduleConfiguration
|
2548
|
+
# data as a hash:
|
2549
|
+
#
|
2550
|
+
# {
|
2551
|
+
# transition: { # required
|
2552
|
+
# relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
|
2553
|
+
# relative_program: "__string",
|
2554
|
+
# type: "__string", # required
|
2555
|
+
# },
|
2556
|
+
# }
|
2557
|
+
#
|
2558
|
+
# @!attribute [rw] transition
|
2559
|
+
# Program transition configurations.
|
2560
|
+
# @return [Types::Transition]
|
2561
|
+
#
|
2562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ScheduleConfiguration AWS API Documentation
|
2563
|
+
#
|
2564
|
+
class ScheduleConfiguration < Struct.new(
|
2565
|
+
:transition)
|
2566
|
+
SENSITIVE = []
|
2567
|
+
include Aws::Structure
|
2568
|
+
end
|
2569
|
+
|
2570
|
+
# The properties for a schedule.
|
2571
|
+
#
|
2572
|
+
# @!attribute [rw] approximate_duration_seconds
|
2573
|
+
# The approximate duration of this program, in seconds.
|
2574
|
+
# @return [Integer]
|
762
2575
|
#
|
763
|
-
# @!attribute [rw]
|
764
|
-
# The
|
765
|
-
# @return [
|
2576
|
+
# @!attribute [rw] approximate_start_time
|
2577
|
+
# The approximate time that the program will start playing.
|
2578
|
+
# @return [Time]
|
766
2579
|
#
|
767
|
-
# @!attribute [rw]
|
768
|
-
# The
|
769
|
-
# @return [
|
2580
|
+
# @!attribute [rw] arn
|
2581
|
+
# The ARN of the program.
|
2582
|
+
# @return [String]
|
770
2583
|
#
|
771
|
-
# @!attribute [rw]
|
2584
|
+
# @!attribute [rw] channel_name
|
2585
|
+
# The name of the channel that uses this schedule.
|
772
2586
|
# @return [String]
|
773
2587
|
#
|
774
|
-
# @!attribute [rw]
|
775
|
-
# The
|
776
|
-
#
|
777
|
-
# MediaTailor.
|
778
|
-
# @return [Types::ManifestProcessingRules]
|
2588
|
+
# @!attribute [rw] program_name
|
2589
|
+
# The name of the program.
|
2590
|
+
# @return [String]
|
779
2591
|
#
|
780
|
-
# @!attribute [rw]
|
2592
|
+
# @!attribute [rw] source_location_name
|
2593
|
+
# The name of the source location.
|
781
2594
|
# @return [String]
|
782
2595
|
#
|
783
|
-
# @!attribute [rw]
|
2596
|
+
# @!attribute [rw] vod_source_name
|
2597
|
+
# The name of the VOD source.
|
784
2598
|
# @return [String]
|
785
2599
|
#
|
786
|
-
#
|
2600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ScheduleEntry AWS API Documentation
|
2601
|
+
#
|
2602
|
+
class ScheduleEntry < Struct.new(
|
2603
|
+
:approximate_duration_seconds,
|
2604
|
+
:approximate_start_time,
|
2605
|
+
:arn,
|
2606
|
+
:channel_name,
|
2607
|
+
:program_name,
|
2608
|
+
:source_location_name,
|
2609
|
+
:vod_source_name)
|
2610
|
+
SENSITIVE = []
|
2611
|
+
include Aws::Structure
|
2612
|
+
end
|
2613
|
+
|
2614
|
+
# Slate VOD source configuration.
|
2615
|
+
#
|
2616
|
+
# @note When making an API call, you may pass SlateSource
|
2617
|
+
# data as a hash:
|
2618
|
+
#
|
2619
|
+
# {
|
2620
|
+
# source_location_name: "__string",
|
2621
|
+
# vod_source_name: "__string",
|
2622
|
+
# }
|
2623
|
+
#
|
2624
|
+
# @!attribute [rw] source_location_name
|
2625
|
+
# The name of the source location where the slate VOD source is
|
2626
|
+
# stored.
|
787
2627
|
# @return [String]
|
788
2628
|
#
|
789
|
-
# @!attribute [rw]
|
2629
|
+
# @!attribute [rw] vod_source_name
|
2630
|
+
# The slate VOD source name. The VOD source must already exist in a
|
2631
|
+
# source location before it can be used for slate.
|
2632
|
+
# @return [String]
|
2633
|
+
#
|
2634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SlateSource AWS API Documentation
|
2635
|
+
#
|
2636
|
+
class SlateSource < Struct.new(
|
2637
|
+
:source_location_name,
|
2638
|
+
:vod_source_name)
|
2639
|
+
SENSITIVE = []
|
2640
|
+
include Aws::Structure
|
2641
|
+
end
|
2642
|
+
|
2643
|
+
# This response includes only the "type" : "object" property.
|
2644
|
+
#
|
2645
|
+
# @!attribute [rw] access_configuration
|
2646
|
+
# The access configuration for the source location.
|
2647
|
+
# @return [Types::AccessConfiguration]
|
2648
|
+
#
|
2649
|
+
# @!attribute [rw] arn
|
2650
|
+
# The ARN of the SourceLocation.
|
2651
|
+
# @return [String]
|
2652
|
+
#
|
2653
|
+
# @!attribute [rw] creation_time
|
2654
|
+
# The timestamp that indicates when the source location was created.
|
2655
|
+
# @return [Time]
|
2656
|
+
#
|
2657
|
+
# @!attribute [rw] default_segment_delivery_configuration
|
2658
|
+
# The default segment delivery configuration.
|
2659
|
+
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
2660
|
+
#
|
2661
|
+
# @!attribute [rw] http_configuration
|
2662
|
+
# The HTTP configuration for the source location.
|
2663
|
+
# @return [Types::HttpConfiguration]
|
2664
|
+
#
|
2665
|
+
# @!attribute [rw] last_modified_time
|
2666
|
+
# The timestamp that indicates when the source location was last
|
2667
|
+
# modified.
|
2668
|
+
# @return [Time]
|
2669
|
+
#
|
2670
|
+
# @!attribute [rw] source_location_name
|
2671
|
+
# The name of the source location.
|
790
2672
|
# @return [String]
|
791
2673
|
#
|
792
2674
|
# @!attribute [rw] tags
|
2675
|
+
# The tags assigned to the source location.
|
793
2676
|
# @return [Hash<String,String>]
|
794
2677
|
#
|
795
|
-
#
|
2678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SourceLocation AWS API Documentation
|
2679
|
+
#
|
2680
|
+
class SourceLocation < Struct.new(
|
2681
|
+
:access_configuration,
|
2682
|
+
:arn,
|
2683
|
+
:creation_time,
|
2684
|
+
:default_segment_delivery_configuration,
|
2685
|
+
:http_configuration,
|
2686
|
+
:last_modified_time,
|
2687
|
+
:source_location_name,
|
2688
|
+
:tags)
|
2689
|
+
SENSITIVE = []
|
2690
|
+
include Aws::Structure
|
2691
|
+
end
|
2692
|
+
|
2693
|
+
# Splice insert message configuration.
|
2694
|
+
#
|
2695
|
+
# @note When making an API call, you may pass SpliceInsertMessage
|
2696
|
+
# data as a hash:
|
2697
|
+
#
|
2698
|
+
# {
|
2699
|
+
# avail_num: 1,
|
2700
|
+
# avails_expected: 1,
|
2701
|
+
# splice_event_id: 1,
|
2702
|
+
# unique_program_id: 1,
|
2703
|
+
# }
|
2704
|
+
#
|
2705
|
+
# @!attribute [rw] avail_num
|
2706
|
+
# This is written to splice\_insert.avail\_num, as defined in section
|
2707
|
+
# 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values
|
2708
|
+
# must be between 0 and 256, inclusive.
|
2709
|
+
# @return [Integer]
|
2710
|
+
#
|
2711
|
+
# @!attribute [rw] avails_expected
|
2712
|
+
# This is written to splice\_insert.avails\_expected, as defined in
|
2713
|
+
# section 9.7.3.1 of the SCTE-35 specification. The default value is
|
2714
|
+
# 0. Values must be between 0 and 256, inclusive.
|
2715
|
+
# @return [Integer]
|
2716
|
+
#
|
2717
|
+
# @!attribute [rw] splice_event_id
|
2718
|
+
# This is written to splice\_insert.splice\_event\_id, as defined in
|
2719
|
+
# section 9.7.3.1 of the SCTE-35 specification. The default value is
|
2720
|
+
# 1.
|
2721
|
+
# @return [Integer]
|
2722
|
+
#
|
2723
|
+
# @!attribute [rw] unique_program_id
|
2724
|
+
# This is written to splice\_insert.unique\_program\_id, as defined in
|
2725
|
+
# section 9.7.3.1 of the SCTE-35 specification. The default value is
|
2726
|
+
# 0. Values must be between 0 and 256, inclusive.
|
2727
|
+
# @return [Integer]
|
2728
|
+
#
|
2729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SpliceInsertMessage AWS API Documentation
|
2730
|
+
#
|
2731
|
+
class SpliceInsertMessage < Struct.new(
|
2732
|
+
:avail_num,
|
2733
|
+
:avails_expected,
|
2734
|
+
:splice_event_id,
|
2735
|
+
:unique_program_id)
|
2736
|
+
SENSITIVE = []
|
2737
|
+
include Aws::Structure
|
2738
|
+
end
|
2739
|
+
|
2740
|
+
# @note When making an API call, you may pass StartChannelRequest
|
2741
|
+
# data as a hash:
|
2742
|
+
#
|
2743
|
+
# {
|
2744
|
+
# channel_name: "__string", # required
|
2745
|
+
# }
|
2746
|
+
#
|
2747
|
+
# @!attribute [rw] channel_name
|
796
2748
|
# @return [String]
|
797
2749
|
#
|
798
|
-
#
|
2750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StartChannelRequest AWS API Documentation
|
2751
|
+
#
|
2752
|
+
class StartChannelRequest < Struct.new(
|
2753
|
+
:channel_name)
|
2754
|
+
SENSITIVE = []
|
2755
|
+
include Aws::Structure
|
2756
|
+
end
|
2757
|
+
|
2758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StartChannelResponse AWS API Documentation
|
2759
|
+
#
|
2760
|
+
class StartChannelResponse < Aws::EmptyStructure; end
|
2761
|
+
|
2762
|
+
# @note When making an API call, you may pass StopChannelRequest
|
2763
|
+
# data as a hash:
|
2764
|
+
#
|
2765
|
+
# {
|
2766
|
+
# channel_name: "__string", # required
|
2767
|
+
# }
|
2768
|
+
#
|
2769
|
+
# @!attribute [rw] channel_name
|
799
2770
|
# @return [String]
|
800
2771
|
#
|
801
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/
|
2772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StopChannelRequest AWS API Documentation
|
802
2773
|
#
|
803
|
-
class
|
804
|
-
:
|
805
|
-
:avail_suppression,
|
806
|
-
:bumper,
|
807
|
-
:cdn_configuration,
|
808
|
-
:configuration_aliases,
|
809
|
-
:dash_configuration,
|
810
|
-
:hls_configuration,
|
811
|
-
:live_pre_roll_configuration,
|
812
|
-
:name,
|
813
|
-
:manifest_processing_rules,
|
814
|
-
:playback_configuration_arn,
|
815
|
-
:playback_endpoint_prefix,
|
816
|
-
:session_initialization_endpoint_prefix,
|
817
|
-
:slate_ad_url,
|
818
|
-
:tags,
|
819
|
-
:transcode_profile_name,
|
820
|
-
:video_content_source_url)
|
2774
|
+
class StopChannelRequest < Struct.new(
|
2775
|
+
:channel_name)
|
821
2776
|
SENSITIVE = []
|
822
2777
|
include Aws::Structure
|
823
2778
|
end
|
824
2779
|
|
2780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StopChannelResponse AWS API Documentation
|
2781
|
+
#
|
2782
|
+
class StopChannelResponse < Aws::EmptyStructure; end
|
2783
|
+
|
825
2784
|
# @note When making an API call, you may pass TagResourceRequest
|
826
2785
|
# data as a hash:
|
827
2786
|
#
|
@@ -847,17 +2806,39 @@ module Aws::MediaTailor
|
|
847
2806
|
include Aws::Structure
|
848
2807
|
end
|
849
2808
|
|
850
|
-
#
|
2809
|
+
# Program transition configuration.
|
851
2810
|
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
# "Key1": "Value1", "Key2": "Value2" \\}
|
855
|
-
# @return [Hash<String,String>]
|
2811
|
+
# @note When making an API call, you may pass Transition
|
2812
|
+
# data as a hash:
|
856
2813
|
#
|
857
|
-
#
|
2814
|
+
# {
|
2815
|
+
# relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
|
2816
|
+
# relative_program: "__string",
|
2817
|
+
# type: "__string", # required
|
2818
|
+
# }
|
858
2819
|
#
|
859
|
-
|
860
|
-
|
2820
|
+
# @!attribute [rw] relative_position
|
2821
|
+
# The position where this program will be inserted relative to the
|
2822
|
+
# RelativeProgram. Possible values are: AFTER\_PROGRAM, and
|
2823
|
+
# BEFORE\_PROGRAM.
|
2824
|
+
# @return [String]
|
2825
|
+
#
|
2826
|
+
# @!attribute [rw] relative_program
|
2827
|
+
# The name of the program that this program will be inserted next to,
|
2828
|
+
# as defined by RelativePosition.
|
2829
|
+
# @return [String]
|
2830
|
+
#
|
2831
|
+
# @!attribute [rw] type
|
2832
|
+
# When the program should be played. RELATIVE means that programs will
|
2833
|
+
# be played back-to-back.
|
2834
|
+
# @return [String]
|
2835
|
+
#
|
2836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Transition AWS API Documentation
|
2837
|
+
#
|
2838
|
+
class Transition < Struct.new(
|
2839
|
+
:relative_position,
|
2840
|
+
:relative_program,
|
2841
|
+
:type)
|
861
2842
|
SENSITIVE = []
|
862
2843
|
include Aws::Structure
|
863
2844
|
end
|
@@ -885,5 +2866,296 @@ module Aws::MediaTailor
|
|
885
2866
|
include Aws::Structure
|
886
2867
|
end
|
887
2868
|
|
2869
|
+
# Updates a channel's Outputs.
|
2870
|
+
#
|
2871
|
+
# @note When making an API call, you may pass UpdateChannelRequest
|
2872
|
+
# data as a hash:
|
2873
|
+
#
|
2874
|
+
# {
|
2875
|
+
# channel_name: "__string", # required
|
2876
|
+
# outputs: [ # required
|
2877
|
+
# {
|
2878
|
+
# dash_playlist_settings: {
|
2879
|
+
# manifest_window_seconds: 1,
|
2880
|
+
# min_buffer_time_seconds: 1,
|
2881
|
+
# min_update_period_seconds: 1,
|
2882
|
+
# suggested_presentation_delay_seconds: 1,
|
2883
|
+
# },
|
2884
|
+
# hls_playlist_settings: {
|
2885
|
+
# manifest_window_seconds: 1,
|
2886
|
+
# },
|
2887
|
+
# manifest_name: "__string", # required
|
2888
|
+
# source_group: "__string", # required
|
2889
|
+
# },
|
2890
|
+
# ],
|
2891
|
+
# }
|
2892
|
+
#
|
2893
|
+
# @!attribute [rw] channel_name
|
2894
|
+
# @return [String]
|
2895
|
+
#
|
2896
|
+
# @!attribute [rw] outputs
|
2897
|
+
# The channel's output properties.
|
2898
|
+
# @return [Array<Types::RequestOutputItem>]
|
2899
|
+
#
|
2900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannelRequest AWS API Documentation
|
2901
|
+
#
|
2902
|
+
class UpdateChannelRequest < Struct.new(
|
2903
|
+
:channel_name,
|
2904
|
+
:outputs)
|
2905
|
+
SENSITIVE = []
|
2906
|
+
include Aws::Structure
|
2907
|
+
end
|
2908
|
+
|
2909
|
+
# @!attribute [rw] arn
|
2910
|
+
# @return [String]
|
2911
|
+
#
|
2912
|
+
# @!attribute [rw] channel_name
|
2913
|
+
# @return [String]
|
2914
|
+
#
|
2915
|
+
# @!attribute [rw] channel_state
|
2916
|
+
# @return [String]
|
2917
|
+
#
|
2918
|
+
# @!attribute [rw] creation_time
|
2919
|
+
# @return [Time]
|
2920
|
+
#
|
2921
|
+
# @!attribute [rw] last_modified_time
|
2922
|
+
# @return [Time]
|
2923
|
+
#
|
2924
|
+
# @!attribute [rw] outputs
|
2925
|
+
# @return [Array<Types::ResponseOutputItem>]
|
2926
|
+
#
|
2927
|
+
# @!attribute [rw] playback_mode
|
2928
|
+
# @return [String]
|
2929
|
+
#
|
2930
|
+
# @!attribute [rw] tags
|
2931
|
+
# @return [Hash<String,String>]
|
2932
|
+
#
|
2933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannelResponse AWS API Documentation
|
2934
|
+
#
|
2935
|
+
class UpdateChannelResponse < Struct.new(
|
2936
|
+
:arn,
|
2937
|
+
:channel_name,
|
2938
|
+
:channel_state,
|
2939
|
+
:creation_time,
|
2940
|
+
:last_modified_time,
|
2941
|
+
:outputs,
|
2942
|
+
:playback_mode,
|
2943
|
+
:tags)
|
2944
|
+
SENSITIVE = []
|
2945
|
+
include Aws::Structure
|
2946
|
+
end
|
2947
|
+
|
2948
|
+
# Source location configuration parameters.
|
2949
|
+
#
|
2950
|
+
# @note When making an API call, you may pass UpdateSourceLocationRequest
|
2951
|
+
# data as a hash:
|
2952
|
+
#
|
2953
|
+
# {
|
2954
|
+
# access_configuration: {
|
2955
|
+
# access_type: "S3_SIGV4", # accepts S3_SIGV4
|
2956
|
+
# },
|
2957
|
+
# default_segment_delivery_configuration: {
|
2958
|
+
# base_url: "__string",
|
2959
|
+
# },
|
2960
|
+
# http_configuration: { # required
|
2961
|
+
# base_url: "__string", # required
|
2962
|
+
# },
|
2963
|
+
# source_location_name: "__string", # required
|
2964
|
+
# }
|
2965
|
+
#
|
2966
|
+
# @!attribute [rw] access_configuration
|
2967
|
+
# Access configuration parameters. Configures the type of
|
2968
|
+
# authentication used to access content from your source location.
|
2969
|
+
# @return [Types::AccessConfiguration]
|
2970
|
+
#
|
2971
|
+
# @!attribute [rw] default_segment_delivery_configuration
|
2972
|
+
# The optional configuration for the host server that serves segments.
|
2973
|
+
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
2974
|
+
#
|
2975
|
+
# @!attribute [rw] http_configuration
|
2976
|
+
# The HTTP configuration for the source location.
|
2977
|
+
# @return [Types::HttpConfiguration]
|
2978
|
+
#
|
2979
|
+
# @!attribute [rw] source_location_name
|
2980
|
+
# @return [String]
|
2981
|
+
#
|
2982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationRequest AWS API Documentation
|
2983
|
+
#
|
2984
|
+
class UpdateSourceLocationRequest < Struct.new(
|
2985
|
+
:access_configuration,
|
2986
|
+
:default_segment_delivery_configuration,
|
2987
|
+
:http_configuration,
|
2988
|
+
:source_location_name)
|
2989
|
+
SENSITIVE = []
|
2990
|
+
include Aws::Structure
|
2991
|
+
end
|
2992
|
+
|
2993
|
+
# @!attribute [rw] access_configuration
|
2994
|
+
# Access configuration parameters.
|
2995
|
+
# @return [Types::AccessConfiguration]
|
2996
|
+
#
|
2997
|
+
# @!attribute [rw] arn
|
2998
|
+
# @return [String]
|
2999
|
+
#
|
3000
|
+
# @!attribute [rw] creation_time
|
3001
|
+
# @return [Time]
|
3002
|
+
#
|
3003
|
+
# @!attribute [rw] default_segment_delivery_configuration
|
3004
|
+
# The optional configuration for a server that serves segments. Use
|
3005
|
+
# this if you want the segment delivery server to be different from
|
3006
|
+
# the source location server. For example, you can configure your
|
3007
|
+
# source location server to be an origination server, such as
|
3008
|
+
# MediaPackage, and the segment delivery server to be a content
|
3009
|
+
# delivery network (CDN), such as CloudFront. If you don't specify a
|
3010
|
+
# segment delivery server, then the source location server is used.
|
3011
|
+
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
3012
|
+
#
|
3013
|
+
# @!attribute [rw] http_configuration
|
3014
|
+
# The HTTP configuration for the source location.
|
3015
|
+
# @return [Types::HttpConfiguration]
|
3016
|
+
#
|
3017
|
+
# @!attribute [rw] last_modified_time
|
3018
|
+
# @return [Time]
|
3019
|
+
#
|
3020
|
+
# @!attribute [rw] source_location_name
|
3021
|
+
# @return [String]
|
3022
|
+
#
|
3023
|
+
# @!attribute [rw] tags
|
3024
|
+
# @return [Hash<String,String>]
|
3025
|
+
#
|
3026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationResponse AWS API Documentation
|
3027
|
+
#
|
3028
|
+
class UpdateSourceLocationResponse < Struct.new(
|
3029
|
+
:access_configuration,
|
3030
|
+
:arn,
|
3031
|
+
:creation_time,
|
3032
|
+
:default_segment_delivery_configuration,
|
3033
|
+
:http_configuration,
|
3034
|
+
:last_modified_time,
|
3035
|
+
:source_location_name,
|
3036
|
+
:tags)
|
3037
|
+
SENSITIVE = []
|
3038
|
+
include Aws::Structure
|
3039
|
+
end
|
3040
|
+
|
3041
|
+
# Updates a VOD source's configuration.
|
3042
|
+
#
|
3043
|
+
# @note When making an API call, you may pass UpdateVodSourceRequest
|
3044
|
+
# data as a hash:
|
3045
|
+
#
|
3046
|
+
# {
|
3047
|
+
# http_package_configurations: [ # required
|
3048
|
+
# {
|
3049
|
+
# path: "__string", # required
|
3050
|
+
# source_group: "__string", # required
|
3051
|
+
# type: "DASH", # required, accepts DASH, HLS
|
3052
|
+
# },
|
3053
|
+
# ],
|
3054
|
+
# source_location_name: "__string", # required
|
3055
|
+
# vod_source_name: "__string", # required
|
3056
|
+
# }
|
3057
|
+
#
|
3058
|
+
# @!attribute [rw] http_package_configurations
|
3059
|
+
# An array of HTTP package configurations for the VOD source on this
|
3060
|
+
# account.
|
3061
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
3062
|
+
#
|
3063
|
+
# @!attribute [rw] source_location_name
|
3064
|
+
# @return [String]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] vod_source_name
|
3067
|
+
# @return [String]
|
3068
|
+
#
|
3069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceRequest AWS API Documentation
|
3070
|
+
#
|
3071
|
+
class UpdateVodSourceRequest < Struct.new(
|
3072
|
+
:http_package_configurations,
|
3073
|
+
:source_location_name,
|
3074
|
+
:vod_source_name)
|
3075
|
+
SENSITIVE = []
|
3076
|
+
include Aws::Structure
|
3077
|
+
end
|
3078
|
+
|
3079
|
+
# @!attribute [rw] arn
|
3080
|
+
# @return [String]
|
3081
|
+
#
|
3082
|
+
# @!attribute [rw] creation_time
|
3083
|
+
# @return [Time]
|
3084
|
+
#
|
3085
|
+
# @!attribute [rw] http_package_configurations
|
3086
|
+
# The VOD source's HTTP package configuration settings.
|
3087
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
3088
|
+
#
|
3089
|
+
# @!attribute [rw] last_modified_time
|
3090
|
+
# @return [Time]
|
3091
|
+
#
|
3092
|
+
# @!attribute [rw] source_location_name
|
3093
|
+
# @return [String]
|
3094
|
+
#
|
3095
|
+
# @!attribute [rw] tags
|
3096
|
+
# @return [Hash<String,String>]
|
3097
|
+
#
|
3098
|
+
# @!attribute [rw] vod_source_name
|
3099
|
+
# @return [String]
|
3100
|
+
#
|
3101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceResponse AWS API Documentation
|
3102
|
+
#
|
3103
|
+
class UpdateVodSourceResponse < Struct.new(
|
3104
|
+
:arn,
|
3105
|
+
:creation_time,
|
3106
|
+
:http_package_configurations,
|
3107
|
+
:last_modified_time,
|
3108
|
+
:source_location_name,
|
3109
|
+
:tags,
|
3110
|
+
:vod_source_name)
|
3111
|
+
SENSITIVE = []
|
3112
|
+
include Aws::Structure
|
3113
|
+
end
|
3114
|
+
|
3115
|
+
# VOD source configuration parameters.
|
3116
|
+
#
|
3117
|
+
# @!attribute [rw] arn
|
3118
|
+
# The ARN for the VOD source.
|
3119
|
+
# @return [String]
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] creation_time
|
3122
|
+
# The timestamp that indicates when the VOD source was created.
|
3123
|
+
# @return [Time]
|
3124
|
+
#
|
3125
|
+
# @!attribute [rw] http_package_configurations
|
3126
|
+
# The HTTP package configurations for the VOD source.
|
3127
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
3128
|
+
#
|
3129
|
+
# @!attribute [rw] last_modified_time
|
3130
|
+
# The timestamp that indicates when the VOD source was last modified.
|
3131
|
+
# @return [Time]
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] source_location_name
|
3134
|
+
# The name of the source location that the VOD source is associated
|
3135
|
+
# with.
|
3136
|
+
# @return [String]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] tags
|
3139
|
+
# The tags assigned to the VOD source.
|
3140
|
+
# @return [Hash<String,String>]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] vod_source_name
|
3143
|
+
# The name of the VOD source.
|
3144
|
+
# @return [String]
|
3145
|
+
#
|
3146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/VodSource AWS API Documentation
|
3147
|
+
#
|
3148
|
+
class VodSource < Struct.new(
|
3149
|
+
:arn,
|
3150
|
+
:creation_time,
|
3151
|
+
:http_package_configurations,
|
3152
|
+
:last_modified_time,
|
3153
|
+
:source_location_name,
|
3154
|
+
:tags,
|
3155
|
+
:vod_source_name)
|
3156
|
+
SENSITIVE = []
|
3157
|
+
include Aws::Structure
|
3158
|
+
end
|
3159
|
+
|
888
3160
|
end
|
889
3161
|
end
|