aws-sdk-mediatailor 1.43.0 → 1.47.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -179,6 +179,61 @@ module Aws::MediaTailor
179
179
  include Aws::Structure
180
180
  end
181
181
 
182
+ # MediaTailor only places (consumes) prefetched ads if the ad break
183
+ # meets the criteria defined by the dynamic variables. This gives you
184
+ # granular control over which ad break to place the prefetched ads into.
185
+ #
186
+ # As an example, let's say that you set DynamicVariable to
187
+ # scte.event\_id and Operator to EQUALS, and your playback configuration
188
+ # has an ADS URL of
189
+ # https://my.ads.server.com/path?&podId=\[scte.avail\_num\]&event=\[scte.event\_id\]&duration=\[session.avail\_duration\_secs\].
190
+ # And the prefetch request to the ADS contains these values
191
+ # https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30.
192
+ # MediaTailor will only insert the prefetched ads into the ad break if
193
+ # has a SCTE marker with an event id of my-awesome-event, since it must
194
+ # match the event id that MediaTailor uses to query the ADS.
195
+ #
196
+ # You can specify up to five AvailMatchingCriteria. If you specify
197
+ # multiple AvailMatchingCriteria, MediaTailor combines them to match
198
+ # using a logical AND. You can model logical OR combinations by creating
199
+ # multiple prefetch schedules.
200
+ #
201
+ # @note When making an API call, you may pass AvailMatchingCriteria
202
+ # data as a hash:
203
+ #
204
+ # {
205
+ # dynamic_variable: "__string", # required
206
+ # operator: "EQUALS", # required, accepts EQUALS
207
+ # }
208
+ #
209
+ # @!attribute [rw] dynamic_variable
210
+ # The dynamic variable(s) that MediaTailor should use as avail
211
+ # matching criteria. MediaTailor only places the prefetched ads into
212
+ # the avail if the avail matches the criteria defined by the dynamic
213
+ # variable. For information about dynamic variables, see [Using
214
+ # dynamic ad variables][1] in the *MediaTailor User Guide*.
215
+ #
216
+ # You can include up to 100 dynamic variables.
217
+ #
218
+ #
219
+ #
220
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html
221
+ # @return [String]
222
+ #
223
+ # @!attribute [rw] operator
224
+ # For the DynamicVariable specified in AvailMatchingCriteria, the
225
+ # Operator that is used for the comparison.
226
+ # @return [String]
227
+ #
228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AvailMatchingCriteria AWS API Documentation
229
+ #
230
+ class AvailMatchingCriteria < Struct.new(
231
+ :dynamic_variable,
232
+ :operator)
233
+ SENSITIVE = []
234
+ include Aws::Structure
235
+ end
236
+
182
237
  # The configuration for avail suppression, also known as ad suppression.
183
238
  # For more information about ad suppression, see [Ad Suppression][1].
184
239
  #
@@ -329,6 +384,12 @@ module Aws::MediaTailor
329
384
  # The timestamp of when the channel was created.
330
385
  # @return [Time]
331
386
  #
387
+ # @!attribute [rw] filler_slate
388
+ # Contains information about the slate used to fill gaps between
389
+ # programs in the schedule. You must configure FillerSlate if your
390
+ # channel uses an LINEAR PlaybackMode.
391
+ # @return [Types::SlateSource]
392
+ #
332
393
  # @!attribute [rw] last_modified_time
333
394
  # The timestamp of when the channel was last modified.
334
395
  # @return [Time]
@@ -338,8 +399,13 @@ module Aws::MediaTailor
338
399
  # @return [Array<Types::ResponseOutputItem>]
339
400
  #
340
401
  # @!attribute [rw] playback_mode
341
- # The type of playback mode for this channel. Possible values: ONCE or
342
- # LOOP.
402
+ # The type of playback mode for this channel.
403
+ #
404
+ # LINEAR - Programs play back-to-back only once.
405
+ #
406
+ # LOOP - Programs play back-to-back in an endless loop. When the last
407
+ # program in the schedule plays, playback loops back to the first
408
+ # program in the schedule.
343
409
  # @return [String]
344
410
  #
345
411
  # @!attribute [rw] tags
@@ -353,6 +419,7 @@ module Aws::MediaTailor
353
419
  :channel_name,
354
420
  :channel_state,
355
421
  :creation_time,
422
+ :filler_slate,
356
423
  :last_modified_time,
357
424
  :outputs,
358
425
  :playback_mode,
@@ -361,6 +428,66 @@ module Aws::MediaTailor
361
428
  include Aws::Structure
362
429
  end
363
430
 
