aws-sdk-mediatailor 1.96.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.
@@ -172,12 +172,12 @@ module Aws::MediaTailor
172
172
  # that MediaTailor must transcode the ads. `NONE` indicates that you
173
173
  # have already transcoded the ads outside of MediaTailor and don't
174
174
  # need them transcoded as part of the ad insertion workflow. For more
175
- # information about ad conditioning see
176
- # [https://docs.aws.amazon.com/precondition-ads.html][1].
175
+ # information about ad conditioning see [Using preconditioned ads][1]
176
+ # in the Elemental MediaTailor user guide.
177
177
  #
178
178
  #
179
179
  #
180
- # [1]: https://docs.aws.amazon.com/precondition-ads.html
180
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html
181
181
  # @return [String]
182
182
  #
183
183
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdConditioningConfiguration AWS API Documentation
@@ -209,6 +209,37 @@ module Aws::MediaTailor
209
209
  include Aws::Structure
210
210
  end
211
211
 
212
+ # Settings for customizing what events are included in logs for
213
+ # interactions with the ad decision server (ADS).
214
+ #
215
+ # For more information about ADS logs, inlcuding descriptions of the
216
+ # event types, see [MediaTailor ADS logs description and event types][1]
217
+ # in Elemental MediaTailor User Guide.
218
+ #
219
+ #
220
+ #
221
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html
222
+ #
223
+ # @!attribute [rw] publish_opt_in_event_types
224
+ # Indicates that MediaTailor emits `RAW_ADS_RESPONSE` logs for
225
+ # playback sessions that are initialized with this configuration.
226
+ # @return [Array<String>]
227
+ #
228
+ # @!attribute [rw] exclude_event_types
229
+ # Indicates that MediaTailor won't emit the selected events in the
230
+ # logs for playback sessions that are initialized with this
231
+ # configuration.
232
+ # @return [Array<String>]
233
+ #
234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdsInteractionLog AWS API Documentation
235
+ #
236
+ class AdsInteractionLog < Struct.new(
237
+ :publish_opt_in_event_types,
238
+ :exclude_event_types)
239
+ SENSITIVE = []
240
+ include Aws::Structure
241
+ end
242
+
212
243
  # Alert configuration parameters.
213
244
  #
214
245
  # @!attribute [rw] alert_code
@@ -668,12 +699,24 @@ module Aws::MediaTailor
668
699
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-vended-logs-permissions-V2
669
700
  # @return [Array<String>]
670
701
  #
702
+ # @!attribute [rw] ads_interaction_log
703
+ # The event types that MediaTailor emits in logs for interactions with
704
+ # the ADS.
705
+ # @return [Types::AdsInteractionLog]
706
+ #
707
+ # @!attribute [rw] manifest_service_interaction_log
708
+ # The event types that MediaTailor emits in logs for interactions with
709
+ # the origin server.
710
+ # @return [Types::ManifestServiceInteractionLog]
711
+ #
671
712
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfigurationRequest AWS API Documentation
672
713
  #
673
714
  class ConfigureLogsForPlaybackConfigurationRequest < Struct.new(
674
715
  :percent_enabled,
675
716
  :playback_configuration_name,
676
- :enabled_logging_strategies)
717
+ :enabled_logging_strategies,
718
+ :ads_interaction_log,
719
+ :manifest_service_interaction_log)
677
720
  SENSITIVE = []
678
721
  include Aws::Structure
679
722
  end
@@ -696,12 +739,24 @@ module Aws::MediaTailor
696
739
  # Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
697
740
  # @return [Array<String>]
698
741
  #
742
+ # @!attribute [rw] ads_interaction_log
743
+ # The event types that MediaTailor emits in logs for interactions with
744
+ # the ADS.
745
+ # @return [Types::AdsInteractionLog]
746
+ #
747
+ # @!attribute [rw] manifest_service_interaction_log
748
+ # The event types that MediaTailor emits in logs for interactions with
749
+ # the origin server.
750
+ # @return [Types::ManifestServiceInteractionLog]
751
+ #
699
752
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfigurationResponse AWS API Documentation
700
753
  #
701
754
  class ConfigureLogsForPlaybackConfigurationResponse < Struct.new(
702
755
  :percent_enabled,
703
756
  :playback_configuration_name,
704
- :enabled_logging_strategies)
757
+ :enabled_logging_strategies,
758
+ :ads_interaction_log,
759
+ :manifest_service_interaction_log)
705
760
  SENSITIVE = []
706
761
  include Aws::Structure
707
762
  end
