aws-sdk-kinesisvideowebrtcstorage 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 211394389d81a37b1a2a9109ac94d910acd41594c96580498d9f4c1761bcaf90
-  data.tar.gz: f6edaae9742f02c84990a95abb66770f9b1222da26967cd7d318563ab34ba264
+  metadata.gz: 30c9c0b511c1731dc410a26304e74e5bf73aef20345e15ad41a670bd3e9f294e
+  data.tar.gz: a19e779a03a04701a8c33844303fb0341b373700df476d604ab4117eb34e2279
 SHA512:
-  metadata.gz: 2d486dd558bc2bd40d8a700f495945d3023e0ce5f8ec29013201e5aa63e229d780108abb2054b4801f658c576c9f589df86839507df3a92e66f5d7ec04fd4d5c
-  data.tar.gz: d1993feb627ec8b81064dd934914835bb5c9ddb62f0f05206ff91c9005230d94105d41da9ab3b9bbb7d51d2203bda83909abec1d1326e70f4b35eef79a51be3f
+  metadata.gz: cfd231aba805986ec45c4af58f58809449f21e076e921b9322fdf306fd5371d2a09b657a3e085102b76c0f5f00fb25b78e6151bf0ad40990e22c955b8abe9190
+  data.tar.gz: 51cfeb6475d9fd37ab9143baae9965875e96add9280c75a926ff21abb22d848d573af7880fd68e21dbdcbef8a73fecdc5099974906c0cc4dfeef480e0a65e96f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.19.0 (2024-08-05)
+------------------
+
+* Feature - Add JoinStorageSessionAsViewer API
+
 1.18.0 (2024-07-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.18.0
+1.19.0

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

@@ -425,6 +425,12 @@ module Aws::KinesisVideoWebRTCStorage
 
     # @!group API Operations
 
+    # <note markdown="1"> Before using this API, you must call the `GetSignalingChannelEndpoint`
+    # API to request the WEBRTC endpoint. You then specify the endpoint and
+    # region in your `JoinStorageSession` API request.
+    #
+    #  </note>
+    #
     # Join the ongoing one way-video and/or multi-way audio WebRTC session
     # as a video producing device for an input channel. If there’s no
     # existing session for the channel, a new streaming session needs to be
@@ -432,17 +438,33 @@ module Aws::KinesisVideoWebRTCStorage
     # must be provided.
     #
     # Currently for the `SINGLE_MASTER` type, a video producing device is
-    # able to ingest both audio and video media into a stream, while viewers
-    # can only ingest audio. Both a video producing device and viewers can
-    # join the session first, and wait for other participants.
+    # able to ingest both audio and video media into a stream. Only video
+    # producing devices can join the session and record media.
     #
-    # While participants are having peer to peer conversations through
-    # webRTC, the ingested media session will be stored into the Kinesis
-    # Video Stream. Multiple viewers are able to playback real-time media.
+    # Both audio and video tracks are currently required for WebRTC
+    # ingestion.
     #
-    # Customers can also use existing Kinesis Video Streams features like
-    # `HLS` or `DASH` playback, Image generation, and more with ingested
-    # WebRTC media.
+    #  Current requirements:
+    #
+    #  * Video track: H.264
+    #
+    # * Audio track: Opus
+    #
+    # The resulting ingested video in the Kinesis video stream will have the
+    # following parameters: H.264 video and AAC audio.
+    #
+    # Once a master participant has negotiated a connection through WebRTC,
+    # the ingested media session will be stored in the Kinesis video stream.
+    # Multiple viewers are then able to play back real-time media through
+    # our Playback APIs.
+    #
+    # You can also use existing Kinesis Video Streams features like `HLS` or
+    # `DASH` playback, image generation via [GetImages][1], and more with
+    # ingested WebRTC media.
+    #
+    # <note markdown="1"> S3 image delivery and notifications are not currently supported.
+    #
+    #  </note>
     #
     # <note markdown="1"> Assume that only one video producing device client can be associated
     # with a session for the channel. If more than one client joins the
@@ -451,6 +473,19 @@ module Aws::KinesisVideoWebRTCStorage
     #
     #  </note>
     #
+    # **Additional information**
+    #
+    # * **Idempotent** - This API is not idempotent.
+    #
+    # * **Retry behavior** - This is counted as a new API call.
+    #
+    # * **Concurrent calls** - Concurrent calls are allowed. An offer is
+    #   sent once per each call.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html
+    #
     # @option params [required, String] :channel_arn
     #   The Amazon Resource Name (ARN) of the signaling channel.
     #
@@ -471,6 +506,50 @@ module Aws::KinesisVideoWebRTCStorage
       req.send_request(options)
     end
 
+    # Join the ongoing one way-video and/or multi-way audio WebRTC session
+    # as a viewer for an input channel. If there’s no existing session for
+    # the channel, create a new streaming session and provide the Amazon
+    # Resource Name (ARN) of the signaling channel (`channelArn`) and client
+    # id (`clientId`).
+    #
+    # Currently for `SINGLE_MASTER` type, a video producing device is able
+    # to ingest both audio and video media into a stream, while viewers can
+    # only ingest audio. Both a video producing device and viewers can join
+    # a session first and wait for other participants. While participants
+    # are having peer to peer conversations through WebRTC, the ingested
+    # media session will be stored into the Kinesis Video Stream. Multiple
+    # viewers are able to playback real-time media.
+    #
+    # Customers can also use existing Kinesis Video Streams features like
+    # `HLS` or `DASH` playback, Image generation, and more with ingested
+    # WebRTC media. If there’s an existing session with the same `clientId`
+    # that's found in the join session request, the new request takes
+    # precedence.
+    #
+    # @option params [required, String] :channel_arn
+    #   The Amazon Resource Name (ARN) of the signaling channel.
+    #
+    # @option params [required, String] :client_id
+    #   The unique identifier for the sender client.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.join_storage_session_as_viewer({
+    #     channel_arn: "ChannelArn", # required
+    #     client_id: "ClientId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewer AWS API Documentation
+    #
+    # @overload join_storage_session_as_viewer(params = {})
+    # @param [Hash] params ({})
+    def join_storage_session_as_viewer(params = {}, options = {})
+      req = build_request(:join_storage_session_as_viewer, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -484,7 +563,7 @@ module Aws::KinesisVideoWebRTCStorage
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesisvideowebrtcstorage'
-      context[:gem_version] = '1.18.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -15,8 +15,10 @@ module Aws::KinesisVideoWebRTCStorage
 
     AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
     ChannelArn = Shapes::StringShape.new(name: 'ChannelArn')
+    ClientId = Shapes::StringShape.new(name: 'ClientId')
     ClientLimitExceededException = Shapes::StructureShape.new(name: 'ClientLimitExceededException')
     InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
+    JoinStorageSessionAsViewerInput = Shapes::StructureShape.new(name: 'JoinStorageSessionAsViewerInput')
     JoinStorageSessionInput = Shapes::StructureShape.new(name: 'JoinStorageSessionInput')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     String = Shapes::StringShape.new(name: 'String')
@@ -30,6 +32,10 @@ module Aws::KinesisVideoWebRTCStorage
     InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
     InvalidArgumentException.struct_class = Types::InvalidArgumentException
 
+    JoinStorageSessionAsViewerInput.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
+    JoinStorageSessionAsViewerInput.add_member(:client_id, Shapes::ShapeRef.new(shape: ClientId, required: true, location_name: "clientId"))
+    JoinStorageSessionAsViewerInput.struct_class = Types::JoinStorageSessionAsViewerInput
+
     JoinStorageSessionInput.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
     JoinStorageSessionInput.struct_class = Types::JoinStorageSessionInput
 
@@ -65,6 +71,18 @@ module Aws::KinesisVideoWebRTCStorage
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
+
+      api.add_operation(:join_storage_session_as_viewer, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "JoinStorageSessionAsViewer"
+        o.http_method = "POST"
+        o.http_request_uri = "/joinStorageSessionAsViewer"
+        o.input = Shapes::ShapeRef.new(shape: JoinStorageSessionAsViewerInput)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: ClientLimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
     end
 
   end

data/lib/aws-sdk-kinesisvideowebrtcstorage/endpoint_provider.rb

@@ -32,7 +32,7 @@ module Aws::KinesisVideoWebRTCStorage
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://kinesisvideo-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

data/lib/aws-sdk-kinesisvideowebrtcstorage/endpoints.rb

@@ -26,5 +26,19 @@ module Aws::KinesisVideoWebRTCStorage
       end
     end
 
+    class JoinStorageSessionAsViewer
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::KinesisVideoWebRTCStorage::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
   end
 end

data/lib/aws-sdk-kinesisvideowebrtcstorage/plugins/endpoints.rb

@@ -60,6 +60,8 @@ module Aws::KinesisVideoWebRTCStorage
           case context.operation_name
           when :join_storage_session
             Aws::KinesisVideoWebRTCStorage::Endpoints::JoinStorageSession.build(context)
+          when :join_storage_session_as_viewer
+            Aws::KinesisVideoWebRTCStorage::Endpoints::JoinStorageSessionAsViewer.build(context)
           end
         end
       end

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

@@ -50,6 +50,23 @@ module Aws::KinesisVideoWebRTCStorage
       include Aws::Structure
     end
 
+    # @!attribute [rw] channel_arn
+    #   The Amazon Resource Name (ARN) of the signaling channel.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_id
+    #   The unique identifier for the sender client.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-video-webrtc-storage-2018-05-10/JoinStorageSessionAsViewerInput AWS API Documentation
+    #
+    class JoinStorageSessionAsViewerInput < Struct.new(
+      :channel_arn,
+      :client_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] channel_arn
     #   The Amazon Resource Name (ARN) of the signaling channel.
     #   @return [String]

data/lib/aws-sdk-kinesisvideowebrtcstorage.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-kinesisvideowebrtcstorage/customizations'
 # @!group service
 module Aws::KinesisVideoWebRTCStorage
 
-  GEM_VERSION = '1.18.0'
+  GEM_VERSION = '1.19.0'
 
 end

data/sig/client.rbs

@@ -78,6 +78,13 @@ module Aws
                                   channel_arn: ::String
                                 ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
                               | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/KinesisVideoWebRTCStorage/Client.html#join_storage_session_as_viewer-instance_method
+      def join_storage_session_as_viewer: (
+                                            channel_arn: ::String,
+                                            client_id: ::String
+                                          ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
+                                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
     end
   end
 end

data/sig/types.rbs

@@ -23,6 +23,12 @@ module Aws::KinesisVideoWebRTCStorage
       SENSITIVE: []
     end
 
+    class JoinStorageSessionAsViewerInput
+      attr_accessor channel_arn: ::String
+      attr_accessor client_id: ::String
+      SENSITIVE: []
+    end
+
     class JoinStorageSessionInput
       attr_accessor channel_arn: ::String
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kinesisvideowebrtcstorage
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core