431
+ # Configures Amazon CloudWatch log settings for an existing MediaTailor
432
+ # playback configuration.
433
+ #
434
+ # @note When making an API call, you may pass ConfigureLogsForPlaybackConfigurationRequest
435
+ # data as a hash:
436
+ #
437
+ # {
438
+ # percent_enabled: 1, # required
439
+ # playback_configuration_name: "__string", # required
440
+ # }
441
+ #
442
+ # @!attribute [rw] percent_enabled
443
+ # The percentage of session logs that MediaTailor sends to your
444
+ # Cloudwatch Logs account. For example, if your playback configuration
445
+ # has 1000 sessions and percentEnabled is set to 60, MediaTailor sends
446
+ # logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
447
+ # at random which of the playback configuration sessions to send logs
448
+ # for. If you want to view logs for a specific session, you can use
449
+ # the [debug log mode][1].
450
+ #
451
+ # Valid values: 0 - 100
452
+ #
453
+ #
454
+ #
455
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html
456
+ # @return [Integer]
457
+ #
458
+ # @!attribute [rw] playback_configuration_name
459
+ # The name of the playback configuration.
460
+ # @return [String]
461
+ #
462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfigurationRequest AWS API Documentation
463
+ #
464
+ class ConfigureLogsForPlaybackConfigurationRequest < Struct.new(
465
+ :percent_enabled,
466
+ :playback_configuration_name)
467
+ SENSITIVE = []
468
+ include Aws::Structure
469
+ end
470
+
471
+ # Amazon CloudWatch log settings for a playback configuration.
472
+ #
473
+ # @!attribute [rw] percent_enabled
474
+ # The percentage of session logs that MediaTailor sends to your
475
+ # Cloudwatch Logs account.
476
+ # @return [Integer]
477
+ #
478
+ # @!attribute [rw] playback_configuration_name
479
+ # The name of the playback configuration.
480
+ # @return [String]
481
+ #
482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfigurationResponse AWS API Documentation
483
+ #
484
+ class ConfigureLogsForPlaybackConfigurationResponse < Struct.new(
485
+ :percent_enabled,
486
+ :playback_configuration_name)
487
+ SENSITIVE = []
488
+ include Aws::Structure
489
+ end
490
+
364
491
  # The configuration for this channel.
365
492
  #
366
493
  # @note When making an API call, you may pass CreateChannelRequest
@@ -368,6 +495,10 @@ module Aws::MediaTailor
368
495
  #
369
496
  # {
370
497
  # channel_name: "__string", # required
498
+ # filler_slate: {
499
+ # source_location_name: "__string",
500
+ # vod_source_name: "__string",
501
+ # },
371
502
  # outputs: [ # required
372
503
  # {
373
504
  # dash_playlist_settings: {
@@ -383,7 +514,7 @@ module Aws::MediaTailor
383
514
  # source_group: "__string", # required
384
515
  # },
385
516
  # ],
386
- # playback_mode: "LOOP", # required, accepts LOOP
517
+ # playback_mode: "LOOP", # required, accepts LOOP, LINEAR
387
518
  # tags: {
388
519
  # "__string" => "__string",
389
520
  # },
@@ -392,13 +523,25 @@ module Aws::MediaTailor
392
523
  # @!attribute [rw] channel_name
393
524
  # @return [String]
394
525
  #
526
+ # @!attribute [rw] filler_slate
527
+ # The slate used to fill gaps between programs in the schedule. You
528
+ # must configure filler slate if your channel uses a LINEAR
529
+ # PlaybackMode.
530
+ # @return [Types::SlateSource]
531
+ #
395
532
  # @!attribute [rw] outputs
396
533
  # The channel's output properties.
397
534
  # @return [Array<Types::RequestOutputItem>]
398
535
  #
399
536
  # @!attribute [rw] playback_mode
400
- # The type of playback mode for this channel. The only supported value
401
- # is LOOP.
537
+ # The type of playback mode to use for this channel.
538
+ #
539
+ # LINEAR - The programs in the schedule play once back-to-back in the
540
+ # schedule.
541
+ #
542
+ # LOOP - The programs in the schedule play back-to-back in an endless
543
+ # loop. When the last program in the schedule stops playing, playback
544
+ # loops back to the first program in the schedule.
402
545
  # @return [String]
403
546
  #
404
547
  # @!attribute [rw] tags
@@ -409,6 +552,7 @@ module Aws::MediaTailor
409
552
  #
410
553
  class CreateChannelRequest < Struct.new(
411
554
  :channel_name,
555
+ :filler_slate,
412
556
  :outputs,
413
557
  :playback_mode,
414
558
  :tags)
@@ -428,6 +572,10 @@ module Aws::MediaTailor
428
572
  # @!attribute [rw] creation_time
429
573
  # @return [Time]
430
574
  #
575
+ # @!attribute [rw] filler_slate
576
+ # Slate VOD source configuration.
577
+ # @return [Types::SlateSource]
578
+ #
431
579
  # @!attribute [rw] last_modified_time
432
580
  # @return [Time]
433
581
  #
@@ -447,6 +595,7 @@ module Aws::MediaTailor
447
595
  :channel_name,
448
596
  :channel_state,
449
597
  :creation_time,
598
+ :filler_slate,
450
599
  :last_modified_time,
451
600
  :outputs,
452
601
  :playback_mode,
@@ -455,6 +604,112 @@ module Aws::MediaTailor
455
604
  include Aws::Structure
456
605
  end
457
606
 
