aws-sdk-mediatailor 1.56.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a615567d1b1f8c6acc0fbfd00424eaadc759e62b4ec7f5d187482b561220b26e
-  data.tar.gz: 7a88d19a79922466a4bf4ff9117ee8c1df4a37b2f3322549b4358c7378488a35
+  metadata.gz: e34347c618ee547ffc24f5d0645444fcd2b5084928b398a7c82d6855eb28da7f
+  data.tar.gz: cbfb17edac20116d6c8be3b7a717a804c09967cac70e24544db35faee9c72926
 SHA512:
-  metadata.gz: fb92663f9d1d1c4d6e844e15613aa2fe7b296e508720ce136ea730e958d41dd044bf90ff7ff179e4fb0b4662af01c93586f9e5ff69254406a85bd68d45af899b
-  data.tar.gz: 4640ff5ee64b74c6e69308b629c7b55799b8ca3d7e51255d4ca1fc0fd29c3f48cf62cf322d8150565d104bf5216f8cd05f8067b008b8a1fa01e2aa34c0243a63
+  metadata.gz: 2cd34af5fac060cf59f6dc200be063d409a5129265a884b03b969deec0562951482e2d1558a592afb847669526b2ebcf008da9800885819a3d4dcb86acde9bdb
+  data.tar.gz: ec103cd04dc4998a052f24dc3760e980091ce66d4d8e2cc1112a0f48b1253cef17f9a7e476842fa6b3ffc33ea409fbcd95bc3e5291d5505c6abb59a1812d1399

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.57.0 (2022-10-28)
+------------------
+
+* Feature - This release introduces support for SCTE-35 segmentation descriptor messages which can be sent within time signal messages.
+
 1.56.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.56.0
+1.57.0

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

@@ -742,7 +742,7 @@ module Aws::MediaTailor
     #   resp = client.create_program({
     #     ad_breaks: [
     #       {
-    #         message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
+    #         message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
     #         offset_millis: 1,
     #         slate: {
     #           source_location_name: "__string",
@@ -754,6 +754,20 @@ module Aws::MediaTailor
     #           splice_event_id: 1,
     #           unique_program_id: 1,
     #         },
+    #         time_signal_message: {
+    #           segmentation_descriptors: [
+    #             {
+    #               segment_num: 1,
+    #               segmentation_event_id: 1,
+    #               segmentation_type_id: 1,
+    #               segmentation_upid: "String",
+    #               segmentation_upid_type: 1,
+    #               segments_expected: 1,
+    #               sub_segment_num: 1,
+    #               sub_segments_expected: 1,
+    #             },
+    #           ],
+    #         },
     #       },
     #     ],
     #     channel_name: "__string", # required
@@ -775,7 +789,7 @@ module Aws::MediaTailor
     # @example Response structure
     #
     #   resp.ad_breaks #=> Array
-    #   resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT"
+    #   resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
     #   resp.ad_breaks[0].offset_millis #=> Integer
     #   resp.ad_breaks[0].slate.source_location_name #=> String
     #   resp.ad_breaks[0].slate.vod_source_name #=> String
@@ -783,6 +797,15 @@ module Aws::MediaTailor
     #   resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
     #   resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
     #   resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
     #   resp.arn #=> String
     #   resp.channel_name #=> String
     #   resp.creation_time #=> Time
@@ -1342,7 +1365,7 @@ module Aws::MediaTailor
     # @example Response structure
     #
     #   resp.ad_breaks #=> Array
-    #   resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT"
+    #   resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
     #   resp.ad_breaks[0].offset_millis #=> Integer
     #   resp.ad_breaks[0].slate.source_location_name #=> String
     #   resp.ad_breaks[0].slate.vod_source_name #=> String
@@ -1350,6 +1373,15 @@ module Aws::MediaTailor
     #   resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
     #   resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
     #   resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
+    #   resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
     #   resp.arn #=> String
     #   resp.channel_name #=> String
     #   resp.creation_time #=> Time
@@ -2847,7 +2879,7 @@ module Aws::MediaTailor
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-mediatailor'
-      context[:gem_version] = '1.56.0'
+      context[:gem_version] = '1.57.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -84,6 +84,7 @@ module Aws::MediaTailor
     HttpConfiguration = Shapes::StructureShape.new(name: 'HttpConfiguration')
     HttpPackageConfiguration = Shapes::StructureShape.new(name: 'HttpPackageConfiguration')
     HttpPackageConfigurations = Shapes::ListShape.new(name: 'HttpPackageConfigurations')