@@ -932,11 +987,12 @@ module Aws::MediaTailor
932
987
  end
933
988
 
934
989
  # @!attribute [rw] consumption
935
- # The configuration settings for MediaTailor's *consumption* of the
936
- # prefetched ads from the ad decision server. Each consumption
937
- # configuration contains an end time and an optional start time that
938
- # define the *consumption window*. Prefetch schedules automatically
939
- # expire no earlier than seven days after the end time.
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.
940
996
  # @return [Types::PrefetchConsumption]
941
997
  #
942
998
  # @!attribute [rw] name
@@ -953,6 +1009,25 @@ module Aws::MediaTailor
953
1009
  # and subsequently consumed for each ad break.
954
1010
  # @return [Types::PrefetchRetrieval]
955
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
+ #
956
1031
  # @!attribute [rw] stream_id
957
1032
  # An optional stream identifier that MediaTailor uses to prefetch ads
958
1033
  # for multiple streams that use the same playback configuration. If
@@ -969,6 +1044,8 @@ module Aws::MediaTailor
969
1044
  :name,
970
1045
  :playback_configuration_name,
971
1046
  :retrieval,
1047
+ :recurring_prefetch_configuration,
1048
+ :schedule_type,
972
1049
  :stream_id)
973
1050
  SENSITIVE = []
974
1051
  include Aws::Structure
@@ -979,11 +1056,12 @@ module Aws::MediaTailor
979
1056
  # @return [String]
980
1057
  #
981
1058
  # @!attribute [rw] consumption
982
- # The configuration settings for MediaTailor's *consumption* of the
983
- # prefetched ads from the ad decision server. Each consumption
984
- # configuration contains an end time and an optional start time that
985
- # define the *consumption window*. Prefetch schedules automatically
986
- # expire no earlier than seven days after the end time.
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.
987
1065
  # @return [Types::PrefetchConsumption]
988
1066
  #
989
1067
  # @!attribute [rw] name
@@ -1000,6 +1078,18 @@ module Aws::MediaTailor
1000
1078
  # and subsequently consumed for each ad break.
1001
1079
  # @return [Types::PrefetchRetrieval]
1002
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
+ #
1003
1093
  # @!attribute [rw] stream_id
1004
1094
  # An optional stream identifier that MediaTailor uses to prefetch ads
1005
1095
  # for multiple streams that use the same playback configuration. If
@@ -1017,6 +1107,8 @@ module Aws::MediaTailor
1017
1107
  :name,
1018
1108
  :playback_configuration_name,
1019
1109
  :retrieval,
1110
+ :recurring_prefetch_configuration,
1111
+ :schedule_type,
1020
1112
  :stream_id)
1021
1113
  SENSITIVE = []
1022
1114
  include Aws::Structure
@@ -2303,11 +2395,12 @@ module Aws::MediaTailor
2303
2395
  # @return [String]
2304
2396
  #
2305
2397
  # @!attribute [rw] consumption
2306
- # Consumption settings determine how, and when, MediaTailor places the
2307
- # prefetched ads into ad breaks. Ad consumption occurs within a span
2308
- # of time that you define, called a *consumption window*. You can
2309
- # designate which ad breaks that MediaTailor fills with prefetch ads
2310
- # by setting avail matching criteria.
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.
2311
2404
  # @return [Types::PrefetchConsumption]
2312
2405
  #
2313
2406
  # @!attribute [rw] name
@@ -2326,6 +2419,18 @@ module Aws::MediaTailor
2326
2419
  # the ad decision server (ADS).
2327
2420
  # @return [Types::PrefetchRetrieval]
2328
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
+ #
2329
2434
  # @!attribute [rw] stream_id
2330
2435
  # An optional stream identifier that you can specify in order to
2331
2436
  # prefetch for multiple streams that use the same playback
@@ -2340,6 +2445,8 @@ module Aws::MediaTailor
2340
2445
  :name,
2341
2446
  :playback_configuration_name,
2342
2447
  :retrieval,
2448
+ :schedule_type,
2449
+ :recurring_prefetch_configuration,
2343
2450
  :stream_id)
2344
2451
  SENSITIVE = []
2345
2452
  include Aws::Structure
@@ -2658,6 +2765,14 @@ module Aws::MediaTailor
2658
2765
  # configuration.
2659
2766
  # @return [String]
2660
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
+ #
2661
2776
  # @!attribute [rw] stream_id
2662
2777
  # An optional filtering parameter whereby MediaTailor filters the
2663
2778
  # prefetch schedules to include only specific streams.
@@ -2669,6 +2784,7 @@ module Aws::MediaTailor
2669
2784
  :max_results,