607
+ # A complex type that contains configuration settings for retrieval,
608
+ # consumption, and an optional stream ID.
609
+ #
610
+ # @note When making an API call, you may pass CreatePrefetchScheduleRequest
611
+ # data as a hash:
612
+ #
613
+ # {
614
+ # consumption: { # required
615
+ # avail_matching_criteria: [
616
+ # {
617
+ # dynamic_variable: "__string", # required
618
+ # operator: "EQUALS", # required, accepts EQUALS
619
+ # },
620
+ # ],
621
+ # end_time: Time.now, # required
622
+ # start_time: Time.now,
623
+ # },
624
+ # name: "__string", # required
625
+ # playback_configuration_name: "__string", # required
626
+ # retrieval: { # required
627
+ # dynamic_variables: {
628
+ # "__string" => "__string",
629
+ # },
630
+ # end_time: Time.now, # required
631
+ # start_time: Time.now,
632
+ # },
633
+ # stream_id: "__string",
634
+ # }
635
+ #
636
+ # @!attribute [rw] consumption
637
+ # The configuration settings for MediaTailor's *consumption* of the
638
+ # prefetched ads from the ad decision server. Each consumption
639
+ # configuration contains an end time and an optional start time that
640
+ # define the *consumption window*. Prefetch schedules automatically
641
+ # expire no earlier than seven days after the end time.
642
+ # @return [Types::PrefetchConsumption]
643
+ #
644
+ # @!attribute [rw] name
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] playback_configuration_name
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] retrieval
651
+ # The configuration settings for retrieval of prefetched ads from the
652
+ # ad decision server. Only one set of prefetched ads will be retrieved
653
+ # and subsequently consumed for each ad break.
654
+ # @return [Types::PrefetchRetrieval]
655
+ #
656
+ # @!attribute [rw] stream_id
657
+ # An optional stream identifier that MediaTailor uses to prefetch ads
658
+ # for multiple streams that use the same playback configuration. If
659
+ # StreamId is specified, MediaTailor returns all of the prefetch
660
+ # schedules with an exact match on StreamId. If not specified,
661
+ # MediaTailor returns all of the prefetch schedules for the playback
662
+ # configuration, regardless of StreamId.
663
+ # @return [String]
664
+ #
665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleRequest AWS API Documentation
666
+ #
667
+ class CreatePrefetchScheduleRequest < Struct.new(
668
+ :consumption,
669
+ :name,
670
+ :playback_configuration_name,
671
+ :retrieval,
672
+ :stream_id)
673
+ SENSITIVE = []
674
+ include Aws::Structure
675
+ end
676
+
677
+ # @!attribute [rw] arn
678
+ # @return [String]
679
+ #
680
+ # @!attribute [rw] consumption
681
+ # A complex type that contains settings that determine how and when
682
+ # that MediaTailor places prefetched ads into upcoming ad breaks.
683
+ # @return [Types::PrefetchConsumption]
684
+ #
685
+ # @!attribute [rw] name
686
+ # @return [String]
687
+ #
688
+ # @!attribute [rw] playback_configuration_name
689
+ # @return [String]
690
+ #
691
+ # @!attribute [rw] retrieval
692
+ # A complex type that contains settings governing when MediaTailor
693
+ # prefetches ads, and which dynamic variables that MediaTailor
694
+ # includes in the request to the ad decision server.
695
+ # @return [Types::PrefetchRetrieval]
696
+ #
697
+ # @!attribute [rw] stream_id
698
+ # @return [String]
699
+ #
700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleResponse AWS API Documentation
701
+ #
702
+ class CreatePrefetchScheduleResponse < Struct.new(
703
+ :arn,
704
+ :consumption,
705
+ :name,
706
+ :playback_configuration_name,
707
+ :retrieval,
708
+ :stream_id)
709
+ SENSITIVE = []
710
+ include Aws::Structure
711
+ end
712
+
458
713
  # Program configuration parameters.
459
714
  #
460
715
  # @note When making an API call, you may pass CreateProgramRequest
@@ -483,6 +738,7 @@ module Aws::MediaTailor
483
738
  # transition: { # required
484
739
  # relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
485
740
  # relative_program: "__string",
741
+ # scheduled_start_time_millis: 1,
486
742
  # type: "__string", # required
487
743
  # },
488
744
  # },
@@ -540,6 +796,9 @@ module Aws::MediaTailor
540
796
  # @!attribute [rw] program_name
541
797
  # @return [String]
542
798
  #
799
+ # @!attribute [rw] scheduled_start_time
800
+ # @return [Time]
801
+ #
543
802
  # @!attribute [rw] source_location_name
544
803
  # @return [String]
545
804
  #
@@ -554,6 +813,7 @@ module Aws::MediaTailor
554
813
  :channel_name,
555
814
  :creation_time,
556
815
  :program_name,
816
+ :scheduled_start_time,
557
817
  :source_location_name,
558
818
  :vod_source_name)
559
819
  SENSITIVE = []
@@ -973,6 +1233,36 @@ module Aws::MediaTailor
973
1233
  #