+    Integer = Shapes::IntegerShape.new(name: 'Integer')
     ListAlertsRequest = Shapes::StructureShape.new(name: 'ListAlertsRequest')
     ListAlertsResponse = Shapes::StructureShape.new(name: 'ListAlertsResponse')
     ListChannelsRequest = Shapes::StructureShape.new(name: 'ListChannelsRequest')
@@ -129,6 +130,8 @@ module Aws::MediaTailor
     ScheduleEntryType = Shapes::StringShape.new(name: 'ScheduleEntryType')
     SecretsManagerAccessTokenConfiguration = Shapes::StructureShape.new(name: 'SecretsManagerAccessTokenConfiguration')
     SegmentDeliveryConfiguration = Shapes::StructureShape.new(name: 'SegmentDeliveryConfiguration')
+    SegmentationDescriptor = Shapes::StructureShape.new(name: 'SegmentationDescriptor')
+    SegmentationDescriptorList = Shapes::ListShape.new(name: 'SegmentationDescriptorList')
     SlateSource = Shapes::StructureShape.new(name: 'SlateSource')
     SourceLocation = Shapes::StructureShape.new(name: 'SourceLocation')
     SpliceInsertMessage = Shapes::StructureShape.new(name: 'SpliceInsertMessage')
@@ -136,8 +139,10 @@ module Aws::MediaTailor
     StartChannelResponse = Shapes::StructureShape.new(name: 'StartChannelResponse')
     StopChannelRequest = Shapes::StructureShape.new(name: 'StopChannelRequest')
     StopChannelResponse = Shapes::StructureShape.new(name: 'StopChannelResponse')
+    String = Shapes::StringShape.new(name: 'String')
     TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
     Tier = Shapes::StringShape.new(name: 'Tier')
+    TimeSignalMessage = Shapes::StructureShape.new(name: 'TimeSignalMessage')
     Transition = Shapes::StructureShape.new(name: 'Transition')
     Type = Shapes::StringShape.new(name: 'Type')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
@@ -180,6 +185,7 @@ module Aws::MediaTailor
     AdBreak.add_member(:offset_millis, Shapes::ShapeRef.new(shape: __long, location_name: "OffsetMillis"))
     AdBreak.add_member(:slate, Shapes::ShapeRef.new(shape: SlateSource, location_name: "Slate"))
     AdBreak.add_member(:splice_insert_message, Shapes::ShapeRef.new(shape: SpliceInsertMessage, location_name: "SpliceInsertMessage"))
+    AdBreak.add_member(:time_signal_message, Shapes::ShapeRef.new(shape: TimeSignalMessage, location_name: "TimeSignalMessage"))
     AdBreak.struct_class = Types::AdBreak
 
     AdMarkerPassthrough.add_member(:enabled, Shapes::ShapeRef.new(shape: __boolean, location_name: "Enabled"))
@@ -756,6 +762,18 @@ module Aws::MediaTailor
     SegmentDeliveryConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: __string, location_name: "Name"))
     SegmentDeliveryConfiguration.struct_class = Types::SegmentDeliveryConfiguration
 
+    SegmentationDescriptor.add_member(:segment_num, Shapes::ShapeRef.new(shape: Integer, location_name: "SegmentNum"))
+    SegmentationDescriptor.add_member(:segmentation_event_id, Shapes::ShapeRef.new(shape: Integer, location_name: "SegmentationEventId"))
+    SegmentationDescriptor.add_member(:segmentation_type_id, Shapes::ShapeRef.new(shape: Integer, location_name: "SegmentationTypeId"))
+    SegmentationDescriptor.add_member(:segmentation_upid, Shapes::ShapeRef.new(shape: String, location_name: "SegmentationUpid"))
+    SegmentationDescriptor.add_member(:segmentation_upid_type, Shapes::ShapeRef.new(shape: Integer, location_name: "SegmentationUpidType"))
+    SegmentationDescriptor.add_member(:segments_expected, Shapes::ShapeRef.new(shape: Integer, location_name: "SegmentsExpected"))
+    SegmentationDescriptor.add_member(:sub_segment_num, Shapes::ShapeRef.new(shape: Integer, location_name: "SubSegmentNum"))
+    SegmentationDescriptor.add_member(:sub_segments_expected, Shapes::ShapeRef.new(shape: Integer, location_name: "SubSegmentsExpected"))
+    SegmentationDescriptor.struct_class = Types::SegmentationDescriptor
+
+    SegmentationDescriptorList.member = Shapes::ShapeRef.new(shape: SegmentationDescriptor)
+
     SlateSource.add_member(:source_location_name, Shapes::ShapeRef.new(shape: __string, location_name: "SourceLocationName"))
     SlateSource.add_member(:vod_source_name, Shapes::ShapeRef.new(shape: __string, location_name: "VodSourceName"))
     SlateSource.struct_class = Types::SlateSource