2670
2785
  :next_token,
2671
2786
  :playback_configuration_name,
2787
+ :schedule_type,
2672
2788
  :stream_id)
2673
2789
  SENSITIVE = []
2674
2790
  include Aws::Structure
@@ -2919,11 +3035,23 @@ module Aws::MediaTailor
2919
3035
  # Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
2920
3036
  # @return [Array<String>]
2921
3037
  #
3038
+ # @!attribute [rw] ads_interaction_log
3039
+ # Settings for customizing what events are included in logs for
3040
+ # interactions with the ad decision server (ADS).
3041
+ # @return [Types::AdsInteractionLog]
3042
+ #
3043
+ # @!attribute [rw] manifest_service_interaction_log
3044
+ # Settings for customizing what events are included in logs for
3045
+ # interactions with the origin server.
3046
+ # @return [Types::ManifestServiceInteractionLog]
3047
+ #
2922
3048
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LogConfiguration AWS API Documentation
2923
3049
  #
2924
3050
  class LogConfiguration < Struct.new(
2925
3051
  :percent_enabled,
2926
- :enabled_logging_strategies)
3052
+ :enabled_logging_strategies,
3053
+ :ads_interaction_log,
3054
+ :manifest_service_interaction_log)
2927
3055
  SENSITIVE = []
2928
3056
  include Aws::Structure
2929
3057
  end
@@ -2965,6 +3093,31 @@ module Aws::MediaTailor
2965
3093
  include Aws::Structure
2966
3094
  end
2967
3095
 
3096
+ # Settings for customizing what events are included in logs for
3097
+ # interactions with the origin server.
3098
+ #
3099
+ # For more information about manifest service logs, including
3100
+ # descriptions of the event types, see [MediaTailor manifest logs
3101
+ # description and event types][1] in Elemental MediaTailor User Guide.
3102
+ #
3103
+ #
3104
+ #
3105
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/log-types.html
3106
+ #
3107
+ # @!attribute [rw] exclude_event_types
3108
+ # Indicates that MediaTailor won't emit the selected events in the
3109
+ # logs for playback sessions that are initialized with this
3110
+ # configuration.
3111
+ # @return [Array<String>]
3112
+ #
3113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ManifestServiceInteractionLog AWS API Documentation
3114
+ #
3115
+ class ManifestServiceInteractionLog < Struct.new(
3116
+ :exclude_event_types)
3117
+ SENSITIVE = []
3118
+ include Aws::Structure
3119
+ end
3120
+
2968
3121
  # A playback configuration. For information about MediaTailor
2969
3122
  # configurations, see [Working with configurations in AWS Elemental
2970
3123
  # MediaTailor][1].
@@ -3150,8 +3303,8 @@ module Aws::MediaTailor
3150
3303
  include Aws::Structure
3151
3304
  end
3152
3305
 
3153
- # A complex type that contains settings that determine how and when that
3154
- # MediaTailor places prefetched ads into upcoming ad breaks.
3306
+ # For single prefetch, describes how and when that MediaTailor places
3307
+ # prefetched ads into upcoming ad breaks.
3155
3308
  #
3156
3309
  # @!attribute [rw] avail_matching_criteria
3157
3310
  # If you only want MediaTailor to insert prefetched ads into avails
@@ -3214,12 +3367,24 @@ module Aws::MediaTailor
3214
3367
  # prefetch retrieval starts as soon as possible.
3215
3368
  # @return [Time]
3216
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
+ #
3217
3380
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PrefetchRetrieval AWS API Documentation
3218
3381
  #
3219
3382
  class PrefetchRetrieval < Struct.new(
3220
3383
  :dynamic_variables,
3221
3384
  :end_time,
3222
- :start_time)
3385
+ :start_time,
3386
+ :traffic_shaping_type,
3387
+ :traffic_shaping_retrieval_window)
3223
3388
  SENSITIVE = []
3224
3389
  include Aws::Structure
3225
3390
  end
@@ -3239,10 +3404,11 @@ module Aws::MediaTailor
3239
3404
  #
3240
3405
  # @!attribute [rw] consumption
3241
3406
  # Consumption settings determine how, and when, MediaTailor places the
3242
- # prefetched ads into ad breaks. Ad consumption occurs within a span
3243
- # of time that you define, called a *consumption window*. You can
3244
- # designate which ad breaks that MediaTailor fills with prefetch ads
3245
- # by setting avail matching criteria.
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.
3246
3412
  # @return [Types::PrefetchConsumption]
3247
3413
  #