974
1234
  class DeletePlaybackConfigurationResponse < Aws::EmptyStructure; end
975
1235
 
1236
+ # @note When making an API call, you may pass DeletePrefetchScheduleRequest
1237
+ # data as a hash:
1238
+ #
1239
+ # {
1240
+ # name: "__string", # required
1241
+ # playback_configuration_name: "__string", # required
1242
+ # }
1243
+ #
1244
+ # @!attribute [rw] name
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] playback_configuration_name
1248
+ # @return [String]
1249
+ #
1250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleRequest AWS API Documentation
1251
+ #
1252
+ class DeletePrefetchScheduleRequest < Struct.new(
1253
+ :name,
1254
+ :playback_configuration_name)
1255
+ SENSITIVE = []
1256
+ include Aws::Structure
1257
+ end
1258
+
1259
+ # If the action is successful, the service sends back an HTTP 204
1260
+ # response with an empty HTTP body.
1261
+ #
1262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleResponse AWS API Documentation
1263
+ #
1264
+ class DeletePrefetchScheduleResponse < Aws::EmptyStructure; end
1265
+
976
1266
  # @note When making an API call, you may pass DeleteProgramRequest
977
1267
  # data as a hash:
978
1268
  #
@@ -1091,6 +1381,11 @@ module Aws::MediaTailor
1091
1381
  # The timestamp of when the channel was created.
1092
1382
  # @return [Time]
1093
1383
  #
1384
+ # @!attribute [rw] filler_slate
1385
+ # Contains information about the slate used to fill gaps between
1386
+ # programs in the schedule.
1387
+ # @return [Types::SlateSource]
1388
+ #
1094
1389
  # @!attribute [rw] last_modified_time
1095
1390
  # The timestamp of when the channel was last modified.
1096
1391
  # @return [Time]
@@ -1100,8 +1395,7 @@ module Aws::MediaTailor
1100
1395
  # @return [Array<Types::ResponseOutputItem>]
1101
1396
  #
1102
1397
  # @!attribute [rw] playback_mode
1103
- # The type of playback for this channel. The only supported value is
1104
- # LOOP.
1398
+ # The channel's playback mode.
1105
1399
  # @return [String]
1106
1400
  #
1107
1401
  # @!attribute [rw] tags
@@ -1115,6 +1409,7 @@ module Aws::MediaTailor
1115
1409
  :channel_name,
1116
1410
  :channel_state,
1117
1411
  :creation_time,
1412
+ :filler_slate,
1118
1413
  :last_modified_time,
1119
1414
  :outputs,
1120
1415
  :playback_mode,
@@ -1168,6 +1463,13 @@ module Aws::MediaTailor
1168
1463
  # The name of the program.
1169
1464
  # @return [String]
1170
1465
  #
1466
+ # @!attribute [rw] scheduled_start_time
1467
+ # The date and time that the program is scheduled to start in ISO 8601
1468
+ # format and Coordinated Universal Time (UTC). For example, the value
1469
+ # 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751
1470
+ # UTC.
1471
+ # @return [Time]
1472
+ #
1171
1473
  # @!attribute [rw] source_location_name
1172
1474
  # The source location name.
1173
1475
  # @return [String]
@@ -1184,6 +1486,7 @@ module Aws::MediaTailor
1184
1486
  :channel_name,
1185
1487
  :creation_time,
1186
1488
  :program_name,
1489
+ :scheduled_start_time,
1187
1490
  :source_location_name,
1188
1491
  :vod_source_name)
1189
1492
  SENSITIVE = []
@@ -1486,6 +1789,10 @@ module Aws::MediaTailor
1486
1789
  # The configuration for pre-roll ad insertion.
1487
1790
  # @return [Types::LivePreRollConfiguration]
1488
1791
  #
1792
+ # @!attribute [rw] log_configuration
1793
+ # The Amazon CloudWatch log settings for a playback configuration.
1794
+ # @return [Types::LogConfiguration]
1795
+ #
1489
1796
  # @!attribute [rw] manifest_processing_rules
1490
1797
  # The configuration for manifest processing rules. Manifest processing
1491
1798
  # rules enable customization of the personalized manifests created by
@@ -1563,6 +1870,7 @@ module Aws::MediaTailor
1563
1870
  :dash_configuration,
1564
1871
  :hls_configuration,
1565
1872
  :live_pre_roll_configuration,
1873
+ :log_configuration,
1566
1874
  :manifest_processing_rules,
1567
1875
  :name,
1568
1876
  :personalization_threshold_seconds,
@@ -1577,6 +1885,65 @@ module Aws::MediaTailor
1577
1885
  include Aws::Structure
1578
1886
  end
1579
1887
 
