aws-sdk-mediatailor 1.97.0 → 1.98.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mediatailor/client.rb +110 -10
- data/lib/aws-sdk-mediatailor/client_api.rb +41 -4
- data/lib/aws-sdk-mediatailor/types.rb +228 -22
- data/lib/aws-sdk-mediatailor.rb +1 -1
- data/sig/client.rbs +34 -3
- data/sig/types.rbs +38 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 63adfebe9c93a4c14bff12ac6305689137ac5e5bec6937da066a452388dc3255
|
4
|
+
data.tar.gz: 8eddbd66a8bc681a02eb884e7d51121774df8c0b675134e69c03ce943601d41b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0489976663c1e8d3f40ea5703fb52ac7f98d8378d22e694ad5830cf5062a0370e54423f0a5e723eddffbdbe871cf85e99a3f7f09981a27172dc4971165386b3e'
|
7
|
+
data.tar.gz: b5ba363aced21cdf1498dd2b3f01f74e30bdd727eaed197ce6920686653943b0c61dc239c3b286a13f239d14261063b46c99891a73ef1a4300e312d4f1e9f27c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.98.0 (2025-04-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added support for Recurring Prefetch and Traffic Shaping on both Single and Recurring Prefetch. ListPrefetchSchedules now return single prefetchs by default and can be provided scheduleType of SINGLE, RECURRING, AND ALL.
|
8
|
+
|
4
9
|
1.97.0 (2025-03-26)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.98.0
|
@@ -812,12 +812,13 @@ module Aws::MediaTailor
|
|
812
812
|
#
|
813
813
|
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
814
814
|
#
|
815
|
-
# @option params [
|
816
|
-
# The configuration settings for
|
817
|
-
# prefetched ads from the ad decision server
|
818
|
-
# configuration contains an end time and an
|
819
|
-
# define the *consumption window*. Prefetch
|
820
|
-
# expire no earlier than seven days after the
|
815
|
+
# @option params [Types::PrefetchConsumption] :consumption
|
816
|
+
# The configuration settings for how and when MediaTailor consumes
|
817
|
+
# prefetched ads from the ad decision server for single prefetch
|
818
|
+
# schedules. Each consumption configuration contains an end time and an
|
819
|
+
# optional start time that define the *consumption window*. Prefetch
|
820
|
+
# schedules automatically expire no earlier than seven days after the
|
821
|
+
# end time.
|
821
822
|
#
|
822
823
|
# @option params [required, String] :name
|
823
824
|
# The name to assign to the schedule request.
|
@@ -825,11 +826,28 @@ module Aws::MediaTailor
|
|
825
826
|
# @option params [required, String] :playback_configuration_name
|
826
827
|
# The name to assign to the playback configuration.
|
827
828
|
#
|
828
|
-
# @option params [
|
829
|
+
# @option params [Types::PrefetchRetrieval] :retrieval
|
829
830
|
# The configuration settings for retrieval of prefetched ads from the ad
|
830
831
|
# decision server. Only one set of prefetched ads will be retrieved and
|
831
832
|
# subsequently consumed for each ad break.
|
832
833
|
#
|
834
|
+
# @option params [Types::RecurringPrefetchConfiguration] :recurring_prefetch_configuration
|
835
|
+
# The configuration that defines how and when MediaTailor performs ad
|
836
|
+
# prefetching in a live event.
|
837
|
+
#
|
838
|
+
# @option params [String] :schedule_type
|
839
|
+
# The frequency that MediaTailor creates prefetch schedules. `SINGLE`
|
840
|
+
# indicates that this schedule applies to one ad break. `RECURRING`
|
841
|
+
# indicates that MediaTailor automatically creates a schedule for each
|
842
|
+
# ad avail in a live event.
|
843
|
+
#
|
844
|
+
# For more information about the prefetch types and when you might use
|
845
|
+
# each, see [Prefetching ads in Elemental MediaTailor.][1]
|
846
|
+
#
|
847
|
+
#
|
848
|
+
#
|
849
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
850
|
+
#
|
833
851
|
# @option params [String] :stream_id
|
834
852
|
# An optional stream identifier that MediaTailor uses to prefetch ads
|
835
853
|
# for multiple streams that use the same playback configuration. If
|
@@ -845,12 +863,14 @@ module Aws::MediaTailor
|
|
845
863
|
# * {Types::CreatePrefetchScheduleResponse#name #name} => String
|
846
864
|
# * {Types::CreatePrefetchScheduleResponse#playback_configuration_name #playback_configuration_name} => String
|
847
865
|
# * {Types::CreatePrefetchScheduleResponse#retrieval #retrieval} => Types::PrefetchRetrieval
|
866
|
+
# * {Types::CreatePrefetchScheduleResponse#recurring_prefetch_configuration #recurring_prefetch_configuration} => Types::RecurringPrefetchConfiguration
|
867
|
+
# * {Types::CreatePrefetchScheduleResponse#schedule_type #schedule_type} => String
|
848
868
|
# * {Types::CreatePrefetchScheduleResponse#stream_id #stream_id} => String
|
849
869
|
#
|
850
870
|
# @example Request syntax with placeholder values
|
851
871
|
#
|
852
872
|
# resp = client.create_prefetch_schedule({
|
853
|
-
# consumption: {
|
873
|
+
# consumption: {
|
854
874
|
# avail_matching_criteria: [
|
855
875
|
# {
|
856
876
|
# dynamic_variable: "__string", # required
|
@@ -862,13 +882,41 @@ module Aws::MediaTailor
|
|
862
882
|
# },
|
863
883
|
# name: "__string", # required
|
864
884
|
# playback_configuration_name: "__string", # required
|
865
|
-
# retrieval: {
|
885
|
+
# retrieval: {
|
866
886
|
# dynamic_variables: {
|
867
887
|
# "__string" => "__string",
|
868
888
|
# },
|
869
889
|
# end_time: Time.now, # required
|
870
890
|
# start_time: Time.now,
|
891
|
+
# traffic_shaping_type: "RETRIEVAL_WINDOW", # accepts RETRIEVAL_WINDOW
|
892
|
+
# traffic_shaping_retrieval_window: {
|
893
|
+
# retrieval_window_duration_seconds: 1,
|
894
|
+
# },
|
895
|
+
# },
|
896
|
+
# recurring_prefetch_configuration: {
|
897
|
+
# start_time: Time.now,
|
898
|
+
# end_time: Time.now, # required
|
899
|
+
# recurring_consumption: { # required
|
900
|
+
# retrieved_ad_expiration_seconds: 1,
|
901
|
+
# avail_matching_criteria: [
|
902
|
+
# {
|
903
|
+
# dynamic_variable: "__string", # required
|
904
|
+
# operator: "EQUALS", # required, accepts EQUALS
|
905
|
+
# },
|
906
|
+
# ],
|
907
|
+
# },
|
908
|
+
# recurring_retrieval: { # required
|
909
|
+
# dynamic_variables: {
|
910
|
+
# "__string" => "__string",
|
911
|
+
# },
|
912
|
+
# delay_after_avail_end_seconds: 1,
|
913
|
+
# traffic_shaping_type: "RETRIEVAL_WINDOW", # accepts RETRIEVAL_WINDOW
|
914
|
+
# traffic_shaping_retrieval_window: {
|
915
|
+
# retrieval_window_duration_seconds: 1,
|
916
|
+
# },
|
917
|
+
# },
|
871
918
|
# },
|
919
|
+
# schedule_type: "SINGLE", # accepts SINGLE, RECURRING
|
872
920
|
# stream_id: "__string",
|
873
921
|
# })
|
874
922
|
#
|
@@ -886,6 +934,20 @@ module Aws::MediaTailor
|
|
886
934
|
# resp.retrieval.dynamic_variables["__string"] #=> String
|
887
935
|
# resp.retrieval.end_time #=> Time
|
888
936
|
# resp.retrieval.start_time #=> Time
|
937
|
+
# resp.retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW"
|
938
|
+
# resp.retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
|
939
|
+
# resp.recurring_prefetch_configuration.start_time #=> Time
|
940
|
+
# resp.recurring_prefetch_configuration.end_time #=> Time
|
941
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.retrieved_ad_expiration_seconds #=> Integer
|
942
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria #=> Array
|
943
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].dynamic_variable #=> String
|
944
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
|
945
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables #=> Hash
|
946
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables["__string"] #=> String
|
947
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.delay_after_avail_end_seconds #=> Integer
|
948
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW"
|
949
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
|
950
|
+
# resp.schedule_type #=> String, one of "SINGLE", "RECURRING"
|
889
951
|
# resp.stream_id #=> String
|
890
952
|
#
|
891
953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchSchedule AWS API Documentation
|
@@ -2092,6 +2154,8 @@ module Aws::MediaTailor
|
|
2092
2154
|
# * {Types::GetPrefetchScheduleResponse#name #name} => String
|
2093
2155
|
# * {Types::GetPrefetchScheduleResponse#playback_configuration_name #playback_configuration_name} => String
|
2094
2156
|
# * {Types::GetPrefetchScheduleResponse#retrieval #retrieval} => Types::PrefetchRetrieval
|
2157
|
+
# * {Types::GetPrefetchScheduleResponse#schedule_type #schedule_type} => String
|
2158
|
+
# * {Types::GetPrefetchScheduleResponse#recurring_prefetch_configuration #recurring_prefetch_configuration} => Types::RecurringPrefetchConfiguration
|
2095
2159
|
# * {Types::GetPrefetchScheduleResponse#stream_id #stream_id} => String
|
2096
2160
|
#
|
2097
2161
|
# @example Request syntax with placeholder values
|
@@ -2115,6 +2179,20 @@ module Aws::MediaTailor
|
|
2115
2179
|
# resp.retrieval.dynamic_variables["__string"] #=> String
|
2116
2180
|
# resp.retrieval.end_time #=> Time
|
2117
2181
|
# resp.retrieval.start_time #=> Time
|
2182
|
+
# resp.retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW"
|
2183
|
+
# resp.retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
|
2184
|
+
# resp.schedule_type #=> String, one of "SINGLE", "RECURRING"
|
2185
|
+
# resp.recurring_prefetch_configuration.start_time #=> Time
|
2186
|
+
# resp.recurring_prefetch_configuration.end_time #=> Time
|
2187
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.retrieved_ad_expiration_seconds #=> Integer
|
2188
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria #=> Array
|
2189
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].dynamic_variable #=> String
|
2190
|
+
# resp.recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
|
2191
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables #=> Hash
|
2192
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.dynamic_variables["__string"] #=> String
|
2193
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.delay_after_avail_end_seconds #=> Integer
|
2194
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW"
|
2195
|
+
# resp.recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
|
2118
2196
|
# resp.stream_id #=> String
|
2119
2197
|
#
|
2120
2198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchSchedule AWS API Documentation
|
@@ -2413,6 +2491,13 @@ module Aws::MediaTailor
|
|
2413
2491
|
# Retrieves the prefetch schedule(s) for a specific playback
|
2414
2492
|
# configuration.
|
2415
2493
|
#
|
2494
|
+
# @option params [String] :schedule_type
|
2495
|
+
# The type of prefetch schedules that you want to list. `SINGLE`
|
2496
|
+
# indicates that you want to list the configured single prefetch
|
2497
|
+
# schedules. `RECURRING` indicates that you want to list the configured
|
2498
|
+
# recurring prefetch schedules. `ALL` indicates that you want to list
|
2499
|
+
# all configured prefetch schedules.
|
2500
|
+
#
|
2416
2501
|
# @option params [String] :stream_id
|
2417
2502
|
# An optional filtering parameter whereby MediaTailor filters the
|
2418
2503
|
# prefetch schedules to include only specific streams.
|
@@ -2430,6 +2515,7 @@ module Aws::MediaTailor
|
|
2430
2515
|
# max_results: 1,
|
2431
2516
|
# next_token: "__string",
|
2432
2517
|
# playback_configuration_name: "__string", # required
|
2518
|
+
# schedule_type: "SINGLE", # accepts SINGLE, RECURRING, ALL
|
2433
2519
|
# stream_id: "__string",
|
2434
2520
|
# })
|
2435
2521
|
#
|
@@ -2448,6 +2534,20 @@ module Aws::MediaTailor
|
|
2448
2534
|
# resp.items[0].retrieval.dynamic_variables["__string"] #=> String
|
2449
2535
|
# resp.items[0].retrieval.end_time #=> Time
|
2450
2536
|
# resp.items[0].retrieval.start_time #=> Time
|
2537
|
+
# resp.items[0].retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW"
|
2538
|
+
# resp.items[0].retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
|
2539
|
+
# resp.items[0].schedule_type #=> String, one of "SINGLE", "RECURRING"
|
2540
|
+
# resp.items[0].recurring_prefetch_configuration.start_time #=> Time
|
2541
|
+
# resp.items[0].recurring_prefetch_configuration.end_time #=> Time
|
2542
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_consumption.retrieved_ad_expiration_seconds #=> Integer
|
2543
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria #=> Array
|
2544
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].dynamic_variable #=> String
|
2545
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
|
2546
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_retrieval.dynamic_variables #=> Hash
|
2547
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_retrieval.dynamic_variables["__string"] #=> String
|
2548
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_retrieval.delay_after_avail_end_seconds #=> Integer
|
2549
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_type #=> String, one of "RETRIEVAL_WINDOW"
|
2550
|
+
# resp.items[0].recurring_prefetch_configuration.recurring_retrieval.traffic_shaping_retrieval_window.retrieval_window_duration_seconds #=> Integer
|
2451
2551
|
# resp.items[0].stream_id #=> String
|
2452
2552
|
# resp.next_token #=> String
|
2453
2553
|
#
|
@@ -3545,7 +3645,7 @@ module Aws::MediaTailor
|
|
3545
3645
|
tracer: tracer
|
3546
3646
|
)
|
3547
3647
|
context[:gem_name] = 'aws-sdk-mediatailor'
|
3548
|
-
context[:gem_version] = '1.
|
3648
|
+
context[:gem_version] = '1.98.0'
|
3549
3649
|
Seahorse::Client::Request.new(handlers, context)
|
3550
3650
|
end
|
3551
3651
|
|
@@ -112,6 +112,7 @@ module Aws::MediaTailor
|
|
112
112
|
ListLiveSourcesResponse = Shapes::StructureShape.new(name: 'ListLiveSourcesResponse')
|
113
113
|
ListPlaybackConfigurationsRequest = Shapes::StructureShape.new(name: 'ListPlaybackConfigurationsRequest')
|
114
114
|
ListPlaybackConfigurationsResponse = Shapes::StructureShape.new(name: 'ListPlaybackConfigurationsResponse')
|
115
|
+
ListPrefetchScheduleType = Shapes::StringShape.new(name: 'ListPrefetchScheduleType')
|
115
116
|
ListPrefetchSchedulesRequest = Shapes::StructureShape.new(name: 'ListPrefetchSchedulesRequest')
|
116
117
|
ListPrefetchSchedulesResponse = Shapes::StructureShape.new(name: 'ListPrefetchSchedulesResponse')
|
117
118
|
ListSourceLocationsRequest = Shapes::StructureShape.new(name: 'ListSourceLocationsRequest')
|
@@ -141,10 +142,14 @@ module Aws::MediaTailor
|
|
141
142
|
PrefetchConsumption = Shapes::StructureShape.new(name: 'PrefetchConsumption')
|
142
143
|
PrefetchRetrieval = Shapes::StructureShape.new(name: 'PrefetchRetrieval')
|
143
144
|
PrefetchSchedule = Shapes::StructureShape.new(name: 'PrefetchSchedule')
|
145
|
+
PrefetchScheduleType = Shapes::StringShape.new(name: 'PrefetchScheduleType')
|
144
146
|
PutChannelPolicyRequest = Shapes::StructureShape.new(name: 'PutChannelPolicyRequest')
|
145
147
|
PutChannelPolicyResponse = Shapes::StructureShape.new(name: 'PutChannelPolicyResponse')
|
146
148
|
PutPlaybackConfigurationRequest = Shapes::StructureShape.new(name: 'PutPlaybackConfigurationRequest')
|
147
149
|
PutPlaybackConfigurationResponse = Shapes::StructureShape.new(name: 'PutPlaybackConfigurationResponse')
|
150
|
+
RecurringConsumption = Shapes::StructureShape.new(name: 'RecurringConsumption')
|
151
|
+
RecurringPrefetchConfiguration = Shapes::StructureShape.new(name: 'RecurringPrefetchConfiguration')
|
152
|
+
RecurringRetrieval = Shapes::StructureShape.new(name: 'RecurringRetrieval')
|
148
153
|
RelativePosition = Shapes::StringShape.new(name: 'RelativePosition')
|
149
154
|
RequestOutputItem = Shapes::StructureShape.new(name: 'RequestOutputItem')
|
150
155
|
RequestOutputs = Shapes::ListShape.new(name: 'RequestOutputs')
|
@@ -171,6 +176,8 @@ module Aws::MediaTailor
|
|
171
176
|
Tier = Shapes::StringShape.new(name: 'Tier')
|
172
177
|
TimeShiftConfiguration = Shapes::StructureShape.new(name: 'TimeShiftConfiguration')
|
173
178
|
TimeSignalMessage = Shapes::StructureShape.new(name: 'TimeSignalMessage')
|
179
|
+
TrafficShapingRetrievalWindow = Shapes::StructureShape.new(name: 'TrafficShapingRetrievalWindow')
|
180
|
+
TrafficShapingType = Shapes::StringShape.new(name: 'TrafficShapingType')
|
174
181
|
Transition = Shapes::StructureShape.new(name: 'Transition')
|
175
182
|
Type = Shapes::StringShape.new(name: 'Type')
|
176
183
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
@@ -373,10 +380,12 @@ module Aws::MediaTailor
|
|
373
380
|
CreateLiveSourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: __mapOf__string, location_name: "tags"))
|
374
381
|
CreateLiveSourceResponse.struct_class = Types::CreateLiveSourceResponse
|
375
382
|
|
376
|
-
CreatePrefetchScheduleRequest.add_member(:consumption, Shapes::ShapeRef.new(shape: PrefetchConsumption,
|
383
|
+
CreatePrefetchScheduleRequest.add_member(:consumption, Shapes::ShapeRef.new(shape: PrefetchConsumption, location_name: "Consumption"))
|
377
384
|
CreatePrefetchScheduleRequest.add_member(:name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "Name"))
|
378
385
|
CreatePrefetchScheduleRequest.add_member(:playback_configuration_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "PlaybackConfigurationName"))
|
379
|
-
CreatePrefetchScheduleRequest.add_member(:retrieval, Shapes::ShapeRef.new(shape: PrefetchRetrieval,
|
386
|
+
CreatePrefetchScheduleRequest.add_member(:retrieval, Shapes::ShapeRef.new(shape: PrefetchRetrieval, location_name: "Retrieval"))
|
387
|
+
CreatePrefetchScheduleRequest.add_member(:recurring_prefetch_configuration, Shapes::ShapeRef.new(shape: RecurringPrefetchConfiguration, location_name: "RecurringPrefetchConfiguration"))
|
388
|
+
CreatePrefetchScheduleRequest.add_member(:schedule_type, Shapes::ShapeRef.new(shape: PrefetchScheduleType, location_name: "ScheduleType"))
|
380
389
|
CreatePrefetchScheduleRequest.add_member(:stream_id, Shapes::ShapeRef.new(shape: __string, location_name: "StreamId"))
|
381
390
|
CreatePrefetchScheduleRequest.struct_class = Types::CreatePrefetchScheduleRequest
|
382
391
|
|
@@ -385,6 +394,8 @@ module Aws::MediaTailor
|
|
385
394
|
CreatePrefetchScheduleResponse.add_member(:name, Shapes::ShapeRef.new(shape: __string, location_name: "Name"))
|
386
395
|
CreatePrefetchScheduleResponse.add_member(:playback_configuration_name, Shapes::ShapeRef.new(shape: __string, location_name: "PlaybackConfigurationName"))
|
387
396
|
CreatePrefetchScheduleResponse.add_member(:retrieval, Shapes::ShapeRef.new(shape: PrefetchRetrieval, location_name: "Retrieval"))
|
397
|
+
CreatePrefetchScheduleResponse.add_member(:recurring_prefetch_configuration, Shapes::ShapeRef.new(shape: RecurringPrefetchConfiguration, location_name: "RecurringPrefetchConfiguration"))
|
398
|
+
CreatePrefetchScheduleResponse.add_member(:schedule_type, Shapes::ShapeRef.new(shape: PrefetchScheduleType, location_name: "ScheduleType"))
|
388
399
|
CreatePrefetchScheduleResponse.add_member(:stream_id, Shapes::ShapeRef.new(shape: __string, location_name: "StreamId"))
|
389
400
|
CreatePrefetchScheduleResponse.struct_class = Types::CreatePrefetchScheduleResponse
|
390
401
|
|
@@ -637,6 +648,8 @@ module Aws::MediaTailor
|
|
637
648
|
GetPrefetchScheduleResponse.add_member(:name, Shapes::ShapeRef.new(shape: __string, location_name: "Name"))
|
638
649
|
GetPrefetchScheduleResponse.add_member(:playback_configuration_name, Shapes::ShapeRef.new(shape: __string, location_name: "PlaybackConfigurationName"))
|
639
650
|
GetPrefetchScheduleResponse.add_member(:retrieval, Shapes::ShapeRef.new(shape: PrefetchRetrieval, location_name: "Retrieval"))
|
651
|
+
GetPrefetchScheduleResponse.add_member(:schedule_type, Shapes::ShapeRef.new(shape: PrefetchScheduleType, location_name: "ScheduleType"))
|
652
|
+
GetPrefetchScheduleResponse.add_member(:recurring_prefetch_configuration, Shapes::ShapeRef.new(shape: RecurringPrefetchConfiguration, location_name: "RecurringPrefetchConfiguration"))
|
640
653
|
GetPrefetchScheduleResponse.add_member(:stream_id, Shapes::ShapeRef.new(shape: __string, location_name: "StreamId"))
|
641
654
|
GetPrefetchScheduleResponse.struct_class = Types::GetPrefetchScheduleResponse
|
642
655
|
|
@@ -698,6 +711,7 @@ module Aws::MediaTailor
|
|
698
711
|
ListPrefetchSchedulesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: __integerMin1Max100, location_name: "MaxResults"))
|
699
712
|
ListPrefetchSchedulesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: __string, location_name: "NextToken"))
|
700
713
|
ListPrefetchSchedulesRequest.add_member(:playback_configuration_name, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "PlaybackConfigurationName"))
|
714
|
+
ListPrefetchSchedulesRequest.add_member(:schedule_type, Shapes::ShapeRef.new(shape: ListPrefetchScheduleType, location_name: "ScheduleType"))
|
701
715
|
ListPrefetchSchedulesRequest.add_member(:stream_id, Shapes::ShapeRef.new(shape: __string, location_name: "StreamId"))
|
702
716
|
ListPrefetchSchedulesRequest.struct_class = Types::ListPrefetchSchedulesRequest
|
703
717
|
|
@@ -789,13 +803,17 @@ module Aws::MediaTailor
|
|
789
803
|
PrefetchRetrieval.add_member(:dynamic_variables, Shapes::ShapeRef.new(shape: __mapOf__string, location_name: "DynamicVariables"))
|
790
804
|
PrefetchRetrieval.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampUnix, required: true, location_name: "EndTime"))
|
791
805
|
PrefetchRetrieval.add_member(:start_time, Shapes::ShapeRef.new(shape: __timestampUnix, location_name: "StartTime"))
|
806
|
+
PrefetchRetrieval.add_member(:traffic_shaping_type, Shapes::ShapeRef.new(shape: TrafficShapingType, location_name: "TrafficShapingType"))
|
807
|
+
PrefetchRetrieval.add_member(:traffic_shaping_retrieval_window, Shapes::ShapeRef.new(shape: TrafficShapingRetrievalWindow, location_name: "TrafficShapingRetrievalWindow"))
|
792
808
|
PrefetchRetrieval.struct_class = Types::PrefetchRetrieval
|
793
809
|
|
794
810
|
PrefetchSchedule.add_member(:arn, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Arn"))
|
795
|
-
PrefetchSchedule.add_member(:consumption, Shapes::ShapeRef.new(shape: PrefetchConsumption,
|
811
|
+
PrefetchSchedule.add_member(:consumption, Shapes::ShapeRef.new(shape: PrefetchConsumption, location_name: "Consumption"))
|
796
812
|
PrefetchSchedule.add_member(:name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "Name"))
|
797
813
|
PrefetchSchedule.add_member(:playback_configuration_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "PlaybackConfigurationName"))
|
798
|
-
PrefetchSchedule.add_member(:retrieval, Shapes::ShapeRef.new(shape: PrefetchRetrieval,
|
814
|
+
PrefetchSchedule.add_member(:retrieval, Shapes::ShapeRef.new(shape: PrefetchRetrieval, location_name: "Retrieval"))
|
815
|
+
PrefetchSchedule.add_member(:schedule_type, Shapes::ShapeRef.new(shape: PrefetchScheduleType, location_name: "ScheduleType"))
|
816
|
+
PrefetchSchedule.add_member(:recurring_prefetch_configuration, Shapes::ShapeRef.new(shape: RecurringPrefetchConfiguration, location_name: "RecurringPrefetchConfiguration"))
|
799
817
|
PrefetchSchedule.add_member(:stream_id, Shapes::ShapeRef.new(shape: __string, location_name: "StreamId"))
|
800
818
|
PrefetchSchedule.struct_class = Types::PrefetchSchedule
|
801
819
|
|
@@ -846,6 +864,22 @@ module Aws::MediaTailor
|
|
846
864
|
PutPlaybackConfigurationResponse.add_member(:ad_conditioning_configuration, Shapes::ShapeRef.new(shape: AdConditioningConfiguration, location_name: "AdConditioningConfiguration"))
|
847
865
|
PutPlaybackConfigurationResponse.struct_class = Types::PutPlaybackConfigurationResponse
|
848
866
|
|
867
|
+
RecurringConsumption.add_member(:retrieved_ad_expiration_seconds, Shapes::ShapeRef.new(shape: __integer, location_name: "RetrievedAdExpirationSeconds"))
|
868
|
+
RecurringConsumption.add_member(:avail_matching_criteria, Shapes::ShapeRef.new(shape: __listOfAvailMatchingCriteria, location_name: "AvailMatchingCriteria"))
|
869
|
+
RecurringConsumption.struct_class = Types::RecurringConsumption
|
870
|
+
|
871
|
+
RecurringPrefetchConfiguration.add_member(:start_time, Shapes::ShapeRef.new(shape: __timestampUnix, location_name: "StartTime"))
|
872
|
+
RecurringPrefetchConfiguration.add_member(:end_time, Shapes::ShapeRef.new(shape: __timestampUnix, required: true, location_name: "EndTime"))
|
873
|
+
RecurringPrefetchConfiguration.add_member(:recurring_consumption, Shapes::ShapeRef.new(shape: RecurringConsumption, required: true, location_name: "RecurringConsumption"))
|
874
|
+
RecurringPrefetchConfiguration.add_member(:recurring_retrieval, Shapes::ShapeRef.new(shape: RecurringRetrieval, required: true, location_name: "RecurringRetrieval"))
|
875
|
+
RecurringPrefetchConfiguration.struct_class = Types::RecurringPrefetchConfiguration
|
876
|
+
|
877
|
+
RecurringRetrieval.add_member(:dynamic_variables, Shapes::ShapeRef.new(shape: __mapOf__string, location_name: "DynamicVariables"))
|
878
|
+
RecurringRetrieval.add_member(:delay_after_avail_end_seconds, Shapes::ShapeRef.new(shape: __integer, location_name: "DelayAfterAvailEndSeconds"))
|
879
|
+
RecurringRetrieval.add_member(:traffic_shaping_type, Shapes::ShapeRef.new(shape: TrafficShapingType, location_name: "TrafficShapingType"))
|
880
|
+
RecurringRetrieval.add_member(:traffic_shaping_retrieval_window, Shapes::ShapeRef.new(shape: TrafficShapingRetrievalWindow, location_name: "TrafficShapingRetrievalWindow"))
|
881
|
+
RecurringRetrieval.struct_class = Types::RecurringRetrieval
|
882
|
+
|
849
883
|
RequestOutputItem.add_member(:dash_playlist_settings, Shapes::ShapeRef.new(shape: DashPlaylistSettings, location_name: "DashPlaylistSettings"))
|
850
884
|
RequestOutputItem.add_member(:hls_playlist_settings, Shapes::ShapeRef.new(shape: HlsPlaylistSettings, location_name: "HlsPlaylistSettings"))
|
851
885
|
RequestOutputItem.add_member(:manifest_name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "ManifestName"))
|
@@ -948,6 +982,9 @@ module Aws::MediaTailor
|
|
948
982
|
TimeSignalMessage.add_member(:segmentation_descriptors, Shapes::ShapeRef.new(shape: SegmentationDescriptorList, location_name: "SegmentationDescriptors"))
|
949
983
|
TimeSignalMessage.struct_class = Types::TimeSignalMessage
|
950
984
|
|
985
|
+
TrafficShapingRetrievalWindow.add_member(:retrieval_window_duration_seconds, Shapes::ShapeRef.new(shape: __integer, location_name: "RetrievalWindowDurationSeconds"))
|
986
|
+
TrafficShapingRetrievalWindow.struct_class = Types::TrafficShapingRetrievalWindow
|
987
|
+
|
951
988
|
Transition.add_member(:duration_millis, Shapes::ShapeRef.new(shape: __long, location_name: "DurationMillis"))
|
952
989
|
Transition.add_member(:relative_position, Shapes::ShapeRef.new(shape: RelativePosition, required: true, location_name: "RelativePosition"))
|
953
990
|
Transition.add_member(:relative_program, Shapes::ShapeRef.new(shape: __string, location_name: "RelativeProgram"))
|
@@ -987,11 +987,12 @@ module Aws::MediaTailor
|
|
987
987
|
end
|
988
988
|
|
989
989
|
# @!attribute [rw] consumption
|
990
|
-
# The configuration settings for
|
991
|
-
# prefetched ads from the ad decision server
|
992
|
-
# configuration contains an end time and
|
993
|
-
# define the *consumption window*.
|
994
|
-
# expire no earlier than seven days
|
990
|
+
# The configuration settings for how and when MediaTailor consumes
|
991
|
+
# prefetched ads from the ad decision server for single prefetch
|
992
|
+
# schedules. Each consumption configuration contains an end time and
|
993
|
+
# an optional start time that define the *consumption window*.
|
994
|
+
# Prefetch schedules automatically expire no earlier than seven days
|
995
|
+
# after the end time.
|
995
996
|
# @return [Types::PrefetchConsumption]
|
996
997
|
#
|
997
998
|
# @!attribute [rw] name
|
@@ -1008,6 +1009,25 @@ module Aws::MediaTailor
|
|
1008
1009
|
# and subsequently consumed for each ad break.
|
1009
1010
|
# @return [Types::PrefetchRetrieval]
|
1010
1011
|
#
|
1012
|
+
# @!attribute [rw] recurring_prefetch_configuration
|
1013
|
+
# The configuration that defines how and when MediaTailor performs ad
|
1014
|
+
# prefetching in a live event.
|
1015
|
+
# @return [Types::RecurringPrefetchConfiguration]
|
1016
|
+
#
|
1017
|
+
# @!attribute [rw] schedule_type
|
1018
|
+
# The frequency that MediaTailor creates prefetch schedules. `SINGLE`
|
1019
|
+
# indicates that this schedule applies to one ad break. `RECURRING`
|
1020
|
+
# indicates that MediaTailor automatically creates a schedule for each
|
1021
|
+
# ad avail in a live event.
|
1022
|
+
#
|
1023
|
+
# For more information about the prefetch types and when you might use
|
1024
|
+
# each, see [Prefetching ads in Elemental MediaTailor.][1]
|
1025
|
+
#
|
1026
|
+
#
|
1027
|
+
#
|
1028
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1011
1031
|
# @!attribute [rw] stream_id
|
1012
1032
|
# An optional stream identifier that MediaTailor uses to prefetch ads
|
1013
1033
|
# for multiple streams that use the same playback configuration. If
|
@@ -1024,6 +1044,8 @@ module Aws::MediaTailor
|
|
1024
1044
|
:name,
|
1025
1045
|
:playback_configuration_name,
|
1026
1046
|
:retrieval,
|
1047
|
+
:recurring_prefetch_configuration,
|
1048
|
+
:schedule_type,
|
1027
1049
|
:stream_id)
|
1028
1050
|
SENSITIVE = []
|
1029
1051
|
include Aws::Structure
|
@@ -1034,11 +1056,12 @@ module Aws::MediaTailor
|
|
1034
1056
|
# @return [String]
|
1035
1057
|
#
|
1036
1058
|
# @!attribute [rw] consumption
|
1037
|
-
# The configuration settings for
|
1038
|
-
# prefetched ads from the ad decision server
|
1039
|
-
# configuration contains an end time and
|
1040
|
-
# define the *consumption window*.
|
1041
|
-
# expire no earlier than seven days
|
1059
|
+
# The configuration settings for how and when MediaTailor consumes
|
1060
|
+
# prefetched ads from the ad decision server for single prefetch
|
1061
|
+
# schedules. Each consumption configuration contains an end time and
|
1062
|
+
# an optional start time that define the *consumption window*.
|
1063
|
+
# Prefetch schedules automatically expire no earlier than seven days
|
1064
|
+
# after the end time.
|
1042
1065
|
# @return [Types::PrefetchConsumption]
|
1043
1066
|
#
|
1044
1067
|
# @!attribute [rw] name
|
@@ -1055,6 +1078,18 @@ module Aws::MediaTailor
|
|
1055
1078
|
# and subsequently consumed for each ad break.
|
1056
1079
|
# @return [Types::PrefetchRetrieval]
|
1057
1080
|
#
|
1081
|
+
# @!attribute [rw] recurring_prefetch_configuration
|
1082
|
+
# The configuration that defines how MediaTailor performs recurring
|
1083
|
+
# prefetch.
|
1084
|
+
# @return [Types::RecurringPrefetchConfiguration]
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] schedule_type
|
1087
|
+
# The frequency that MediaTailor creates prefetch schedules. `SINGLE`
|
1088
|
+
# indicates that this schedule applies to one ad break. `RECURRING`
|
1089
|
+
# indicates that MediaTailor automatically creates a schedule for each
|
1090
|
+
# ad avail in a live event.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1058
1093
|
# @!attribute [rw] stream_id
|
1059
1094
|
# An optional stream identifier that MediaTailor uses to prefetch ads
|
1060
1095
|
# for multiple streams that use the same playback configuration. If
|
@@ -1072,6 +1107,8 @@ module Aws::MediaTailor
|
|
1072
1107
|
:name,
|
1073
1108
|
:playback_configuration_name,
|
1074
1109
|
:retrieval,
|
1110
|
+
:recurring_prefetch_configuration,
|
1111
|
+
:schedule_type,
|
1075
1112
|
:stream_id)
|
1076
1113
|
SENSITIVE = []
|
1077
1114
|
include Aws::Structure
|
@@ -2358,11 +2395,12 @@ module Aws::MediaTailor
|
|
2358
2395
|
# @return [String]
|
2359
2396
|
#
|
2360
2397
|
# @!attribute [rw] consumption
|
2361
|
-
#
|
2362
|
-
# prefetched ads
|
2363
|
-
#
|
2364
|
-
#
|
2365
|
-
#
|
2398
|
+
# The configuration settings for how and when MediaTailor consumes
|
2399
|
+
# prefetched ads from the ad decision server for single prefetch
|
2400
|
+
# schedules. Each consumption configuration contains an end time and
|
2401
|
+
# an optional start time that define the *consumption window*.
|
2402
|
+
# Prefetch schedules automatically expire no earlier than seven days
|
2403
|
+
# after the end time.
|
2366
2404
|
# @return [Types::PrefetchConsumption]
|
2367
2405
|
#
|
2368
2406
|
# @!attribute [rw] name
|
@@ -2381,6 +2419,18 @@ module Aws::MediaTailor
|
|
2381
2419
|
# the ad decision server (ADS).
|
2382
2420
|
# @return [Types::PrefetchRetrieval]
|
2383
2421
|
#
|
2422
|
+
# @!attribute [rw] schedule_type
|
2423
|
+
# The frequency that MediaTailor creates prefetch schedules. `SINGLE`
|
2424
|
+
# indicates that this schedule applies to one ad break. `RECURRING`
|
2425
|
+
# indicates that MediaTailor automatically creates a schedule for each
|
2426
|
+
# ad avail in a live event.
|
2427
|
+
# @return [String]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] recurring_prefetch_configuration
|
2430
|
+
# The configuration that defines how and when MediaTailor performs ad
|
2431
|
+
# prefetching in a live event.
|
2432
|
+
# @return [Types::RecurringPrefetchConfiguration]
|
2433
|
+
#
|
2384
2434
|
# @!attribute [rw] stream_id
|
2385
2435
|
# An optional stream identifier that you can specify in order to
|
2386
2436
|
# prefetch for multiple streams that use the same playback
|
@@ -2395,6 +2445,8 @@ module Aws::MediaTailor
|
|
2395
2445
|
:name,
|
2396
2446
|
:playback_configuration_name,
|
2397
2447
|
:retrieval,
|
2448
|
+
:schedule_type,
|
2449
|
+
:recurring_prefetch_configuration,
|
2398
2450
|
:stream_id)
|
2399
2451
|
SENSITIVE = []
|
2400
2452
|
include Aws::Structure
|
@@ -2713,6 +2765,14 @@ module Aws::MediaTailor
|
|
2713
2765
|
# configuration.
|
2714
2766
|
# @return [String]
|
2715
2767
|
#
|
2768
|
+
# @!attribute [rw] schedule_type
|
2769
|
+
# The type of prefetch schedules that you want to list. `SINGLE`
|
2770
|
+
# indicates that you want to list the configured single prefetch
|
2771
|
+
# schedules. `RECURRING` indicates that you want to list the
|
2772
|
+
# configured recurring prefetch schedules. `ALL` indicates that you
|
2773
|
+
# want to list all configured prefetch schedules.
|
2774
|
+
# @return [String]
|
2775
|
+
#
|
2716
2776
|
# @!attribute [rw] stream_id
|
2717
2777
|
# An optional filtering parameter whereby MediaTailor filters the
|
2718
2778
|
# prefetch schedules to include only specific streams.
|
@@ -2724,6 +2784,7 @@ module Aws::MediaTailor
|
|
2724
2784
|
:max_results,
|
2725
2785
|
:next_token,
|
2726
2786
|
:playback_configuration_name,
|
2787
|
+
:schedule_type,
|
2727
2788
|
:stream_id)
|
2728
2789
|
SENSITIVE = []
|
2729
2790
|
include Aws::Structure
|
@@ -3242,8 +3303,8 @@ module Aws::MediaTailor
|
|
3242
3303
|
include Aws::Structure
|
3243
3304
|
end
|
3244
3305
|
|
3245
|
-
#
|
3246
|
-
#
|
3306
|
+
# For single prefetch, describes how and when that MediaTailor places
|
3307
|
+
# prefetched ads into upcoming ad breaks.
|
3247
3308
|
#
|
3248
3309
|
# @!attribute [rw] avail_matching_criteria
|
3249
3310
|
# If you only want MediaTailor to insert prefetched ads into avails
|
@@ -3306,12 +3367,24 @@ module Aws::MediaTailor
|
|
3306
3367
|
# prefetch retrieval starts as soon as possible.
|
3307
3368
|
# @return [Time]
|
3308
3369
|
#
|
3370
|
+
# @!attribute [rw] traffic_shaping_type
|
3371
|
+
# Indicates if this configuration uses a retrieval window for traffic
|
3372
|
+
# shaping and limiting the number of requests to the ADS at one time.
|
3373
|
+
# @return [String]
|
3374
|
+
#
|
3375
|
+
# @!attribute [rw] traffic_shaping_retrieval_window
|
3376
|
+
# Configuration for spreading ADS traffic across a set window instead
|
3377
|
+
# of sending ADS requests for all sessions at the same time.
|
3378
|
+
# @return [Types::TrafficShapingRetrievalWindow]
|
3379
|
+
#
|
3309
3380
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PrefetchRetrieval AWS API Documentation
|
3310
3381
|
#
|
3311
3382
|
class PrefetchRetrieval < Struct.new(
|
3312
3383
|
:dynamic_variables,
|
3313
3384
|
:end_time,
|
3314
|
-
:start_time
|
3385
|
+
:start_time,
|
3386
|
+
:traffic_shaping_type,
|
3387
|
+
:traffic_shaping_retrieval_window)
|
3315
3388
|
SENSITIVE = []
|
3316
3389
|
include Aws::Structure
|
3317
3390
|
end
|
@@ -3331,10 +3404,11 @@ module Aws::MediaTailor
|
|
3331
3404
|
#
|
3332
3405
|
# @!attribute [rw] consumption
|
3333
3406
|
# Consumption settings determine how, and when, MediaTailor places the
|
3334
|
-
# prefetched ads into ad breaks
|
3335
|
-
# of time that you define, called a
|
3336
|
-
# designate which ad breaks that
|
3337
|
-
# by setting avail matching
|
3407
|
+
# prefetched ads into ad breaks for single prefetch schedules. Ad
|
3408
|
+
# consumption occurs within a span of time that you define, called a
|
3409
|
+
# *consumption window*. You can designate which ad breaks that
|
3410
|
+
# MediaTailor fills with prefetch ads by setting avail matching
|
3411
|
+
# criteria.
|
3338
3412
|
# @return [Types::PrefetchConsumption]
|
3339
3413
|
#
|
3340
3414
|
# @!attribute [rw] name
|
@@ -3353,6 +3427,25 @@ module Aws::MediaTailor
|
|
3353
3427
|
# the ad decision server (ADS).
|
3354
3428
|
# @return [Types::PrefetchRetrieval]
|
3355
3429
|
#
|
3430
|
+
# @!attribute [rw] schedule_type
|
3431
|
+
# The frequency that MediaTailor creates prefetch schedules. `SINGLE`
|
3432
|
+
# indicates that this schedule applies to one ad break. `RECURRING`
|
3433
|
+
# indicates that MediaTailor automatically creates a schedule for each
|
3434
|
+
# ad avail in a live event.
|
3435
|
+
#
|
3436
|
+
# For more information about the prefetch types and when you might use
|
3437
|
+
# each, see [Prefetching ads in Elemental MediaTailor.][1]
|
3438
|
+
#
|
3439
|
+
#
|
3440
|
+
#
|
3441
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
3442
|
+
# @return [String]
|
3443
|
+
#
|
3444
|
+
# @!attribute [rw] recurring_prefetch_configuration
|
3445
|
+
# The settings that determine how and when MediaTailor prefetches ads
|
3446
|
+
# and inserts them into ad breaks.
|
3447
|
+
# @return [Types::RecurringPrefetchConfiguration]
|
3448
|
+
#
|
3356
3449
|
# @!attribute [rw] stream_id
|
3357
3450
|
# An optional stream identifier that you can specify in order to
|
3358
3451
|
# prefetch for multiple streams that use the same playback
|
@@ -3367,6 +3460,8 @@ module Aws::MediaTailor
|
|
3367
3460
|
:name,
|
3368
3461
|
:playback_configuration_name,
|
3369
3462
|
:retrieval,
|
3463
|
+
:schedule_type,
|
3464
|
+
:recurring_prefetch_configuration,
|
3370
3465
|
:stream_id)
|
3371
3466
|
SENSITIVE = []
|
3372
3467
|
include Aws::Structure
|
@@ -3720,6 +3815,99 @@ module Aws::MediaTailor
|
|
3720
3815
|
include Aws::Structure
|
3721
3816
|
end
|
3722
3817
|
|
3818
|
+
# The settings that determine how and when MediaTailor places prefetched
|
3819
|
+
# ads into upcoming ad breaks for recurring prefetch scedules.
|
3820
|
+
#
|
3821
|
+
# @!attribute [rw] retrieved_ad_expiration_seconds
|
3822
|
+
# The number of seconds that an ad is available for insertion after it
|
3823
|
+
# was prefetched.
|
3824
|
+
# @return [Integer]
|
3825
|
+
#
|
3826
|
+
# @!attribute [rw] avail_matching_criteria
|
3827
|
+
# The configuration for the dynamic variables that determine which ad
|
3828
|
+
# breaks that MediaTailor inserts prefetched ads in.
|
3829
|
+
# @return [Array<Types::AvailMatchingCriteria>]
|
3830
|
+
#
|
3831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RecurringConsumption AWS API Documentation
|
3832
|
+
#
|
3833
|
+
class RecurringConsumption < Struct.new(
|
3834
|
+
:retrieved_ad_expiration_seconds,
|
3835
|
+
:avail_matching_criteria)
|
3836
|
+
SENSITIVE = []
|
3837
|
+
include Aws::Structure
|
3838
|
+
end
|
3839
|
+
|
3840
|
+
# The configuration that defines how MediaTailor performs recurring
|
3841
|
+
# prefetch.
|
3842
|
+
#
|
3843
|
+
# @!attribute [rw] start_time
|
3844
|
+
# The start time for the window that MediaTailor prefetches and
|
3845
|
+
# inserts ads in a live event.
|
3846
|
+
# @return [Time]
|
3847
|
+
#
|
3848
|
+
# @!attribute [rw] end_time
|
3849
|
+
# The end time for the window that MediaTailor prefetches and inserts
|
3850
|
+
# ads in a live event.
|
3851
|
+
# @return [Time]
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] recurring_consumption
|
3854
|
+
# The settings that determine how and when MediaTailor places
|
3855
|
+
# prefetched ads into upcoming ad breaks for recurring prefetch
|
3856
|
+
# scedules.
|
3857
|
+
# @return [Types::RecurringConsumption]
|
3858
|
+
#
|
3859
|
+
# @!attribute [rw] recurring_retrieval
|
3860
|
+
# The configuration for prefetch ad retrieval from the ADS.
|
3861
|
+
# @return [Types::RecurringRetrieval]
|
3862
|
+
#
|
3863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RecurringPrefetchConfiguration AWS API Documentation
|
3864
|
+
#
|
3865
|
+
class RecurringPrefetchConfiguration < Struct.new(
|
3866
|
+
:start_time,
|
3867
|
+
:end_time,
|
3868
|
+
:recurring_consumption,
|
3869
|
+
:recurring_retrieval)
|
3870
|
+
SENSITIVE = []
|
3871
|
+
include Aws::Structure
|
3872
|
+
end
|
3873
|
+
|
3874
|
+
# With recurring prefetch, MediaTailor automatically prefetches ads for
|
3875
|
+
# every avail that occurs during the retrieval window. The following
|
3876
|
+
# configurations describe the MediaTailor behavior when prefetching ads
|
3877
|
+
# for a live event.
|
3878
|
+
#
|
3879
|
+
# @!attribute [rw] dynamic_variables
|
3880
|
+
# The dynamic variables to use for substitution during prefetch
|
3881
|
+
# requests to the ADS.
|
3882
|
+
# @return [Hash<String,String>]
|
3883
|
+
#
|
3884
|
+
# @!attribute [rw] delay_after_avail_end_seconds
|
3885
|
+
# The number of seconds that MediaTailor waits after an ad avail
|
3886
|
+
# before prefetching ads for the next avail. If not set, the default
|
3887
|
+
# is 0 (no delay).
|
3888
|
+
# @return [Integer]
|
3889
|
+
#
|
3890
|
+
# @!attribute [rw] traffic_shaping_type
|
3891
|
+
# Indicates if this configuration uses a retrieval window for traffic
|
3892
|
+
# shaping and limiting the number of requests to the ADS at one time.
|
3893
|
+
# @return [String]
|
3894
|
+
#
|
3895
|
+
# @!attribute [rw] traffic_shaping_retrieval_window
|
3896
|
+
# Configuration for spreading ADS traffic across a set window instead
|
3897
|
+
# of sending ADS requests for all sessions at the same time.
|
3898
|
+
# @return [Types::TrafficShapingRetrievalWindow]
|
3899
|
+
#
|
3900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RecurringRetrieval AWS API Documentation
|
3901
|
+
#
|
3902
|
+
class RecurringRetrieval < Struct.new(
|
3903
|
+
:dynamic_variables,
|
3904
|
+
:delay_after_avail_end_seconds,
|
3905
|
+
:traffic_shaping_type,
|
3906
|
+
:traffic_shaping_retrieval_window)
|
3907
|
+
SENSITIVE = []
|
3908
|
+
include Aws::Structure
|
3909
|
+
end
|
3910
|
+
|
3723
3911
|
# The output configuration for this channel.
|
3724
3912
|
#
|
3725
3913
|
# @!attribute [rw] dash_playlist_settings
|
@@ -4271,6 +4459,24 @@ module Aws::MediaTailor
|
|
4271
4459
|
include Aws::Structure
|
4272
4460
|
end
|
4273
4461
|
|
4462
|
+
# The configuration that tells Elemental MediaTailor how to spread out
|
4463
|
+
# requests to the ad decision server (ADS). Instead of sending ADS
|
4464
|
+
# requests for all sessions at the same time, MediaTailor spreads the
|
4465
|
+
# requests across the amount of time specified in the retrieval window.
|
4466
|
+
#
|
4467
|
+
# @!attribute [rw] retrieval_window_duration_seconds
|
4468
|
+
# The amount of time, in seconds, that MediaTailor spreads prefetch
|
4469
|
+
# requests to the ADS.
|
4470
|
+
# @return [Integer]
|
4471
|
+
#
|
4472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TrafficShapingRetrievalWindow AWS API Documentation
|
4473
|
+
#
|
4474
|
+
class TrafficShapingRetrievalWindow < Struct.new(
|
4475
|
+
:retrieval_window_duration_seconds)
|
4476
|
+
SENSITIVE = []
|
4477
|
+
include Aws::Structure
|
4478
|
+
end
|
4479
|
+
|
4274
4480
|
# Program transition configuration.
|
4275
4481
|
#
|
4276
4482
|
# @!attribute [rw] duration_millis
|
data/lib/aws-sdk-mediatailor.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -192,11 +192,13 @@ module Aws
|
|
192
192
|
def name: () -> ::String
|
193
193
|
def playback_configuration_name: () -> ::String
|
194
194
|
def retrieval: () -> Types::PrefetchRetrieval
|
195
|
+
def recurring_prefetch_configuration: () -> Types::RecurringPrefetchConfiguration
|
196
|
+
def schedule_type: () -> ("SINGLE" | "RECURRING")
|
195
197
|
def stream_id: () -> ::String
|
196
198
|
end
|
197
199
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MediaTailor/Client.html#create_prefetch_schedule-instance_method
|
198
200
|
def create_prefetch_schedule: (
|
199
|
-
consumption: {
|
201
|
+
?consumption: {
|
200
202
|
avail_matching_criteria: Array[
|
201
203
|
{
|
202
204
|
dynamic_variable: ::String,
|
@@ -208,11 +210,37 @@ module Aws
|
|
208
210
|
},
|
209
211
|
name: ::String,
|
210
212
|
playback_configuration_name: ::String,
|
211
|
-
retrieval: {
|
213
|
+
?retrieval: {
|
212
214
|
dynamic_variables: Hash[::String, ::String]?,
|
213
215
|
end_time: ::Time,
|
214
|
-
start_time: ::Time
|
216
|
+
start_time: ::Time?,
|
217
|
+
traffic_shaping_type: ("RETRIEVAL_WINDOW")?,
|
218
|
+
traffic_shaping_retrieval_window: {
|
219
|
+
retrieval_window_duration_seconds: ::Integer?
|
220
|
+
}?
|
221
|
+
},
|
222
|
+
?recurring_prefetch_configuration: {
|
223
|
+
start_time: ::Time?,
|
224
|
+
end_time: ::Time,
|
225
|
+
recurring_consumption: {
|
226
|
+
retrieved_ad_expiration_seconds: ::Integer?,
|
227
|
+
avail_matching_criteria: Array[
|
228
|
+
{
|
229
|
+
dynamic_variable: ::String,
|
230
|
+
operator: ("EQUALS")
|
231
|
+
},
|
232
|
+
]?
|
233
|
+
},
|
234
|
+
recurring_retrieval: {
|
235
|
+
dynamic_variables: Hash[::String, ::String]?,
|
236
|
+
delay_after_avail_end_seconds: ::Integer?,
|
237
|
+
traffic_shaping_type: ("RETRIEVAL_WINDOW")?,
|
238
|
+
traffic_shaping_retrieval_window: {
|
239
|
+
retrieval_window_duration_seconds: ::Integer?
|
240
|
+
}?
|
241
|
+
}
|
215
242
|
},
|
243
|
+
?schedule_type: ("SINGLE" | "RECURRING"),
|
216
244
|
?stream_id: ::String
|
217
245
|
) -> _CreatePrefetchScheduleResponseSuccess
|
218
246
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePrefetchScheduleResponseSuccess
|
@@ -644,6 +672,8 @@ module Aws
|
|
644
672
|
def name: () -> ::String
|
645
673
|
def playback_configuration_name: () -> ::String
|
646
674
|
def retrieval: () -> Types::PrefetchRetrieval
|
675
|
+
def schedule_type: () -> ("SINGLE" | "RECURRING")
|
676
|
+
def recurring_prefetch_configuration: () -> Types::RecurringPrefetchConfiguration
|
647
677
|
def stream_id: () -> ::String
|
648
678
|
end
|
649
679
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MediaTailor/Client.html#get_prefetch_schedule-instance_method
|
@@ -713,6 +743,7 @@ module Aws
|
|
713
743
|
?max_results: ::Integer,
|
714
744
|
?next_token: ::String,
|
715
745
|
playback_configuration_name: ::String,
|
746
|
+
?schedule_type: ("SINGLE" | "RECURRING" | "ALL"),
|
716
747
|
?stream_id: ::String
|
717
748
|
) -> _ListPrefetchSchedulesResponseSuccess
|
718
749
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPrefetchSchedulesResponseSuccess
|
data/sig/types.rbs
CHANGED
@@ -206,6 +206,8 @@ module Aws::MediaTailor
|
|
206
206
|
attr_accessor name: ::String
|
207
207
|
attr_accessor playback_configuration_name: ::String
|
208
208
|
attr_accessor retrieval: Types::PrefetchRetrieval
|
209
|
+
attr_accessor recurring_prefetch_configuration: Types::RecurringPrefetchConfiguration
|
210
|
+
attr_accessor schedule_type: ("SINGLE" | "RECURRING")
|
209
211
|
attr_accessor stream_id: ::String
|
210
212
|
SENSITIVE: []
|
211
213
|
end
|
@@ -216,6 +218,8 @@ module Aws::MediaTailor
|
|
216
218
|
attr_accessor name: ::String
|
217
219
|
attr_accessor playback_configuration_name: ::String
|
218
220
|
attr_accessor retrieval: Types::PrefetchRetrieval
|
221
|
+
attr_accessor recurring_prefetch_configuration: Types::RecurringPrefetchConfiguration
|
222
|
+
attr_accessor schedule_type: ("SINGLE" | "RECURRING")
|
219
223
|
attr_accessor stream_id: ::String
|
220
224
|
SENSITIVE: []
|
221
225
|
end
|
@@ -548,6 +552,8 @@ module Aws::MediaTailor
|
|
548
552
|
attr_accessor name: ::String
|
549
553
|
attr_accessor playback_configuration_name: ::String
|
550
554
|
attr_accessor retrieval: Types::PrefetchRetrieval
|
555
|
+
attr_accessor schedule_type: ("SINGLE" | "RECURRING")
|
556
|
+
attr_accessor recurring_prefetch_configuration: Types::RecurringPrefetchConfiguration
|
551
557
|
attr_accessor stream_id: ::String
|
552
558
|
SENSITIVE: []
|
553
559
|
end
|
@@ -635,6 +641,7 @@ module Aws::MediaTailor
|
|
635
641
|
attr_accessor max_results: ::Integer
|
636
642
|
attr_accessor next_token: ::String
|
637
643
|
attr_accessor playback_configuration_name: ::String
|
644
|
+
attr_accessor schedule_type: ("SINGLE" | "RECURRING" | "ALL")
|
638
645
|
attr_accessor stream_id: ::String
|
639
646
|
SENSITIVE: []
|
640
647
|
end
|
@@ -756,6 +763,8 @@ module Aws::MediaTailor
|
|
756
763
|
attr_accessor dynamic_variables: ::Hash[::String, ::String]
|
757
764
|
attr_accessor end_time: ::Time
|
758
765
|
attr_accessor start_time: ::Time
|
766
|
+
attr_accessor traffic_shaping_type: ("RETRIEVAL_WINDOW")
|
767
|
+
attr_accessor traffic_shaping_retrieval_window: Types::TrafficShapingRetrievalWindow
|
759
768
|
SENSITIVE: []
|
760
769
|
end
|
761
770
|
|
@@ -765,6 +774,8 @@ module Aws::MediaTailor
|
|
765
774
|
attr_accessor name: ::String
|
766
775
|
attr_accessor playback_configuration_name: ::String
|
767
776
|
attr_accessor retrieval: Types::PrefetchRetrieval
|
777
|
+
attr_accessor schedule_type: ("SINGLE" | "RECURRING")
|
778
|
+
attr_accessor recurring_prefetch_configuration: Types::RecurringPrefetchConfiguration
|
768
779
|
attr_accessor stream_id: ::String
|
769
780
|
SENSITIVE: []
|
770
781
|
end
|
@@ -823,6 +834,28 @@ module Aws::MediaTailor
|
|
823
834
|
SENSITIVE: []
|
824
835
|
end
|
825
836
|
|
837
|
+
class RecurringConsumption
|
838
|
+
attr_accessor retrieved_ad_expiration_seconds: ::Integer
|
839
|
+
attr_accessor avail_matching_criteria: ::Array[Types::AvailMatchingCriteria]
|
840
|
+
SENSITIVE: []
|
841
|
+
end
|
842
|
+
|
843
|
+
class RecurringPrefetchConfiguration
|
844
|
+
attr_accessor start_time: ::Time
|
845
|
+
attr_accessor end_time: ::Time
|
846
|
+
attr_accessor recurring_consumption: Types::RecurringConsumption
|
847
|
+
attr_accessor recurring_retrieval: Types::RecurringRetrieval
|
848
|
+
SENSITIVE: []
|
849
|
+
end
|
850
|
+
|
851
|
+
class RecurringRetrieval
|
852
|
+
attr_accessor dynamic_variables: ::Hash[::String, ::String]
|
853
|
+
attr_accessor delay_after_avail_end_seconds: ::Integer
|
854
|
+
attr_accessor traffic_shaping_type: ("RETRIEVAL_WINDOW")
|
855
|
+
attr_accessor traffic_shaping_retrieval_window: Types::TrafficShapingRetrievalWindow
|
856
|
+
SENSITIVE: []
|
857
|
+
end
|
858
|
+
|
826
859
|
class RequestOutputItem
|
827
860
|
attr_accessor dash_playlist_settings: Types::DashPlaylistSettings
|
828
861
|
attr_accessor hls_playlist_settings: Types::HlsPlaylistSettings
|
@@ -953,6 +986,11 @@ module Aws::MediaTailor
|
|
953
986
|
SENSITIVE: []
|
954
987
|
end
|
955
988
|
|
989
|
+
class TrafficShapingRetrievalWindow
|
990
|
+
attr_accessor retrieval_window_duration_seconds: ::Integer
|
991
|
+
SENSITIVE: []
|
992
|
+
end
|
993
|
+
|
956
994
|
class Transition
|
957
995
|
attr_accessor duration_millis: ::Integer
|
958
996
|
attr_accessor relative_position: ("BEFORE_PROGRAM" | "AFTER_PROGRAM")
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-mediatailor
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.98.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-04-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|