@@ -791,6 +809,9 @@ module Aws::MediaTailor
     TagResourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: __mapOf__string, required: true, location_name: "tags"))
     TagResourceRequest.struct_class = Types::TagResourceRequest
 
+    TimeSignalMessage.add_member(:segmentation_descriptors, Shapes::ShapeRef.new(shape: SegmentationDescriptorList, location_name: "SegmentationDescriptors"))
+    TimeSignalMessage.struct_class = Types::TimeSignalMessage
+
     Transition.add_member(:duration_millis, Shapes::ShapeRef.new(shape: __long, location_name: "DurationMillis"))
     Transition.add_member(:relative_position, Shapes::ShapeRef.new(shape: RelativePosition, required: true, location_name: "RelativePosition"))
     Transition.add_member(:relative_program, Shapes::ShapeRef.new(shape: __string, location_name: "RelativeProgram"))

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

@@ -72,7 +72,7 @@ module Aws::MediaTailor
     #   data as a hash:
     #
     #       {
-    #         message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
+    #         message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
     #         offset_millis: 1,
     #         slate: {
     #           source_location_name: "__string",
@@ -84,6 +84,20 @@ module Aws::MediaTailor
     #           splice_event_id: 1,
     #           unique_program_id: 1,
     #         },
+    #         time_signal_message: {
+    #           segmentation_descriptors: [
+    #             {
+    #               segment_num: 1,
+    #               segmentation_event_id: 1,
+    #               segmentation_type_id: 1,
+    #               segmentation_upid: "String",
+    #               segmentation_upid_type: 1,
+    #               segments_expected: 1,
+    #               sub_segment_num: 1,
+    #               sub_segments_expected: 1,
+    #             },
+    #           ],
+    #         },
     #       }
     #
     # @!attribute [rw] message_type
@@ -107,13 +121,25 @@ module Aws::MediaTailor
     #   SCTE-35 specficiaiton, section 9.7.3.1.
     #   @return [Types::SpliceInsertMessage]
     #
+    # @!attribute [rw] time_signal_message
+    #   Defines the SCTE-35 `time_signal` message inserted around the ad.
+    #
+    #   Programs on a channel's schedule can be configured with one or more
+    #   ad breaks. You can attach a `splice_insert` SCTE-35 message to the
+    #   ad break. This message provides basic metadata about the ad break.
+    #
+    #   See section 9.7.4 of the 2022 SCTE-35 specification for more
+    #   information.
+    #   @return [Types::TimeSignalMessage]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdBreak AWS API Documentation
     #
     class AdBreak < Struct.new(
       :message_type,
       :offset_millis,
       :slate,
-      :splice_insert_message)
+      :splice_insert_message,
+      :time_signal_message)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -882,7 +908,7 @@ module Aws::MediaTailor
     #       {
     #         ad_breaks: [
     #           {
-    #             message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
+    #             message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
     #             offset_millis: 1,
     #             slate: {
     #               source_location_name: "__string",
@@ -894,6 +920,20 @@ module Aws::MediaTailor
     #               splice_event_id: 1,
     #               unique_program_id: 1,
     #             },
+    #             time_signal_message: {
+    #               segmentation_descriptors: [
+    #                 {
+    #                   segment_num: 1,
+    #                   segmentation_event_id: 1,
+    #                   segmentation_type_id: 1,
+    #                   segmentation_upid: "String",
+    #                   segmentation_upid_type: 1,
+    #                   segments_expected: 1,
+    #                   sub_segment_num: 1,
+    #                   sub_segments_expected: 1,
+    #                 },
+    #               ],
+    #             },
     #           },
     #         ],
     #         channel_name: "__string", # required
@@ -3998,6 +4038,104 @@ module Aws::MediaTailor
       include Aws::Structure
     end
 