1888
+ # @note When making an API call, you may pass GetPrefetchScheduleRequest
1889
+ # data as a hash:
1890
+ #
1891
+ # {
1892
+ # name: "__string", # required
1893
+ # playback_configuration_name: "__string", # required
1894
+ # }
1895
+ #
1896
+ # @!attribute [rw] name
1897
+ # @return [String]
1898
+ #
1899
+ # @!attribute [rw] playback_configuration_name
1900
+ # @return [String]
1901
+ #
1902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleRequest AWS API Documentation
1903
+ #
1904
+ class GetPrefetchScheduleRequest < Struct.new(
1905
+ :name,
1906
+ :playback_configuration_name)
1907
+ SENSITIVE = []
1908
+ include Aws::Structure
1909
+ end
1910
+
1911
+ # @!attribute [rw] arn
1912
+ # @return [String]
1913
+ #
1914
+ # @!attribute [rw] consumption
1915
+ # A complex type that contains settings that determine how and when
1916
+ # that MediaTailor places prefetched ads into upcoming ad breaks.
1917
+ # @return [Types::PrefetchConsumption]
1918
+ #
1919
+ # @!attribute [rw] name
1920
+ # @return [String]
1921
+ #
1922
+ # @!attribute [rw] playback_configuration_name
1923
+ # @return [String]
1924
+ #
1925
+ # @!attribute [rw] retrieval
1926
+ # A complex type that contains settings governing when MediaTailor
1927
+ # prefetches ads, and which dynamic variables that MediaTailor
1928
+ # includes in the request to the ad decision server.
1929
+ # @return [Types::PrefetchRetrieval]
1930
+ #
1931
+ # @!attribute [rw] stream_id
1932
+ # @return [String]
1933
+ #
1934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleResponse AWS API Documentation
1935
+ #
1936
+ class GetPrefetchScheduleResponse < Struct.new(
1937
+ :arn,
1938
+ :consumption,
1939
+ :name,
1940
+ :playback_configuration_name,
1941
+ :retrieval,
1942
+ :stream_id)
1943
+ SENSITIVE = []
1944
+ include Aws::Structure
1945
+ end
1946
+
1580
1947
  # The configuration for HLS content.
1581
1948
  #
1582
1949
  # @!attribute [rw] manifest_endpoint_prefix
@@ -1811,6 +2178,81 @@ module Aws::MediaTailor
1811
2178
  include Aws::Structure
1812
2179
  end
1813
2180
 
2181
+ # Retrieves the prefetch schedule(s) for a specific playback
2182
+ # configuration.
2183
+ #
2184
+ # @note When making an API call, you may pass ListPrefetchSchedulesRequest
2185
+ # data as a hash:
2186
+ #
2187
+ # {
2188
+ # max_results: 1,
2189
+ # next_token: "__string",
2190
+ # playback_configuration_name: "__string", # required
2191
+ # stream_id: "__string",
2192
+ # }
2193
+ #
2194
+ # @!attribute [rw] max_results
2195
+ # The maximum number of prefetch schedules that you want MediaTailor
2196
+ # to return in response to the current request. If the playback
2197
+ # configuration has more than MaxResults prefetch schedules, use the
2198
+ # value of NextToken in the response to get the next page of results.
2199
+ # @return [Integer]
2200
+ #
2201
+ # @!attribute [rw] next_token
2202
+ # (Optional) If the playback configuration has more than MaxResults
2203
+ # prefetch schedules, use NextToken to get the second and subsequent
2204
+ # pages of results.
2205
+ #
2206
+ # For the first ListPrefetchSchedulesRequest request, omit this value.
2207
+ #
2208
+ # For the second and subsequent requests, get the value of NextToken
2209
+ # from the previous response and specify that value for NextToken in
2210
+ # the request.
2211
+ #
2212
+ # If the previous response didn't include a NextToken element, there
2213
+ # are no more prefetch schedules to get.
2214
+ # @return [String]
2215
+ #
2216
+ # @!attribute [rw] playback_configuration_name
2217
+ # @return [String]
2218
+ #
2219
+ # @!attribute [rw] stream_id
2220
+ # An optional filtering parameter whereby MediaTailor filters the
2221
+ # prefetch schedules to include only specific streams.
2222
+ # @return [String]
2223
+ #
2224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPrefetchSchedulesRequest AWS API Documentation
2225
+ #
2226
+ class ListPrefetchSchedulesRequest < Struct.new(
2227
+ :max_results,
2228
+ :next_token,
2229
+ :playback_configuration_name,
2230
+ :stream_id)
2231
+ SENSITIVE = []
2232
+ include Aws::Structure
2233
+ end
2234
+
2235
+ # The list of prefetch schedules.
2236
+ #
2237
+ # @!attribute [rw] items
2238
+ # Lists the prefetch schedules. An empty Items list doesn't mean
2239
+ # there aren't more items to fetch, just that that page was empty.
2240
+ # @return [Array<Types::PrefetchSchedule>]
2241
+ #
2242
+ # @!attribute [rw] next_token
2243
+ # The value that you will use forNextToken in the next
2244
+ # ListPrefetchSchedulesRequest request.
2245
+ # @return [String]
2246
+ #
2247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPrefetchSchedulesResponse AWS API Documentation
2248
+ #
2249
+ class ListPrefetchSchedulesResponse < Struct.new(
2250
+ :items,
2251
+ :next_token)
2252
+ SENSITIVE = []
2253
+ include Aws::Structure
2254
+ end
2255
+
1814
2256
  # @note When making an API call, you may pass ListSourceLocationsRequest
