aws-sdk-mediatailor 1.44.0 → 1.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mediatailor/client.rb +295 -2
- data/lib/aws-sdk-mediatailor/client_api.rb +148 -0
- data/lib/aws-sdk-mediatailor/types.rb +576 -2
- data/lib/aws-sdk-mediatailor.rb +2 -2
- metadata +4 -4
@@ -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
|
#
|
@@ -373,6 +428,66 @@ module Aws::MediaTailor
|
|
373
428
|
include Aws::Structure
|
374
429
|
end
|
375
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
|
+
|
376
491
|
# The configuration for this channel.
|
377
492
|
#
|
378
493
|
# @note When making an API call, you may pass CreateChannelRequest
|
@@ -410,7 +525,7 @@ module Aws::MediaTailor
|
|
410
525
|
#
|
411
526
|
# @!attribute [rw] filler_slate
|
412
527
|
# The slate used to fill gaps between programs in the schedule. You
|
413
|
-
# must configure filler slate if your channel uses
|
528
|
+
# must configure filler slate if your channel uses a LINEAR
|
414
529
|
# PlaybackMode.
|
415
530
|
# @return [Types::SlateSource]
|
416
531
|
#
|
@@ -489,6 +604,112 @@ module Aws::MediaTailor
|
|
489
604
|
include Aws::Structure
|
490
605
|
end
|
491
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
|
+
|
492
713
|
# Program configuration parameters.
|
493
714
|
#
|
494
715
|
# @note When making an API call, you may pass CreateProgramRequest
|
@@ -1012,6 +1233,36 @@ module Aws::MediaTailor
|
|
1012
1233
|
#
|
1013
1234
|
class DeletePlaybackConfigurationResponse < Aws::EmptyStructure; end
|
1014
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
|
+
|
1015
1266
|
# @note When making an API call, you may pass DeleteProgramRequest
|
1016
1267
|
# data as a hash:
|
1017
1268
|
#
|
@@ -1538,6 +1789,10 @@ module Aws::MediaTailor
|
|
1538
1789
|
# The configuration for pre-roll ad insertion.
|
1539
1790
|
# @return [Types::LivePreRollConfiguration]
|
1540
1791
|
#
|
1792
|
+
# @!attribute [rw] log_configuration
|
1793
|
+
# The Amazon CloudWatch log settings for a playback configuration.
|
1794
|
+
# @return [Types::LogConfiguration]
|
1795
|
+
#
|
1541
1796
|
# @!attribute [rw] manifest_processing_rules
|
1542
1797
|
# The configuration for manifest processing rules. Manifest processing
|
1543
1798
|
# rules enable customization of the personalized manifests created by
|
@@ -1615,6 +1870,7 @@ module Aws::MediaTailor
|
|
1615
1870
|
:dash_configuration,
|
1616
1871
|
:hls_configuration,
|
1617
1872
|
:live_pre_roll_configuration,
|
1873
|
+
:log_configuration,
|
1618
1874
|
:manifest_processing_rules,
|
1619
1875
|
:name,
|
1620
1876
|
:personalization_threshold_seconds,
|
@@ -1629,6 +1885,65 @@ module Aws::MediaTailor
|
|
1629
1885
|
include Aws::Structure
|
1630
1886
|
end
|
1631
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
|
+
|
1632
1947
|
# The configuration for HLS content.
|
1633
1948
|
#
|
1634
1949
|
# @!attribute [rw] manifest_endpoint_prefix
|
@@ -1863,6 +2178,81 @@ module Aws::MediaTailor
|
|
1863
2178
|
include Aws::Structure
|
1864
2179
|
end
|
1865
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
|
+
|
1866
2256
|
# @note When making an API call, you may pass ListSourceLocationsRequest
|
1867
2257
|
# data as a hash:
|
1868
2258
|
#
|
@@ -2018,6 +2408,32 @@ module Aws::MediaTailor
|
|
2018
2408
|
include Aws::Structure
|
2019
2409
|
end
|
2020
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
|
+
|
2021
2437
|
# The configuration for manifest processing rules. Manifest processing
|
2022
2438
|
# rules enable customization of the personalized manifests created by
|
2023
2439
|
# MediaTailor.
|
@@ -2113,6 +2529,10 @@ module Aws::MediaTailor
|
|
2113
2529
|
# The configuration for pre-roll ad insertion.
|
2114
2530
|
# @return [Types::LivePreRollConfiguration]
|
2115
2531
|
#
|
2532
|
+
# @!attribute [rw] log_configuration
|
2533
|
+
# The Amazon CloudWatch log settings for a playback configuration.
|
2534
|
+
# @return [Types::LogConfiguration]
|
2535
|
+
#
|
2116
2536
|
# @!attribute [rw] manifest_processing_rules
|
2117
2537
|
# The configuration for manifest processing rules. Manifest processing
|
2118
2538
|
# rules enable customization of the personalized manifests created by
|
@@ -2190,6 +2610,7 @@ module Aws::MediaTailor
|
|
2190
2610
|
:dash_configuration,
|
2191
2611
|
:hls_configuration,
|
2192
2612
|
:live_pre_roll_configuration,
|
2613
|
+
:log_configuration,
|
2193
2614
|
:manifest_processing_rules,
|
2194
2615
|
:name,
|
2195
2616
|
:personalization_threshold_seconds,
|
@@ -2204,6 +2625,154 @@ module Aws::MediaTailor
|
|
2204
2625
|
include Aws::Structure
|
2205
2626
|
end
|
2206
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
|
+
|
2207
2776
|
# Adds an IAM policy for the channel.
|
2208
2777
|
#
|
2209
2778
|
# @note When making an API call, you may pass PutChannelPolicyRequest
|
@@ -2452,6 +3021,10 @@ module Aws::MediaTailor
|
|
2452
3021
|
# The configuration for pre-roll ad insertion.
|
2453
3022
|
# @return [Types::LivePreRollConfiguration]
|
2454
3023
|
#
|
3024
|
+
# @!attribute [rw] log_configuration
|
3025
|
+
# Returns Amazon CloudWatch log settings for a playback configuration.
|
3026
|
+
# @return [Types::LogConfiguration]
|
3027
|
+
#
|
2455
3028
|
# @!attribute [rw] manifest_processing_rules
|
2456
3029
|
# The configuration for manifest processing rules. Manifest processing
|
2457
3030
|
# rules enable customization of the personalized manifests created by
|
@@ -2496,6 +3069,7 @@ module Aws::MediaTailor
|
|
2496
3069
|
:dash_configuration,
|
2497
3070
|
:hls_configuration,
|
2498
3071
|
:live_pre_roll_configuration,
|
3072
|
+
:log_configuration,
|
2499
3073
|
:manifest_processing_rules,
|
2500
3074
|
:name,
|
2501
3075
|
:personalization_threshold_seconds,
|
@@ -2510,7 +3084,7 @@ module Aws::MediaTailor
|
|
2510
3084
|
include Aws::Structure
|
2511
3085
|
end
|
2512
3086
|
|
2513
|
-
# The
|
3087
|
+
# The output configuration for this channel.
|
2514
3088
|
#
|
2515
3089
|
# @note When making an API call, you may pass RequestOutputItem
|
2516
3090
|
# data as a hash:
|
data/lib/aws-sdk-mediatailor.rb
CHANGED
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-mediatailor/customizations'
|
|
28
28
|
# structure.
|
29
29
|
#
|
30
30
|
# media_tailor = Aws::MediaTailor::Client.new
|
31
|
-
# resp = media_tailor.
|
31
|
+
# resp = media_tailor.configure_logs_for_playback_configuration(params)
|
32
32
|
#
|
33
33
|
# See {Client} for more information.
|
34
34
|
#
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-mediatailor/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::MediaTailor
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.48.0'
|
52
52
|
|
53
53
|
end
|