3248
3414
  # @!attribute [rw] name
@@ -3261,6 +3427,25 @@ module Aws::MediaTailor
3261
3427
  # the ad decision server (ADS).
3262
3428
  # @return [Types::PrefetchRetrieval]
3263
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
+ #
3264
3449
  # @!attribute [rw] stream_id
3265
3450
  # An optional stream identifier that you can specify in order to
3266
3451
  # prefetch for multiple streams that use the same playback
@@ -3275,6 +3460,8 @@ module Aws::MediaTailor
3275
3460
  :name,
3276
3461
  :playback_configuration_name,
3277
3462
  :retrieval,
3463
+ :schedule_type,
3464
+ :recurring_prefetch_configuration,
3278
3465
  :stream_id)
3279
3466
  SENSITIVE = []
3280
3467
  include Aws::Structure
@@ -3628,6 +3815,99 @@ module Aws::MediaTailor
3628
3815
  include Aws::Structure
3629
3816
  end
3630
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
+
3631
3911
  # The output configuration for this channel.
3632
3912
  #
3633
3913
  # @!attribute [rw] dash_playlist_settings
@@ -4179,6 +4459,24 @@ module Aws::MediaTailor
4179
4459
  include Aws::Structure
4180
4460
  end
4181
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
+
4182
4480
  # Program transition configuration.
4183
4481
  #
4184
4482
  # @!attribute [rw] duration_millis
@@ -54,7 +54,7 @@ module Aws::MediaTailor
54
54
  autoload :EndpointProvider, 'aws-sdk-mediatailor/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-mediatailor/endpoints'
56
56
 
57
- GEM_VERSION = '1.96.0'
57
+ GEM_VERSION = '1.98.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -94,12 +94,21 @@ module Aws
94
94
  def percent_enabled: () -> ::Integer
95
95
  def playback_configuration_name: () -> ::String
96
96
  def enabled_logging_strategies: () -> ::Array[("VENDED_LOGS" | "LEGACY_CLOUDWATCH")]
97
+ def ads_interaction_log: () -> Types::AdsInteractionLog
98
+ def manifest_service_interaction_log: () -> Types::ManifestServiceInteractionLog
97
99
  end
98
100
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MediaTailor/Client.html#configure_logs_for_playback_configuration-instance_method
99
101
  def configure_logs_for_playback_configuration: (
100
102
  percent_enabled: ::Integer,
101
103
  playback_configuration_name: ::String,
102
- ?enabled_logging_strategies: Array[("VENDED_LOGS" | "LEGACY_CLOUDWATCH")]
104
+ ?enabled_logging_strategies: Array[("VENDED_LOGS" | "LEGACY_CLOUDWATCH")],
105
+ ?ads_interaction_log: {
106
+ publish_opt_in_event_types: Array[("RAW_ADS_RESPONSE")]?,
107
+ exclude_event_types: Array[("AD_MARKER_FOUND" | "NON_AD_MARKER_FOUND" | "MAKING_ADS_REQUEST" | "MODIFIED_TARGET_URL" | "VAST_REDIRECT" | "EMPTY_VAST_RESPONSE" | "EMPTY_VMAP_RESPONSE" | "VAST_RESPONSE" | "REDIRECTED_VAST_RESPONSE" | "FILLED_AVAIL" | "FILLED_OVERLAY_AVAIL" | "BEACON_FIRED" | "WARNING_NO_ADVERTISEMENTS" | "WARNING_VPAID_AD_DROPPED" | "WARNING_URL_VARIABLE_SUBSTITUTION_FAILED" | "ERROR_UNKNOWN" | "ERROR_UNKNOWN_HOST" | "ERROR_DISALLOWED_HOST" | "ERROR_ADS_IO" | "ERROR_ADS_TIMEOUT" | "ERROR_ADS_RESPONSE_PARSE" | "ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT" | "ERROR_ADS_INVALID_RESPONSE" | "ERROR_VAST_REDIRECT_EMPTY_RESPONSE" | "ERROR_VAST_REDIRECT_MULTIPLE_VAST" | "ERROR_VAST_REDIRECT_FAILED" | "ERROR_VAST_MISSING_MEDIAFILES" | "ERROR_VAST_MISSING_CREATIVES" | "ERROR_VAST_MISSING_OVERLAYS" | "ERROR_VAST_MISSING_IMPRESSION" | "ERROR_VAST_INVALID_VAST_AD_TAG_URI" | "ERROR_VAST_MULTIPLE_TRACKING_EVENTS" | "ERROR_VAST_MULTIPLE_LINEAR" | "ERROR_VAST_INVALID_MEDIA_FILE" | "ERROR_FIRING_BEACON_FAILED" | "ERROR_PERSONALIZATION_DISABLED" | "VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET" | "VOD_TIME_BASED_AVAIL_PLAN_SUCCESS" | "VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS" | "INTERSTITIAL_VOD_SUCCESS" | "INTERSTITIAL_VOD_FAILURE")]?
108
+ },
109
+ ?manifest_service_interaction_log: {
110
+ exclude_event_types: Array[("GENERATED_MANIFEST" | "ORIGIN_MANIFEST" | "SESSION_INITIALIZED" | "TRACKING_RESPONSE" | "CONFIG_SYNTAX_ERROR" | "CONFIG_SECURITY_ERROR" | "UNKNOWN_HOST" | "TIMEOUT_ERROR" | "CONNECTION_ERROR" | "IO_ERROR" | "UNKNOWN_ERROR" | "HOST_DISALLOWED" | "PARSING_ERROR" | "MANIFEST_ERROR" | "NO_MASTER_OR_MEDIA_PLAYLIST" | "NO_MASTER_PLAYLIST" | "NO_MEDIA_PLAYLIST" | "INCOMPATIBLE_HLS_VERSION" | "SCTE35_PARSING_ERROR" | "INVALID_SINGLE_PERIOD_DASH_MANIFEST" | "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST" | "LAST_PERIOD_MISSING_AUDIO" | "LAST_PERIOD_MISSING_AUDIO_WARNING" | "ERROR_ORIGIN_PREFIX_INTERPOLATION" | "ERROR_ADS_INTERPOLATION" | "ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION" | "ERROR_CDN_AD_SEGMENT_INTERPOLATION" | "ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION" | "ERROR_SLATE_AD_URL_INTERPOLATION" | "ERROR_PROFILE_NAME_INTERPOLATION" | "ERROR_BUMPER_START_INTERPOLATION" | "ERROR_BUMPER_END_INTERPOLATION")]?
111
+ }
103
112
  ) -> _ConfigureLogsForPlaybackConfigurationResponseSuccess