1815
2257
  # data as a hash:
1816
2258
  #
@@ -1966,6 +2408,32 @@ module Aws::MediaTailor
1966
2408
  include Aws::Structure
1967
2409
  end
1968
2410
 
2411
+ # Returns Amazon CloudWatch log settings for a playback configuration.
2412
+ #
2413
+ # @!attribute [rw] percent_enabled
2414
+ # The percentage of session logs that MediaTailor sends to your
2415
+ # Cloudwatch Logs account. For example, if your playback configuration
2416
+ # has 1000 sessions and percentEnabled is set to 60, MediaTailor sends
2417
+ # logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
2418
+ # at random which of the playback configuration sessions to send logs
2419
+ # for. If you want to view logs for a specific session, you can use
2420
+ # the [debug log mode][1].
2421
+ #
2422
+ # Valid values: 0 - 100
2423
+ #
2424
+ #
2425
+ #
2426
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html
2427
+ # @return [Integer]
2428
+ #
2429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LogConfiguration AWS API Documentation
2430
+ #
2431
+ class LogConfiguration < Struct.new(
2432
+ :percent_enabled)
2433
+ SENSITIVE = []
2434
+ include Aws::Structure
2435
+ end
2436
+
1969
2437
  # The configuration for manifest processing rules. Manifest processing
1970
2438
  # rules enable customization of the personalized manifests created by
1971
2439
  # MediaTailor.
@@ -2061,6 +2529,10 @@ module Aws::MediaTailor
2061
2529
  # The configuration for pre-roll ad insertion.
2062
2530
  # @return [Types::LivePreRollConfiguration]
2063
2531
  #
2532
+ # @!attribute [rw] log_configuration
2533
+ # The Amazon CloudWatch log settings for a playback configuration.
2534
+ # @return [Types::LogConfiguration]
2535
+ #
2064
2536
  # @!attribute [rw] manifest_processing_rules
2065
2537
  # The configuration for manifest processing rules. Manifest processing
2066
2538
  # rules enable customization of the personalized manifests created by
@@ -2138,6 +2610,7 @@ module Aws::MediaTailor
2138
2610
  :dash_configuration,
2139
2611
  :hls_configuration,
2140
2612
  :live_pre_roll_configuration,
2613
+ :log_configuration,
2141
2614
  :manifest_processing_rules,
2142
2615
  :name,
2143
2616
  :personalization_threshold_seconds,
@@ -2152,6 +2625,154 @@ module Aws::MediaTailor
2152
2625
  include Aws::Structure
2153
2626
  end
2154
2627
 
