aws-sdk-mediatailor 1.44.0 → 1.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c588a99cdef3a63fced3ff4845c1f091af6649fa43d83fd545252b665c10ef2
-  data.tar.gz: be25bc5a446e42c099c2dc77167f97304d46b4fdfa9b36c5b8fff53ac56d6d16
+  metadata.gz: 2287660945db1611a54e4fc2e71c281639973c55fac7c9ea2880dc0bc01b8719
+  data.tar.gz: 2be453a7cf38ea6e34aa154a4b67a33d484110a3e165f365611791c41fdf8bea
 SHA512:
-  metadata.gz: 8f1bcaf4a66d618519c1f245ec088d566a082c16c77afe5c6243342fa40695cc300800eeb53a5106bee37ca9ab9d0dc68347ee4f0893ec58c2f2f7fef7318d53
-  data.tar.gz: 0f662d0756a89ab1561708faa2dae5d76a58bcabc4eff598d7309bef31753a50526926a4f5151e650a15c5f22e242f2f9dcd22091a49ad1e6331ba9a47079d44
+  metadata.gz: ebf41c90ca9ca1dc7b181d23912a345957dac12b379545167cefb30613ab50633ad4492e827b05e7b414db394eb70b8730f51c02288acbb5821e496383a0f249
+  data.tar.gz: 7129945fa5d364167ef295cb10c513c212220fb89468ad4f7cb30d455fc4d7305c9657db59a959aaa4ac2db6af5ee77befb3cf34bb1342594d685e695fe1b0ad

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.48.0 (2021-11-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.47.0 (2021-10-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.46.0 (2021-10-12)
+------------------
+
+* Feature - MediaTailor now supports ad prefetching.
+
+1.45.0 (2021-09-22)
+------------------
+
+* Feature - This release adds support to configure logs for playback configuration.
+
 1.44.0 (2021-09-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.44.0
+1.48.0

data/lib/aws-sdk-mediatailor/client.rb

@@ -275,6 +275,15 @@ module Aws::MediaTailor
     #     ** Please note ** When response stubbing is enabled, no HTTP
     #     requests are made, and retries are disabled.
     #
+    #   @option options [Boolean] :use_dualstack_endpoint
+    #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
+    #     will be used if available.
+    #
+    #   @option options [Boolean] :use_fips_endpoint
+    #     When set to `true`, fips compatible endpoints will be used if available.
+    #     When a `fips` region is used, the region is normalized and this config
+    #     is set to `true`.
+    #
     #   @option options [Boolean] :validate_params (true)
     #     When `true`, request parameters are validated before
     #     sending the request.
@@ -327,13 +336,60 @@ module Aws::MediaTailor
 
     # @!group API Operations
 
+    # Configures Amazon CloudWatch log settings for a playback
+    # configuration.
+    #
+    # @option params [required, Integer] :percent_enabled
+    #   The percentage of session logs that MediaTailor sends to your
+    #   Cloudwatch Logs account. For example, if your playback configuration
+    #   has 1000 sessions and percentEnabled is set to 60, MediaTailor sends
+    #   logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
+    #   at random which of the playback configuration sessions to send logs
+    #   for. If you want to view logs for a specific session, you can use the
+    #   [debug log mode][1].
+    #
+    #   Valid values: 0 - 100
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html
+    #
+    # @option params [required, String] :playback_configuration_name
+    #   The name of the playback configuration.
+    #
+    # @return [Types::ConfigureLogsForPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ConfigureLogsForPlaybackConfigurationResponse#percent_enabled #percent_enabled} => Integer
+    #   * {Types::ConfigureLogsForPlaybackConfigurationResponse#playback_configuration_name #playback_configuration_name} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.configure_logs_for_playback_configuration({
+    #     percent_enabled: 1, # required
+    #     playback_configuration_name: "__string", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.percent_enabled #=> Integer
+    #   resp.playback_configuration_name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration AWS API Documentation
+    #
+    # @overload configure_logs_for_playback_configuration(params = {})
+    # @param [Hash] params ({})
+    def configure_logs_for_playback_configuration(params = {}, options = {})
+      req = build_request(:configure_logs_for_playback_configuration, params)
+      req.send_request(options)
+    end
+
     # Creates a channel.
     #
     # @option params [required, String] :channel_name
     #
     # @option params [Types::SlateSource] :filler_slate
     #   The slate used to fill gaps between programs in the schedule. You must
-    #   configure filler slate if your channel uses an LINEAR PlaybackMode.
+    #   configure filler slate if your channel uses a LINEAR PlaybackMode.
     #
     # @option params [required, Array<Types::RequestOutputItem>] :outputs
     #   The channel's output properties.
@@ -423,6 +479,92 @@ module Aws::MediaTailor
       req.send_request(options)
     end
 
+    # Creates a new prefetch schedule for the specified playback
+    # configuration.
+    #
+    # @option params [required, Types::PrefetchConsumption] :consumption
+    #   The configuration settings for MediaTailor's *consumption* of the
+    #   prefetched ads from the ad decision server. Each consumption
+    #   configuration contains an end time and an optional start time that
+    #   define the *consumption window*. Prefetch schedules automatically
+    #   expire no earlier than seven days after the end time.
+    #
+    # @option params [required, String] :name
+    #
+    # @option params [required, String] :playback_configuration_name
+    #
+    # @option params [required, Types::PrefetchRetrieval] :retrieval
+    #   The configuration settings for retrieval of prefetched ads from the ad
+    #   decision server. Only one set of prefetched ads will be retrieved and
+    #   subsequently consumed for each ad break.
+    #
+    # @option params [String] :stream_id
+    #   An optional stream identifier that MediaTailor uses to prefetch ads
+    #   for multiple streams that use the same playback configuration. If
+    #   StreamId is specified, MediaTailor returns all of the prefetch
+    #   schedules with an exact match on StreamId. If not specified,
+    #   MediaTailor returns all of the prefetch schedules for the playback
+    #   configuration, regardless of StreamId.
+    #
+    # @return [Types::CreatePrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreatePrefetchScheduleResponse#arn #arn} => String
+    #   * {Types::CreatePrefetchScheduleResponse#consumption #consumption} => Types::PrefetchConsumption
+    #   * {Types::CreatePrefetchScheduleResponse#name #name} => String
+    #   * {Types::CreatePrefetchScheduleResponse#playback_configuration_name #playback_configuration_name} => String
+    #   * {Types::CreatePrefetchScheduleResponse#retrieval #retrieval} => Types::PrefetchRetrieval
+    #   * {Types::CreatePrefetchScheduleResponse#stream_id #stream_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_prefetch_schedule({
+    #     consumption: { # required
+    #       avail_matching_criteria: [
+    #         {
+    #           dynamic_variable: "__string", # required
+    #           operator: "EQUALS", # required, accepts EQUALS
+    #         },
+    #       ],
+    #       end_time: Time.now, # required
+    #       start_time: Time.now,
+    #     },
+    #     name: "__string", # required
+    #     playback_configuration_name: "__string", # required
+    #     retrieval: { # required
+    #       dynamic_variables: {
+    #         "__string" => "__string",
+    #       },
+    #       end_time: Time.now, # required
+    #       start_time: Time.now,
+    #     },
+    #     stream_id: "__string",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.arn #=> String
+    #   resp.consumption.avail_matching_criteria #=> Array
+    #   resp.consumption.avail_matching_criteria[0].dynamic_variable #=> String
+    #   resp.consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
+    #   resp.consumption.end_time #=> Time
+    #   resp.consumption.start_time #=> Time
+    #   resp.name #=> String
+    #   resp.playback_configuration_name #=> String
+    #   resp.retrieval.dynamic_variables #=> Hash
+    #   resp.retrieval.dynamic_variables["__string"] #=> String
+    #   resp.retrieval.end_time #=> Time
+    #   resp.retrieval.start_time #=> Time
+    #   resp.stream_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchSchedule AWS API Documentation
+    #
+    # @overload create_prefetch_schedule(params = {})
+    # @param [Hash] params ({})
+    def create_prefetch_schedule(params = {}, options = {})
+      req = build_request(:create_prefetch_schedule, params)
+      req.send_request(options)
+    end
+
     # Creates a program.
     #
     # @option params [Array<Types::AdBreak>] :ad_breaks
@@ -713,6 +855,32 @@ module Aws::MediaTailor
       req.send_request(options)
     end
 
+    # Deletes a prefetch schedule for a specific playback configuration. If
+    # you call DeletePrefetchSchedule on an expired prefetch schedule,
+    # MediaTailor returns an HTTP 404 status code.
+    #
+    # @option params [required, String] :name
+    #
+    # @option params [required, String] :playback_configuration_name
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_prefetch_schedule({
+    #     name: "__string", # required
+    #     playback_configuration_name: "__string", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchSchedule AWS API Documentation
+    #
+    # @overload delete_prefetch_schedule(params = {})
+    # @param [Hash] params ({})
+    def delete_prefetch_schedule(params = {}, options = {})
+      req = build_request(:delete_prefetch_schedule, params)
+      req.send_request(options)
+    end
+
     # Deletes a specific program on a specific channel.
     #
     # @option params [required, String] :channel_name
@@ -1073,6 +1241,7 @@ module Aws::MediaTailor
     #   * {Types::GetPlaybackConfigurationResponse#dash_configuration #dash_configuration} => Types::DashConfiguration
     #   * {Types::GetPlaybackConfigurationResponse#hls_configuration #hls_configuration} => Types::HlsConfiguration
     #   * {Types::GetPlaybackConfigurationResponse#live_pre_roll_configuration #live_pre_roll_configuration} => Types::LivePreRollConfiguration
+    #   * {Types::GetPlaybackConfigurationResponse#log_configuration #log_configuration} => Types::LogConfiguration
     #   * {Types::GetPlaybackConfigurationResponse#manifest_processing_rules #manifest_processing_rules} => Types::ManifestProcessingRules
     #   * {Types::GetPlaybackConfigurationResponse#name #name} => String
     #   * {Types::GetPlaybackConfigurationResponse#personalization_threshold_seconds #personalization_threshold_seconds} => Integer
@@ -1108,6 +1277,7 @@ module Aws::MediaTailor
     #   resp.hls_configuration.manifest_endpoint_prefix #=> String
     #   resp.live_pre_roll_configuration.ad_decision_server_url #=> String
     #   resp.live_pre_roll_configuration.max_duration_seconds #=> Integer
+    #   resp.log_configuration.percent_enabled #=> Integer
     #   resp.manifest_processing_rules.ad_marker_passthrough.enabled #=> Boolean
     #   resp.name #=> String
     #   resp.personalization_threshold_seconds #=> Integer
@@ -1129,6 +1299,55 @@ module Aws::MediaTailor
       req.send_request(options)
     end
 
+    # Returns information about the prefetch schedule for a specific
+    # playback configuration. If you call GetPrefetchSchedule on an expired
+    # prefetch schedule, MediaTailor returns an HTTP 404 status code.
+    #
+    # @option params [required, String] :name
+    #
+    # @option params [required, String] :playback_configuration_name
+    #
+    # @return [Types::GetPrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetPrefetchScheduleResponse#arn #arn} => String
+    #   * {Types::GetPrefetchScheduleResponse#consumption #consumption} => Types::PrefetchConsumption
+    #   * {Types::GetPrefetchScheduleResponse#name #name} => String
+    #   * {Types::GetPrefetchScheduleResponse#playback_configuration_name #playback_configuration_name} => String
+    #   * {Types::GetPrefetchScheduleResponse#retrieval #retrieval} => Types::PrefetchRetrieval
+    #   * {Types::GetPrefetchScheduleResponse#stream_id #stream_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_prefetch_schedule({
+    #     name: "__string", # required
+    #     playback_configuration_name: "__string", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.arn #=> String
+    #   resp.consumption.avail_matching_criteria #=> Array
+    #   resp.consumption.avail_matching_criteria[0].dynamic_variable #=> String
+    #   resp.consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
+    #   resp.consumption.end_time #=> Time
+    #   resp.consumption.start_time #=> Time
+    #   resp.name #=> String
+    #   resp.playback_configuration_name #=> String
+    #   resp.retrieval.dynamic_variables #=> Hash
+    #   resp.retrieval.dynamic_variables["__string"] #=> String
+    #   resp.retrieval.end_time #=> Time
+    #   resp.retrieval.start_time #=> Time
+    #   resp.stream_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchSchedule AWS API Documentation
+    #
+    # @overload get_prefetch_schedule(params = {})
+    # @param [Hash] params ({})
+    def get_prefetch_schedule(params = {}, options = {})
+      req = build_request(:get_prefetch_schedule, params)
+      req.send_request(options)
+    end
+
     # Returns a list of alerts for the given resource.
     #
     # @option params [Integer] :max_results
@@ -1269,6 +1488,7 @@ module Aws::MediaTailor
     #   resp.items[0].hls_configuration.manifest_endpoint_prefix #=> String
     #   resp.items[0].live_pre_roll_configuration.ad_decision_server_url #=> String
     #   resp.items[0].live_pre_roll_configuration.max_duration_seconds #=> Integer
+    #   resp.items[0].log_configuration.percent_enabled #=> Integer
     #   resp.items[0].manifest_processing_rules.ad_marker_passthrough.enabled #=> Boolean
     #   resp.items[0].name #=> String
     #   resp.items[0].personalization_threshold_seconds #=> Integer
@@ -1291,6 +1511,77 @@ module Aws::MediaTailor
       req.send_request(options)
     end
 
+    # Creates a new prefetch schedule.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of prefetch schedules that you want MediaTailor to
+    #   return in response to the current request. If the playback
+    #   configuration has more than MaxResults prefetch schedules, use the
+    #   value of NextToken in the response to get the next page of results.
+    #
+    # @option params [String] :next_token
+    #   (Optional) If the playback configuration has more than MaxResults
+    #   prefetch schedules, use NextToken to get the second and subsequent
+    #   pages of results.
+    #
+    #   For the first ListPrefetchSchedulesRequest request, omit this value.
+    #
+    #   For the second and subsequent requests, get the value of NextToken
+    #   from the previous response and specify that value for NextToken in the
+    #   request.
+    #
+    #   If the previous response didn't include a NextToken element, there
+    #   are no more prefetch schedules to get.
+    #
+    # @option params [required, String] :playback_configuration_name
+    #
+    # @option params [String] :stream_id
+    #   An optional filtering parameter whereby MediaTailor filters the
+    #   prefetch schedules to include only specific streams.
+    #
+    # @return [Types::ListPrefetchSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListPrefetchSchedulesResponse#items #items} => Array&lt;Types::PrefetchSchedule&gt;
+    #   * {Types::ListPrefetchSchedulesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_prefetch_schedules({
+    #     max_results: 1,
+    #     next_token: "__string",
+    #     playback_configuration_name: "__string", # required
+    #     stream_id: "__string",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.items #=> Array
+    #   resp.items[0].arn #=> String
+    #   resp.items[0].consumption.avail_matching_criteria #=> Array
+    #   resp.items[0].consumption.avail_matching_criteria[0].dynamic_variable #=> String
+    #   resp.items[0].consumption.avail_matching_criteria[0].operator #=> String, one of "EQUALS"
+    #   resp.items[0].consumption.end_time #=> Time
+    #   resp.items[0].consumption.start_time #=> Time
+    #   resp.items[0].name #=> String
+    #   resp.items[0].playback_configuration_name #=> String
+    #   resp.items[0].retrieval.dynamic_variables #=> Hash
+    #   resp.items[0].retrieval.dynamic_variables["__string"] #=> String
+    #   resp.items[0].retrieval.end_time #=> Time
+    #   resp.items[0].retrieval.start_time #=> Time
+    #   resp.items[0].stream_id #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPrefetchSchedules AWS API Documentation
+    #
+    # @overload list_prefetch_schedules(params = {})
+    # @param [Hash] params ({})
+    def list_prefetch_schedules(params = {}, options = {})
+      req = build_request(:list_prefetch_schedules, params)
+      req.send_request(options)
+    end
+
     # Retrieves a list of source locations.
     #
     # @option params [Integer] :max_results
@@ -1539,6 +1830,7 @@ module Aws::MediaTailor
     #   * {Types::PutPlaybackConfigurationResponse#dash_configuration #dash_configuration} => Types::DashConfiguration
     #   * {Types::PutPlaybackConfigurationResponse#hls_configuration #hls_configuration} => Types::HlsConfiguration
     #   * {Types::PutPlaybackConfigurationResponse#live_pre_roll_configuration #live_pre_roll_configuration} => Types::LivePreRollConfiguration
+    #   * {Types::PutPlaybackConfigurationResponse#log_configuration #log_configuration} => Types::LogConfiguration
     #   * {Types::PutPlaybackConfigurationResponse#manifest_processing_rules #manifest_processing_rules} => Types::ManifestProcessingRules
     #   * {Types::PutPlaybackConfigurationResponse#name #name} => String
     #   * {Types::PutPlaybackConfigurationResponse#personalization_threshold_seconds #personalization_threshold_seconds} => Integer
@@ -1612,6 +1904,7 @@ module Aws::MediaTailor
     #   resp.hls_configuration.manifest_endpoint_prefix #=> String
     #   resp.live_pre_roll_configuration.ad_decision_server_url #=> String
     #   resp.live_pre_roll_configuration.max_duration_seconds #=> Integer
+    #   resp.log_configuration.percent_enabled #=> Integer
     #   resp.manifest_processing_rules.ad_marker_passthrough.enabled #=> Boolean
     #   resp.name #=> String
     #   resp.personalization_threshold_seconds #=> Integer
@@ -1937,7 +2230,7 @@ module Aws::MediaTailor
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-mediatailor'
-      context[:gem_version] = '1.44.0'
+      context[:gem_version] = '1.48.0'
       Seahorse::Client::Request.new(handlers, context)
     end