+    # The `segmentation_descriptor` message can contain advanced metadata
+    # fields, like content identifiers, to convey a wide range of
+    # information about the ad break. MediaTailor writes the ad metadata in
+    # the egress manifest as part of the `EXT-X-DATERANGE` or `EventStream`
+    # ad marker's SCTE-35 data.
+    #
+    # `segmentation_descriptor` messages must be sent with the `time_signal`
+    # message type.
+    #
+    # See the `segmentation_descriptor()` table of the 2022 SCTE-35
+    # specification for more information.
+    #
+    # @note When making an API call, you may pass SegmentationDescriptor
+    #   data as a hash:
+    #
+    #       {
+    #         segment_num: 1,
+    #         segmentation_event_id: 1,
+    #         segmentation_type_id: 1,
+    #         segmentation_upid: "String",
+    #         segmentation_upid_type: 1,
+    #         segments_expected: 1,
+    #         sub_segment_num: 1,
+    #         sub_segments_expected: 1,
+    #       }
+    #
+    # @!attribute [rw] segment_num
+    #   The segment number to assign to the
+    #   `segmentation_descriptor.segment_num` message, as defined in section
+    #   10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0
+    #   and 256, inclusive. The default value is 0.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] segmentation_event_id
+    #   The Event Identifier to assign to the
+    #   `segmentation_descriptor.segmentation_event_id` message, as defined
+    #   in section 10.3.3.1 of the 2022 SCTE-35 specification. The default
+    #   value is 1.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] segmentation_type_id
+    #   The Type Identifier to assign to the
+    #   `segmentation_descriptor.segmentation_type_id` message, as defined
+    #   in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
+    #   be between 0 and 256, inclusive. The default value is 48.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] segmentation_upid
+    #   The Upid to assign to the
+    #   `segmentation_descriptor.segmentation_upid` message, as defined in
+    #   section 10.3.3.1 of the 2022 SCTE-35 specification. The value must
+    #   be a hexadecimal string containing only the characters 0 though 9
+    #   and A through F. The default value is "" (an empty string).
+    #   @return [String]
+    #
+    # @!attribute [rw] segmentation_upid_type
+    #   The Upid Type to assign to the
+    #   `segmentation_descriptor.segmentation_upid_type` message, as defined
+    #   in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
+    #   be between 0 and 256, inclusive. The default value is 14.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] segments_expected
+    #   The number of segments expected, which is assigned to the
+    #   `segmentation_descriptor.segments_expectedS` message, as defined in
+    #   section 10.3.3.1 of the 2022 SCTE-35 specification Values must be
+    #   between 0 and 256, inclusive. The default value is 0.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] sub_segment_num
+    #   The sub-segment number to assign to the
+    #   `segmentation_descriptor.sub_segment_num` message, as defined in
+    #   section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be
+    #   between 0 and 256, inclusive. The defualt value is null.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] sub_segments_expected
+    #   The number of sub-segments expected, which is assigned to the
+    #   `segmentation_descriptor.sub_segments_expected` message, as defined
+    #   in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
+    #   be between 0 and 256, inclusive. The default value is null.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SegmentationDescriptor AWS API Documentation
+    #
+    class SegmentationDescriptor < Struct.new(
+      :segment_num,
+      :segmentation_event_id,
+      :segmentation_type_id,
+      :segmentation_upid,
+      :segmentation_upid_type,
+      :segments_expected,
+      :sub_segment_num,
+      :sub_segments_expected)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Slate VOD source configuration.
     #
     # @note When making an API call, you may pass SlateSource
@@ -4222,6 +4360,49 @@ module Aws::MediaTailor
       include Aws::Structure
     end
 
+    # The SCTE-35 `time_signal` message can be sent with one or more
+    # `segmentation_descriptor` messages. A `time_signal` message can be
+    # sent only if a single `segmentation_descriptor` message is sent.
+    #
+    # The `time_signal` message contains only the `splice_time` field which
+    # is constructed using a given presentation timestamp. When sending a
+    # `time_signal` message, the `splice_command_type` field in the
+    # `splice_info_section` message is set to 6 (0x06).
+    #
+    # See the `time_signal()` table of the 2022 SCTE-35 specification for
+    # more information.
+    #
+    # @note When making an API call, you may pass TimeSignalMessage
+    #   data as a hash:
+    #
+    #       {
+    #         segmentation_descriptors: [
+    #           {
+    #             segment_num: 1,
+    #             segmentation_event_id: 1,
+    #             segmentation_type_id: 1,
+    #             segmentation_upid: "String",
+    #             segmentation_upid_type: 1,
+    #             segments_expected: 1,
+    #             sub_segment_num: 1,
+    #             sub_segments_expected: 1,
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] segmentation_descriptors
+    #   The configurations for the SCTE-35 `segmentation_descriptor`
+    #   message(s) sent with the `time_signal` message.
+    #   @return [Array<Types::SegmentationDescriptor>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TimeSignalMessage AWS API Documentation
+    #
+    class TimeSignalMessage < Struct.new(
+      :segmentation_descriptors)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Program transition configuration.
     #
     # @note When making an API call, you may pass Transition

data/lib/aws-sdk-mediatailor.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-mediatailor/customizations'
 # @!group service
 module Aws::MediaTailor
 
-  GEM_VERSION = '1.56.0'
+  GEM_VERSION = '1.57.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-mediatailor
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.57.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core