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