2628
+ # A complex type that contains settings that determine how and when that
2629
+ # MediaTailor places prefetched ads into upcoming ad breaks.
2630
+ #
2631
+ # @note When making an API call, you may pass PrefetchConsumption
2632
+ # data as a hash:
2633
+ #
2634
+ # {
2635
+ # avail_matching_criteria: [
2636
+ # {
2637
+ # dynamic_variable: "__string", # required
2638
+ # operator: "EQUALS", # required, accepts EQUALS
2639
+ # },
2640
+ # ],
2641
+ # end_time: Time.now, # required
2642
+ # start_time: Time.now,
2643
+ # }
2644
+ #
2645
+ # @!attribute [rw] avail_matching_criteria
2646
+ # If you only want MediaTailor to insert prefetched ads into avails
2647
+ # (ad breaks) that match specific dynamic variables, such as
2648
+ # scte.event\_id, set the avail matching criteria.
2649
+ # @return [Array<Types::AvailMatchingCriteria>]
2650
+ #
2651
+ # @!attribute [rw] end_time
2652
+ # The time when MediaTailor no longer considers the prefetched ads for
2653
+ # use in an ad break. MediaTailor automatically deletes prefetch
2654
+ # schedules no less than seven days after the end time. If you'd like
2655
+ # to manually delete the prefetch schedule, you can call
2656
+ # DeletePrefetchSchedule.
2657
+ # @return [Time]
2658
+ #
2659
+ # @!attribute [rw] start_time
2660
+ # The time when prefetched ads are considered for use in an ad break.
2661
+ # If you don't specify StartTime, the prefetched ads are available
2662
+ # after MediaTailor retrives them from the ad decision server.
2663
+ # @return [Time]
2664
+ #
2665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PrefetchConsumption AWS API Documentation
2666
+ #
2667
+ class PrefetchConsumption < Struct.new(
2668
+ :avail_matching_criteria,
2669
+ :end_time,
2670
+ :start_time)
2671
+ SENSITIVE = []
2672
+ include Aws::Structure
2673
+ end
2674
+
2675
+ # A complex type that contains settings governing when MediaTailor
2676
+ # prefetches ads, and which dynamic variables that MediaTailor includes
2677
+ # in the request to the ad decision server.
2678
+ #
2679
+ # @note When making an API call, you may pass PrefetchRetrieval
2680
+ # data as a hash:
2681
+ #
2682
+ # {
2683
+ # dynamic_variables: {
2684
+ # "__string" => "__string",
2685
+ # },
2686
+ # end_time: Time.now, # required
2687
+ # start_time: Time.now,
2688
+ # }
2689
+ #
2690
+ # @!attribute [rw] dynamic_variables
2691
+ # The dynamic variables to use for substitution during prefetch
2692
+ # requests to the ad decision server (ADS).
2693
+ #
2694
+ # You intially configure [dynamic variables][1] for the ADS URL when
2695
+ # you set up your playback configuration. When you specify
2696
+ # DynamicVariables for prefetch retrieval, MediaTailor includes the
2697
+ # dynamic variables in the request to the ADS.
2698
+ #
2699
+ #
2700
+ #
2701
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html
2702
+ # @return [Hash<String,String>]
2703
+ #
2704
+ # @!attribute [rw] end_time
2705
+ # The time when prefetch retrieval ends for the ad break. Prefetching
2706
+ # will be attempted for manifest requests that occur at or before this
2707
+ # time.
2708
+ # @return [Time]
2709
+ #
2710
+ # @!attribute [rw] start_time
2711
+ # The time when prefetch retrievals can start for this break. Ad
2712
+ # prefetching will be attempted for manifest requests that occur at or
2713
+ # after this time. Defaults to the current time. If not specified, the
2714
+ # prefetch retrieval starts as soon as possible.
2715
+ # @return [Time]
2716
+ #
2717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PrefetchRetrieval AWS API Documentation
2718
+ #
2719
+ class PrefetchRetrieval < Struct.new(
2720
+ :dynamic_variables,
2721
+ :end_time,
2722
+ :start_time)
2723
+ SENSITIVE = []
2724
+ include Aws::Structure
2725
+ end
2726
+
2727
+ # A complex type that contains prefetch schedule information.
2728
+ #
2729
+ # @!attribute [rw] arn
2730
+ # The Amazon Resource Name (ARN) of the prefetch schedule.
2731
+ # @return [String]
2732
+ #
2733
+ # @!attribute [rw] consumption
2734
+ # Consumption settings determine how, and when, MediaTailor places the
2735
+ # prefetched ads into ad breaks. Ad consumption occurs within a span
2736
+ # of time that you define, called a *consumption window*. You can
2737
+ # designate which ad breaks that MediaTailor fills with prefetch ads
2738
+ # by setting avail matching criteria.
2739
+ # @return [Types::PrefetchConsumption]
2740
+ #
2741
+ # @!attribute [rw] name
2742
+ # The name of the prefetch schedule. The name must be unique among all
2743
+ # prefetch schedules that are associated with the specified playback
2744
+ # configuration.
2745
+ # @return [String]
2746
+ #
2747
+ # @!attribute [rw] playback_configuration_name
2748
+ # The name of the playback configuration to create the prefetch
2749
+ # schedule for.
2750
+ # @return [String]
2751
+ #
2752
+ # @!attribute [rw] retrieval
2753
+ # A complex type that contains settings for prefetch retrieval from
2754
+ # the ad decision server (ADS).
2755
+ # @return [Types::PrefetchRetrieval]
2756
+ #
2757
+ # @!attribute [rw] stream_id
2758
+ # An optional stream identifier that you can specify in order to
2759
+ # prefetch for multiple streams that use the same playback
2760
+ # configuration.
2761
+ # @return [String]
2762
+ #
2763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PrefetchSchedule AWS API Documentation
2764
+ #
2765
+ class PrefetchSchedule < Struct.new(
2766
+ :arn,
2767
+ :consumption,
2768
+ :name,
2769
+ :playback_configuration_name,
2770
+ :retrieval,
2771
+ :stream_id)
2772
+ SENSITIVE = []
2773
+ include Aws::Structure
2774
+ end
2775
+
2155
2776
  # Adds an IAM policy for the channel.
2156
2777
  #
2157
2778
  # @note When making an API call, you may pass PutChannelPolicyRequest
@@ -2400,6 +3021,10 @@ module Aws::MediaTailor
2400
3021
  # The configuration for pre-roll ad insertion.
2401
3022
  # @return [Types::LivePreRollConfiguration]
2402
3023
  #
3024
+ # @!attribute [rw] log_configuration
3025
+ # Returns Amazon CloudWatch log settings for a playback configuration.
3026
+ # @return [Types::LogConfiguration]
3027
+ #
2403
3028
  # @!attribute [rw] manifest_processing_rules
2404
3029
  # The configuration for manifest processing rules. Manifest processing
2405
3030
  # rules enable customization of the personalized manifests created by
@@ -2444,6 +3069,7 @@ module Aws::MediaTailor
2444
3069
  :dash_configuration,
2445
3070
  :hls_configuration,
2446
3071
  :live_pre_roll_configuration,
3072
+ :log_configuration,
2447
3073
  :manifest_processing_rules,
2448
3074
  :name,
2449
3075
  :personalization_threshold_seconds,
@@ -2458,7 +3084,7 @@ module Aws::MediaTailor
2458
3084
  include Aws::Structure
2459
3085
  end
2460
3086
 
2461
- # The ouput configuration for this channel.
3087
+ # The output configuration for this channel.
2462
3088
  #
2463
3089
  # @note When making an API call, you may pass RequestOutputItem
2464
3090
  # data as a hash:
@@ -2582,6 +3208,7 @@ module Aws::MediaTailor
2582
3208
  # transition: { # required
2583
3209
  # relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
2584
3210
  # relative_program: "__string",
3211
+ # scheduled_start_time_millis: 1,
2585
3212
  # type: "__string", # required
2586
3213
  # },
2587
3214
  # }
@@ -2624,6 +3251,12 @@ module Aws::MediaTailor
2624
3251
  # The schedule's ad break properties.
2625
3252
  # @return [Array<Types::ScheduleAdBreak>]
2626
3253
  #
3254
+ # @!attribute [rw] schedule_entry_type
3255
+ # The type of schedule entry.
3256
+ #
3257
+ # Valid values: PROGRAM or FILLER\_SLATE.
3258
+ # @return [String]
3259
+ #
2627
3260
  # @!attribute [rw] source_location_name
2628
3261
  # The name of the source location.
2629
3262
  # @return [String]
@@ -2641,6 +3274,7 @@ module Aws::MediaTailor
2641
3274
  :channel_name,
2642
3275
  :program_name,
2643
3276
  :schedule_ad_breaks,
3277
+ :schedule_entry_type,
2644
3278
  :source_location_name,
2645
3279
  :vod_source_name)
2646
3280
  SENSITIVE = []
@@ -2897,13 +3531,13 @@ module Aws::MediaTailor
2897
3531
  # {
2898
3532
  # relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
2899
3533
  # relative_program: "__string",
3534
+ # scheduled_start_time_millis: 1,
2900
3535
  # type: "__string", # required
2901
3536
  # }
2902
3537
  #
2903
3538
  # @!attribute [rw] relative_position
2904
3539
  # The position where this program will be inserted relative to the
2905
- # RelativeProgram. Possible values are: AFTER\_PROGRAM, and
2906
- # BEFORE\_PROGRAM.
3540
+ # RelativePosition.
2907
3541
  # @return [String]
2908
3542
  #
2909
3543
  # @!attribute [rw] relative_program
@@ -2911,9 +3545,29 @@ module Aws::MediaTailor
2911
3545
  # as defined by RelativePosition.
2912
3546
  # @return [String]
2913
3547
  #
3548
+ # @!attribute [rw] scheduled_start_time_millis
3549
+ # The date and time that the program is scheduled to start, in epoch
3550
+ # milliseconds.
3551
+ # @return [Integer]
3552
+ #
2914
3553
  # @!attribute [rw] type
2915
- # When the program should be played. RELATIVE means that programs will
2916
- # be played back-to-back.
3554
+ # Defines when the program plays in the schedule. You can set the
3555
+ # value to ABSOLUTE or RELATIVE.
3556
+ #
3557
+ # ABSOLUTE - The program plays at a specific wall clock time. This
3558
+ # setting can only be used for channels using the LINEAR PlaybackMode.
3559
+ #
3560
+ # Note the following considerations when using ABSOLUTE transitions:
3561
+ #
3562
+ # If the preceding program in the schedule has a duration that extends
3563
+ # past the wall clock time, MediaTailor truncates the preceding
3564
+ # program on a common segment boundary.
3565
+ #
3566
+ # If there are gaps in playback, MediaTailor plays the FillerSlate you
3567
+ # configured for your linear channel.
3568
+ #
3569
+ # RELATIVE - The program is inserted into the schedule either before
3570
+ # or after a program that you specify via RelativePosition.
2917
3571
  # @return [String]
2918
3572
  #
2919
3573
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Transition AWS API Documentation
@@ -2921,6 +3575,7 @@ module Aws::MediaTailor
2921
3575
  class Transition < Struct.new(
2922
3576
  :relative_position,
2923
3577
  :relative_program,
3578
+ :scheduled_start_time_millis,
2924
3579
  :type)
2925
3580
  SENSITIVE = []
2926
3581
  include Aws::Structure
@@ -3001,6 +3656,10 @@ module Aws::MediaTailor
3001
3656
  # @!attribute [rw] creation_time
3002
3657
  # @return [Time]
3003
3658
  #
3659
+ # @!attribute [rw] filler_slate
3660
+ # Slate VOD source configuration.
3661
+ # @return [Types::SlateSource]
3662
+ #
3004
3663
  # @!attribute [rw] last_modified_time
3005
3664
  # @return [Time]
3006
3665
  #
@@ -3020,6 +3679,7 @@ module Aws::MediaTailor
3020
3679
  :channel_name,
3021
3680
  :channel_state,
3022
3681
  :creation_time,
3682
+ :filler_slate,
3023
3683
  :last_modified_time,
3024
3684
  :outputs,
3025
3685
  :playback_mode,