104
113
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConfigureLogsForPlaybackConfigurationResponseSuccess
105
114
 
@@ -183,11 +192,13 @@ module Aws
183
192
  def name: () -> ::String
184
193
  def playback_configuration_name: () -> ::String
185
194
  def retrieval: () -> Types::PrefetchRetrieval
195
+ def recurring_prefetch_configuration: () -> Types::RecurringPrefetchConfiguration
196
+ def schedule_type: () -> ("SINGLE" | "RECURRING")
186
197
  def stream_id: () -> ::String
187
198
  end
188
199
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MediaTailor/Client.html#create_prefetch_schedule-instance_method
189
200
  def create_prefetch_schedule: (
190
- consumption: {
201
+ ?consumption: {
191
202
  avail_matching_criteria: Array[
192
203
  {
193
204
  dynamic_variable: ::String,
@@ -199,11 +210,37 @@ module Aws
199
210
  },
200
211
  name: ::String,
201
212
  playback_configuration_name: ::String,
202
- retrieval: {
213
+ ?retrieval: {
203
214
  dynamic_variables: Hash[::String, ::String]?,
204
215
  end_time: ::Time,
205
- 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
+ }
206
242
  },
243
+ ?schedule_type: ("SINGLE" | "RECURRING"),
207
244
  ?stream_id: ::String
208
245
  ) -> _CreatePrefetchScheduleResponseSuccess
209
246
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePrefetchScheduleResponseSuccess
@@ -635,6 +672,8 @@ module Aws
635
672
  def name: () -> ::String
636
673
  def playback_configuration_name: () -> ::String
637
674
  def retrieval: () -> Types::PrefetchRetrieval
675
+ def schedule_type: () -> ("SINGLE" | "RECURRING")
676
+ def recurring_prefetch_configuration: () -> Types::RecurringPrefetchConfiguration
638
677
  def stream_id: () -> ::String
639
678
  end
640
679
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/MediaTailor/Client.html#get_prefetch_schedule-instance_method
@@ -704,6 +743,7 @@ module Aws
704
743
  ?max_results: ::Integer,
705
744
  ?next_token: ::String,
706
745
  playback_configuration_name: ::String,
746
+ ?schedule_type: ("SINGLE" | "RECURRING" | "ALL"),
707
747
  ?stream_id: ::String
708
748
  ) -> _ListPrefetchSchedulesResponseSuccess
709
749
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPrefetchSchedulesResponseSuccess