aws-sdk-ivs 1.96.0 → 1.98.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 505ef32d592c9aaac4eca6d1d3ade5b4643fa1fba9429ef90af1c9b7022051d4
-  data.tar.gz: 7552c4273cde925f71cc24a01ab70ad3ffa6da3b879cc289327e02392266d909
+  metadata.gz: 93b0d51e43adca83f91a3f05d4614abef5bb67d1e6bbe235bf538f4326b5a7ca
+  data.tar.gz: ddbe937fed869b93d5efb7203d7bfb8e11bacee2bdac31ecd3578aea189fad97
 SHA512:
-  metadata.gz: 3612371f3aa5a08ac3e4d771c8efa888e1fb477f9691dab0fdb49394c17ee54712aa5d00b27a22c1179cf9b97d19a19005f9a36a0d965b543b14688a8e5f782a
-  data.tar.gz: 3d88787d6d41cec7ea54e7269558ca5ea6614f7cff3611102f47838e3b41d110c46ec3903ebdf09e94ae9647c2fba3859a6b9ac2e23a9dfeb8933884c1c7590c
+  metadata.gz: '0948c4a829e1470998ab742072cfaa99fc9d4064f8d5818930eb882db517548283edea0410e96bf29eb5399ed103c2effba4acd12268a43f47925c35d74e1c01'
+  data.tar.gz: efa45a060d4596765104910894a5a6e6fd19c499fecf58d76b9fdf020b96a797295b0d4ff9e3be0824de2a7d258be542f57178964f84b8430a96f38772b7c8a0

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.98.0 (2026-10-28)
+------------------
+
+* Feature - InsertAdBreak now allows setting a customized adBreakId on a request and also adds a new field targetStartAt for a delayed ad insertion
+
+1.97.0 (2026-10-26)
+------------------
+
+* Feature - The release adds failover slate configurations, which show viewers a slate during temporary broadcaster network disruptions to reduce viewer drop-off and refresh storms.
+
 1.96.0 (2026-10-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.96.0
+1.98.0

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

@@ -534,6 +534,7 @@ module Aws::IVS
     #   resp.channels[0].multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
     #   resp.channels[0].container_format #=> String, one of "TS", "FRAGMENTED_MP4"
     #   resp.channels[0].ad_configuration_arn #=> String
+    #   resp.channels[0].failover_slate_configuration_arn #=> String
     #   resp.errors #=> Array
     #   resp.errors[0].arn #=> String
     #   resp.errors[0].code #=> String
@@ -797,6 +798,11 @@ module Aws::IVS
     # @option params [String] :ad_configuration_arn
     #   ARN of the ad configuration associated with the channel.
     #
+    # @option params [String] :failover_slate_configuration_arn
+    #   Failover-slate-configuration ARN. A valid ARN value here both
+    #   specifies the ARN and enables failover slate. Default: "" (empty
+    #   string, no failover slate configuration is applied).
+    #
     # @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateChannelResponse#channel #channel} => Types::Channel
@@ -823,6 +829,7 @@ module Aws::IVS
     #     },
     #     container_format: "TS", # accepts TS, FRAGMENTED_MP4
     #     ad_configuration_arn: "ChannelAdConfigurationArn",
+    #     failover_slate_configuration_arn: "ChannelFailoverSlateConfigurationArn",
     #   })
     #
     # @example Response structure
@@ -847,6 +854,7 @@ module Aws::IVS
     #   resp.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
     #   resp.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
     #   resp.channel.ad_configuration_arn #=> String
+    #   resp.channel.failover_slate_configuration_arn #=> String
     #   resp.stream_key.arn #=> String
     #   resp.stream_key.value #=> String
     #   resp.stream_key.channel_arn #=> String
@@ -862,6 +870,71 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Creates a new failover slate configuration.
+    #
+    # @option params [String] :name
+    #   Failover-slate-configuration name. The value does not need to be
+    #   unique.
+    #
+    # @option params [Integer] :activation_threshold_seconds
+    #   Number of seconds of ingest interruption before the failover slate
+    #   activates. Default: `3`.
+    #
+    # @option params [Integer] :min_slate_display_seconds
+    #   Minimum number of seconds that the failover slate displays after
+    #   activation. Default: `3`.
+    #
+    # @option params [Integer] :max_slate_display_seconds
+    #   Maximum number of seconds that the failover slate displays. Default:
+    #   `60`.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   Array of 1-50 maps, each of the form `string:string (key:value)`. See
+    #   [Best practices and strategies][1] in *Tagging Amazon Web Services
+    #   Resources and Tag Editor* for details, including restrictions that
+    #   apply to tags and "Tag naming limits and requirements"; Amazon IVS
+    #   has no service-specific constraints beyond what is documented there.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
+    #
+    # @return [Types::CreateFailoverSlateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateFailoverSlateConfigurationResponse#failover_slate_configuration #failover_slate_configuration} => Types::FailoverSlateConfiguration
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_failover_slate_configuration({
+    #     name: "FailoverSlateConfigurationName",
+    #     activation_threshold_seconds: 1,
+    #     min_slate_display_seconds: 1,
+    #     max_slate_display_seconds: 1,
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.failover_slate_configuration.arn #=> String
+    #   resp.failover_slate_configuration.name #=> String
+    #   resp.failover_slate_configuration.activation_threshold_seconds #=> Integer
+    #   resp.failover_slate_configuration.min_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configuration.max_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "CREATED", "UPDATING"
+    #   resp.failover_slate_configuration.tags #=> Hash
+    #   resp.failover_slate_configuration.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateFailoverSlateConfiguration AWS API Documentation
+    #
+    # @overload create_failover_slate_configuration(params = {})
+    # @param [Hash] params ({})
+    def create_failover_slate_configuration(params = {}, options = {})
+      req = build_request(:create_failover_slate_configuration, params)
+      req.send_request(options)
+    end
+
     # Creates a new playback restriction policy, for constraining playback
     # by countries and/or origins.
     #
@@ -1151,6 +1224,28 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Deletes the specified failover slate configuration.
+    #
+    # @option params [required, String] :arn
+    #   ARN of the failover slate configuration to be deleted.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_failover_slate_configuration({
+    #     arn: "FailoverSlateConfigurationArn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteFailoverSlateConfiguration AWS API Documentation
+    #
+    # @overload delete_failover_slate_configuration(params = {})
+    # @param [Hash] params ({})
+    def delete_failover_slate_configuration(params = {}, options = {})
+      req = build_request(:delete_failover_slate_configuration, params)
+      req.send_request(options)
+    end
+
     # Deletes a specified authorization key pair. This invalidates future
     # viewer tokens generated using the key pair’s `privateKey`. For more
     # information, see [Setting Up Private Channels][1] in the *Amazon IVS
@@ -1326,6 +1421,7 @@ module Aws::IVS
     #   resp.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
     #   resp.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
     #   resp.channel.ad_configuration_arn #=> String
+    #   resp.channel.failover_slate_configuration_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel AWS API Documentation
     #
@@ -1336,6 +1432,41 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Gets the failover slate configuration for the specified ARN.
+    #
+    # @option params [required, String] :arn
+    #   ARN of the failover slate configuration to be retrieved.
+    #
+    # @return [Types::GetFailoverSlateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetFailoverSlateConfigurationResponse#failover_slate_configuration #failover_slate_configuration} => Types::FailoverSlateConfiguration
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_failover_slate_configuration({
+    #     arn: "FailoverSlateConfigurationArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.failover_slate_configuration.arn #=> String
+    #   resp.failover_slate_configuration.name #=> String
+    #   resp.failover_slate_configuration.activation_threshold_seconds #=> Integer
+    #   resp.failover_slate_configuration.min_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configuration.max_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "CREATED", "UPDATING"
+    #   resp.failover_slate_configuration.tags #=> Hash
+    #   resp.failover_slate_configuration.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetFailoverSlateConfiguration AWS API Documentation
+    #
+    # @overload get_failover_slate_configuration(params = {})
+    # @param [Hash] params ({})
+    def get_failover_slate_configuration(params = {}, options = {})
+      req = build_request(:get_failover_slate_configuration, params)
+      req.send_request(options)
+    end
+
     # Gets a specified playback authorization key pair and returns the `arn`
     # and `fingerprint`. The `privateKey` held by the caller can be used to
     # generate viewer authorization tokens, to grant viewers access to
@@ -1567,6 +1698,7 @@ module Aws::IVS
     #   resp.stream_session.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
     #   resp.stream_session.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
     #   resp.stream_session.channel.ad_configuration_arn #=> String
+    #   resp.stream_session.channel.failover_slate_configuration_arn #=> String
     #   resp.stream_session.ingest_configuration.video.avc_profile #=> String
     #   resp.stream_session.ingest_configuration.video.avc_level #=> String
     #   resp.stream_session.ingest_configuration.video.codec #=> String
@@ -1621,6 +1753,14 @@ module Aws::IVS
     #   resp.stream_session.truncated_events[0].type #=> String
     #   resp.stream_session.truncated_events[0].event_time #=> Time
     #   resp.stream_session.truncated_events[0].code #=> String
+    #   resp.stream_session.failover_slate_configuration.arn #=> String
+    #   resp.stream_session.failover_slate_configuration.name #=> String
+    #   resp.stream_session.failover_slate_configuration.activation_threshold_seconds #=> Integer
+    #   resp.stream_session.failover_slate_configuration.min_slate_display_seconds #=> Integer
+    #   resp.stream_session.failover_slate_configuration.max_slate_display_seconds #=> Integer
+    #   resp.stream_session.failover_slate_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "CREATED", "UPDATING"
+    #   resp.stream_session.failover_slate_configuration.tags #=> Hash
+    #   resp.stream_session.failover_slate_configuration.tags["TagKey"] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession AWS API Documentation
     #
@@ -1709,20 +1849,31 @@ module Aws::IVS
     # @option params [required, Integer] :duration_seconds
     #   Duration of the ad break, in seconds.
     #
+    # @option params [String] :ad_break_id
+    #   Caller-specified unique identifier for the ad break to insert into the
+    #   playlist.
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :target_start_at
+    #   Target time at which the ad break starts.
+    #
     # @return [Types::InsertAdBreakResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::InsertAdBreakResponse#ad_break_id #ad_break_id} => String
+    #   * {Types::InsertAdBreakResponse#target_start_at #target_start_at} => Time
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.insert_ad_break({
     #     channel_arn: "ChannelArn", # required
     #     duration_seconds: 1, # required
+    #     ad_break_id: "AdBreakId",
+    #     target_start_at: Time.now,
     #   })
     #
     # @example Response structure
     #
     #   resp.ad_break_id #=> String
+    #   resp.target_start_at #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/InsertAdBreak AWS API Documentation
     #
@@ -1800,6 +1951,10 @@ module Aws::IVS
     # @option params [String] :filter_by_ad_configuration_arn
     #   Filters the channel list to match the specified ad configuration ARN.
     #
+    # @option params [String] :filter_by_failover_slate_configuration_arn
+    #   Filters the channel list to match the specified
+    #   failover-slate-configuration ARN.
+    #
     # @option params [String] :next_token
     #   The first channel to retrieve. This is used for pagination; see the
     #   `nextToken` response field.
@@ -1821,6 +1976,7 @@ module Aws::IVS
     #     filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
     #     filter_by_playback_restriction_policy_arn: "ChannelPlaybackRestrictionPolicyArn",
     #     filter_by_ad_configuration_arn: "ChannelAdConfigurationArn",
+    #     filter_by_failover_slate_configuration_arn: "ChannelFailoverSlateConfigurationArn",
     #     next_token: "PaginationToken",
     #     max_results: 1,
     #   })
@@ -1840,6 +1996,7 @@ module Aws::IVS
     #   resp.channels[0].preset #=> String, one of "HIGHER_BANDWIDTH_DELIVERY", "CONSTRAINED_BANDWIDTH_DELIVERY"
     #   resp.channels[0].playback_restriction_policy_arn #=> String
     #   resp.channels[0].ad_configuration_arn #=> String
+    #   resp.channels[0].failover_slate_configuration_arn #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannels AWS API Documentation
@@ -1851,6 +2008,54 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Gets summary information about all failover slate configurations in
+    # your account, in the Amazon Web Services region where the API request
+    # is processed.
+    #
+    # @option params [String] :next_token
+    #   The first failover slate configuration to retrieve. This is used for
+    #   pagination; see the `nextToken` response field.
+    #
+    # @option params [Integer] :max_results
+    #   Maximum number of failover slate configurations to return. Default:
+    #   your service quota or 100, whichever is smaller.
+    #
+    # @return [Types::ListFailoverSlateConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListFailoverSlateConfigurationsResponse#failover_slate_configurations #failover_slate_configurations} => Array&lt;Types::FailoverSlateConfigurationSummary&gt;
+    #   * {Types::ListFailoverSlateConfigurationsResponse#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_failover_slate_configurations({
+    #     next_token: "PaginationToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.failover_slate_configurations #=> Array
+    #   resp.failover_slate_configurations[0].arn #=> String
+    #   resp.failover_slate_configurations[0].name #=> String
+    #   resp.failover_slate_configurations[0].activation_threshold_seconds #=> Integer
+    #   resp.failover_slate_configurations[0].min_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configurations[0].max_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "CREATED", "UPDATING"
+    #   resp.failover_slate_configurations[0].tags #=> Hash
+    #   resp.failover_slate_configurations[0].tags["TagKey"] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListFailoverSlateConfigurations AWS API Documentation
+    #
+    # @overload list_failover_slate_configurations(params = {})
+    # @param [Hash] params ({})
+    def list_failover_slate_configurations(params = {}, options = {})
+      req = build_request(:list_failover_slate_configurations, params)
+      req.send_request(options)
+    end
+
     # Gets summary information about playback key pairs. For more
     # information, see [Setting Up Private Channels][1] in the *Amazon IVS
     # User Guide*.
@@ -2467,6 +2672,11 @@ module Aws::IVS
     # @option params [String] :ad_configuration_arn
     #   ARN of the ad configuration associated with the channel.
     #
+    # @option params [String] :failover_slate_configuration_arn
+    #   Failover-slate-configuration ARN. A valid ARN value here both
+    #   specifies the ARN and enables failover slate. If this is set to an
+    #   empty string, failover slate configuration is disabled.
+    #
     # @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateChannelResponse#channel #channel} => Types::Channel
@@ -2490,6 +2700,7 @@ module Aws::IVS
     #     },
     #     container_format: "TS", # accepts TS, FRAGMENTED_MP4
     #     ad_configuration_arn: "ChannelAdConfigurationArn",
+    #     failover_slate_configuration_arn: "ChannelFailoverSlateConfigurationArn",
     #   })
     #
     # @example Response structure
@@ -2514,6 +2725,7 @@ module Aws::IVS
     #   resp.channel.multitrack_input_configuration.maximum_resolution #=> String, one of "SD", "HD", "FULL_HD"
     #   resp.channel.container_format #=> String, one of "TS", "FRAGMENTED_MP4"
     #   resp.channel.ad_configuration_arn #=> String
+    #   resp.channel.failover_slate_configuration_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannel AWS API Documentation
     #
@@ -2524,6 +2736,61 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Updates a specified failover slate configuration.
+    #
+    # @option params [required, String] :arn
+    #   ARN of the failover slate configuration to be updated.
+    #
+    # @option params [String] :name
+    #   Failover-slate-configuration name. The value does not need to be
+    #   unique.
+    #
+    # @option params [Integer] :activation_threshold_seconds
+    #   Number of seconds of ingest interruption before the failover slate
+    #   activates. Default: `3`.
+    #
+    # @option params [Integer] :min_slate_display_seconds
+    #   Minimum number of seconds that the failover slate displays after
+    #   activation. Default: `3`.
+    #
+    # @option params [Integer] :max_slate_display_seconds
+    #   Maximum number of seconds that the failover slate displays. Default:
+    #   `60`.
+    #
+    # @return [Types::UpdateFailoverSlateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateFailoverSlateConfigurationResponse#failover_slate_configuration #failover_slate_configuration} => Types::FailoverSlateConfiguration
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_failover_slate_configuration({
+    #     arn: "FailoverSlateConfigurationArn", # required
+    #     name: "FailoverSlateConfigurationName",
+    #     activation_threshold_seconds: 1,
+    #     min_slate_display_seconds: 1,
+    #     max_slate_display_seconds: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.failover_slate_configuration.arn #=> String
+    #   resp.failover_slate_configuration.name #=> String
+    #   resp.failover_slate_configuration.activation_threshold_seconds #=> Integer
+    #   resp.failover_slate_configuration.min_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configuration.max_slate_display_seconds #=> Integer
+    #   resp.failover_slate_configuration.state #=> String, one of "CREATING", "CREATE_FAILED", "CREATED", "UPDATING"
+    #   resp.failover_slate_configuration.tags #=> Hash
+    #   resp.failover_slate_configuration.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateFailoverSlateConfiguration AWS API Documentation
+    #
+    # @overload update_failover_slate_configuration(params = {})
+    # @param [Hash] params ({})
+    def update_failover_slate_configuration(params = {}, options = {})
+      req = build_request(:update_failover_slate_configuration, params)
+      req.send_request(options)
+    end
+
     # Updates a specified playback restriction policy.
     #
     # @option params [required, String] :arn
@@ -2609,7 +2876,7 @@ module Aws::IVS
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-ivs'
-      context[:gem_version] = '1.96.0'
+      context[:gem_version] = '1.98.0'
       Seahorse::Client::Request.new(handlers, context)
     end