aws-sdk-ivs 1.32.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7c23774dd3fca9774e3701997a11a48921c839b7c0fbab8718b31b37febee9c
-  data.tar.gz: 52aacb78a5526b3bec6e7e1bbb9b32b5a498ff8f4e525cf65159f0c1e7c1a5b6
+  metadata.gz: 3c4f1161970791665943eac4d74f7733653949b031eef037e88f696e2550eeca
+  data.tar.gz: fb7ec9f5cf9c0d657031d0d205c1ed8d22c2bdf10b9753863571afe2e1fe6eee
 SHA512:
-  metadata.gz: 8d5e12936ba34516a72389b8e860a372cd87d2a34d0bf39bec1826288ac294b4ee7d1eab28b69f9d3dff8413a208b541a3f9fb1e27b319ba5920363daff58ca2
-  data.tar.gz: b88a5f18722db964f746d500b580f72a82dbac3b811f09e6420763fdb28f9bb7f2ef6af8e8f3a64510bfdb3e60a596b8c54c7f97841bfe35a4e1efcede7608b6
+  metadata.gz: d710dca7dc3076c411f3f870cc7f930763e19d7e77059a35b02f7f1935722de2f672e7f67f9764fe53c9149e7ba4d050a0f1c24103aa91a364dd6d61c27f1eb6
+  data.tar.gz: a2e95396e9caa3c2ede116a2ad72c57b75312d47ca8aa940e3cdad5edbc4c5d9a0974e9f32a4bdd24aacf65fb934ccaf9ed2d0f157a77fa9207c33f6d92f94c6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.33.0 (2023-06-27)
+------------------
+
+* Feature - IVS customers can now revoke the viewer session associated with an auth token, to prevent and stop playback using that token.
+
 1.32.0 (2023-06-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.32.0
+1.33.0

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

@@ -456,6 +456,45 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Performs StartViewerSessionRevocation on multiple channel ARN and
+    # viewer ID pairs simultaneously.
+    #
+    # @option params [required, Array<Types::BatchStartViewerSessionRevocationViewerSession>] :viewer_sessions
+    #   Array of viewer sessions, one per channel-ARN and viewer-ID pair.
+    #
+    # @return [Types::BatchStartViewerSessionRevocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchStartViewerSessionRevocationResponse#errors #errors} => Array&lt;Types::BatchStartViewerSessionRevocationError&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_start_viewer_session_revocation({
+    #     viewer_sessions: [ # required
+    #       {
+    #         channel_arn: "ChannelArn", # required
+    #         viewer_id: "ViewerId", # required
+    #         viewer_session_versions_less_than_or_equal_to: 1,
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.errors #=> Array
+    #   resp.errors[0].channel_arn #=> String
+    #   resp.errors[0].code #=> String
+    #   resp.errors[0].message #=> String
+    #   resp.errors[0].viewer_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocation AWS API Documentation
+    #
+    # @overload batch_start_viewer_session_revocation(params = {})
+    # @param [Hash] params ({})
+    def batch_start_viewer_session_revocation(params = {}, options = {})
+      req = build_request(:batch_start_viewer_session_revocation, params)
+      req.send_request(options)
+    end
+
     # Creates a new channel and an associated stream key to start streaming.
     #
     # @option params [Boolean] :authorized
@@ -1526,6 +1565,48 @@ module Aws::IVS
       req.send_request(options)
     end
 
+    # Starts the process of revoking the viewer session associated with a
+    # specified channel ARN and viewer ID. Optionally, you can provide a
+    # version to revoke viewer sessions less than and including that
+    # version. For instructions on associating a viewer ID with a viewer
+    # session, see [Setting Up Private Channels][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html
+    #
+    # @option params [required, String] :channel_arn
+    #   The ARN of the channel associated with the viewer session to revoke.
+    #
+    # @option params [required, String] :viewer_id
+    #   The ID of the viewer associated with the viewer session to revoke. Do
+    #   not use this field for personally identifying, confidential, or
+    #   sensitive information.
+    #
+    # @option params [Integer] :viewer_session_versions_less_than_or_equal_to
+    #   An optional filter on which versions of the viewer session to revoke.
+    #   All versions less than or equal to the specified version will be
+    #   revoked. Default: 0.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_viewer_session_revocation({
+    #     channel_arn: "ChannelArn", # required
+    #     viewer_id: "ViewerId", # required
+    #     viewer_session_versions_less_than_or_equal_to: 1,
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StartViewerSessionRevocation AWS API Documentation
+    #
+    # @overload start_viewer_session_revocation(params = {})
+    # @param [Hash] params ({})
+    def start_viewer_session_revocation(params = {}, options = {})
+      req = build_request(:start_viewer_session_revocation, params)
+      req.send_request(options)
+    end
+
     # Disconnects the incoming RTMPS stream for the specified channel. Can
     # be used in conjunction with DeleteStreamKey to prevent further
     # streaming to a channel.
@@ -1770,7 +1851,7 @@ module Aws::IVS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ivs'
-      context[:gem_version] = '1.32.0'
+      context[:gem_version] = '1.33.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -21,6 +21,12 @@ module Aws::IVS
     BatchGetChannelResponse = Shapes::StructureShape.new(name: 'BatchGetChannelResponse')
     BatchGetStreamKeyRequest = Shapes::StructureShape.new(name: 'BatchGetStreamKeyRequest')
     BatchGetStreamKeyResponse = Shapes::StructureShape.new(name: 'BatchGetStreamKeyResponse')
+    BatchStartViewerSessionRevocationError = Shapes::StructureShape.new(name: 'BatchStartViewerSessionRevocationError')
+    BatchStartViewerSessionRevocationErrors = Shapes::ListShape.new(name: 'BatchStartViewerSessionRevocationErrors')
+    BatchStartViewerSessionRevocationRequest = Shapes::StructureShape.new(name: 'BatchStartViewerSessionRevocationRequest')
+    BatchStartViewerSessionRevocationResponse = Shapes::StructureShape.new(name: 'BatchStartViewerSessionRevocationResponse')
+    BatchStartViewerSessionRevocationViewerSession = Shapes::StructureShape.new(name: 'BatchStartViewerSessionRevocationViewerSession')
+    BatchStartViewerSessionRevocationViewerSessionList = Shapes::ListShape.new(name: 'BatchStartViewerSessionRevocationViewerSessionList')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     Channel = Shapes::StructureShape.new(name: 'Channel')
     ChannelArn = Shapes::StringShape.new(name: 'ChannelArn')
@@ -109,6 +115,8 @@ module Aws::IVS
     S3DestinationBucketName = Shapes::StringShape.new(name: 'S3DestinationBucketName')
     S3DestinationConfiguration = Shapes::StructureShape.new(name: 'S3DestinationConfiguration')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
+    StartViewerSessionRevocationRequest = Shapes::StructureShape.new(name: 'StartViewerSessionRevocationRequest')
+    StartViewerSessionRevocationResponse = Shapes::StructureShape.new(name: 'StartViewerSessionRevocationResponse')
     StopStreamRequest = Shapes::StructureShape.new(name: 'StopStreamRequest')
     StopStreamResponse = Shapes::StructureShape.new(name: 'StopStreamResponse')
     Stream = Shapes::StructureShape.new(name: 'Stream')
@@ -152,6 +160,8 @@ module Aws::IVS
     UpdateChannelResponse = Shapes::StructureShape.new(name: 'UpdateChannelResponse')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     VideoConfiguration = Shapes::StructureShape.new(name: 'VideoConfiguration')
+    ViewerId = Shapes::StringShape.new(name: 'ViewerId')
+    ViewerSessionVersion = Shapes::IntegerShape.new(name: 'ViewerSessionVersion')
     errorCode = Shapes::StringShape.new(name: 'errorCode')
     errorMessage = Shapes::StringShape.new(name: 'errorMessage')
 
@@ -185,6 +195,27 @@ module Aws::IVS
     BatchGetStreamKeyResponse.add_member(:stream_keys, Shapes::ShapeRef.new(shape: StreamKeys, location_name: "streamKeys"))
     BatchGetStreamKeyResponse.struct_class = Types::BatchGetStreamKeyResponse
 
+    BatchStartViewerSessionRevocationError.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
+    BatchStartViewerSessionRevocationError.add_member(:code, Shapes::ShapeRef.new(shape: errorCode, location_name: "code"))
+    BatchStartViewerSessionRevocationError.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
+    BatchStartViewerSessionRevocationError.add_member(:viewer_id, Shapes::ShapeRef.new(shape: ViewerId, required: true, location_name: "viewerId"))
+    BatchStartViewerSessionRevocationError.struct_class = Types::BatchStartViewerSessionRevocationError
+
+    BatchStartViewerSessionRevocationErrors.member = Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationError)
+
+    BatchStartViewerSessionRevocationRequest.add_member(:viewer_sessions, Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationViewerSessionList, required: true, location_name: "viewerSessions"))
+    BatchStartViewerSessionRevocationRequest.struct_class = Types::BatchStartViewerSessionRevocationRequest
+
+    BatchStartViewerSessionRevocationResponse.add_member(:errors, Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationErrors, location_name: "errors"))
+    BatchStartViewerSessionRevocationResponse.struct_class = Types::BatchStartViewerSessionRevocationResponse
+
+    BatchStartViewerSessionRevocationViewerSession.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
+    BatchStartViewerSessionRevocationViewerSession.add_member(:viewer_id, Shapes::ShapeRef.new(shape: ViewerId, required: true, location_name: "viewerId"))
+    BatchStartViewerSessionRevocationViewerSession.add_member(:viewer_session_versions_less_than_or_equal_to, Shapes::ShapeRef.new(shape: ViewerSessionVersion, location_name: "viewerSessionVersionsLessThanOrEqualTo"))
+    BatchStartViewerSessionRevocationViewerSession.struct_class = Types::BatchStartViewerSessionRevocationViewerSession
+
+    BatchStartViewerSessionRevocationViewerSessionList.member = Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationViewerSession)
+
     Channel.add_member(:arn, Shapes::ShapeRef.new(shape: ChannelArn, location_name: "arn"))
     Channel.add_member(:authorized, Shapes::ShapeRef.new(shape: IsAuthorized, location_name: "authorized"))
     Channel.add_member(:ingest_endpoint, Shapes::ShapeRef.new(shape: IngestEndpoint, location_name: "ingestEndpoint"))
@@ -427,6 +458,13 @@ module Aws::IVS
     ServiceQuotaExceededException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage"))
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
+    StartViewerSessionRevocationRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
+    StartViewerSessionRevocationRequest.add_member(:viewer_id, Shapes::ShapeRef.new(shape: ViewerId, required: true, location_name: "viewerId"))
+    StartViewerSessionRevocationRequest.add_member(:viewer_session_versions_less_than_or_equal_to, Shapes::ShapeRef.new(shape: ViewerSessionVersion, location_name: "viewerSessionVersionsLessThanOrEqualTo"))
+    StartViewerSessionRevocationRequest.struct_class = Types::StartViewerSessionRevocationRequest
+
+    StartViewerSessionRevocationResponse.struct_class = Types::StartViewerSessionRevocationResponse
+
     StopStreamRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChannelArn, required: true, location_name: "channelArn"))
     StopStreamRequest.struct_class = Types::StopStreamRequest
 
@@ -583,6 +621,15 @@ module Aws::IVS
         o.output = Shapes::ShapeRef.new(shape: BatchGetStreamKeyResponse)
       end)
 
+      api.add_operation(:batch_start_viewer_session_revocation, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchStartViewerSessionRevocation"
+        o.http_method = "POST"
+        o.http_request_uri = "/BatchStartViewerSessionRevocation"
+        o.input = Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationRequest)
+        o.output = Shapes::ShapeRef.new(shape: BatchStartViewerSessionRevocationResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+      end)
+
       api.add_operation(:create_channel, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateChannel"
         o.http_method = "POST"
@@ -878,6 +925,18 @@ module Aws::IVS
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:start_viewer_session_revocation, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartViewerSessionRevocation"
+        o.http_method = "POST"
+        o.http_request_uri = "/StartViewerSessionRevocation"
+        o.input = Shapes::ShapeRef.new(shape: StartViewerSessionRevocationRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartViewerSessionRevocationResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+      end)
+
       api.add_operation(:stop_stream, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StopStream"
         o.http_method = "POST"

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

@@ -40,6 +40,20 @@ module Aws::IVS
       end
     end
 
+    class BatchStartViewerSessionRevocation
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::IVS::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
+
     class CreateChannel
       def self.build(context)
         unless context.config.regional_endpoint
@@ -348,6 +362,20 @@ module Aws::IVS
       end
     end
 
+    class StartViewerSessionRevocation
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::IVS::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
+
     class StopStream
       def self.build(context)
         unless context.config.regional_endpoint

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

@@ -60,6 +60,8 @@ module Aws::IVS
             Aws::IVS::Endpoints::BatchGetChannel.build(context)
           when :batch_get_stream_key
             Aws::IVS::Endpoints::BatchGetStreamKey.build(context)
+          when :batch_start_viewer_session_revocation
+            Aws::IVS::Endpoints::BatchStartViewerSessionRevocation.build(context)
           when :create_channel
             Aws::IVS::Endpoints::CreateChannel.build(context)
           when :create_recording_configuration
@@ -104,6 +106,8 @@ module Aws::IVS
             Aws::IVS::Endpoints::ListTagsForResource.build(context)
           when :put_metadata
             Aws::IVS::Endpoints::PutMetadata.build(context)
+          when :start_viewer_session_revocation
+            Aws::IVS::Endpoints::StartViewerSessionRevocation.build(context)
           when :stop_stream
             Aws::IVS::Endpoints::StopStream.build(context)
           when :tag_resource

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

@@ -133,6 +133,91 @@ module Aws::IVS
       include Aws::Structure
     end
 
+    # Error for a request in the batch for
+    # BatchStartViewerSessionRevocation. Each error is related to a specific
+    # channel-ARN and viewer-ID pair.
+    #
+    # @!attribute [rw] channel_arn
+    #   Channel ARN.
+    #   @return [String]
+    #
+    # @!attribute [rw] code
+    #   Error code.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   Error message, determined by the application.
+    #   @return [String]
+    #
+    # @!attribute [rw] viewer_id
+    #   The ID of the viewer session to revoke.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocationError AWS API Documentation
+    #
+    class BatchStartViewerSessionRevocationError < Struct.new(
+      :channel_arn,
+      :code,
+      :message,
+      :viewer_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] viewer_sessions
+    #   Array of viewer sessions, one per channel-ARN and viewer-ID pair.
+    #   @return [Array<Types::BatchStartViewerSessionRevocationViewerSession>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocationRequest AWS API Documentation
+    #
+    class BatchStartViewerSessionRevocationRequest < Struct.new(
+      :viewer_sessions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] errors
+    #   Each error object is related to a specific `channelArn` and
+    #   `viewerId` pair in the request.
+    #   @return [Array<Types::BatchStartViewerSessionRevocationError>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocationResponse AWS API Documentation
+    #
+    class BatchStartViewerSessionRevocationResponse < Struct.new(
+      :errors)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A viewer session to revoke in the call to
+    # BatchStartViewerSessionRevocation.
+    #
+    # @!attribute [rw] channel_arn
+    #   The ARN of the channel associated with the viewer session to revoke.
+    #   @return [String]
+    #
+    # @!attribute [rw] viewer_id
+    #   The ID of the viewer associated with the viewer session to revoke.
+    #   Do not use this field for personally identifying, confidential, or
+    #   sensitive information.
+    #   @return [String]
+    #
+    # @!attribute [rw] viewer_session_versions_less_than_or_equal_to
+    #   An optional filter on which versions of the viewer session to
+    #   revoke. All versions less than or equal to the specified version
+    #   will be revoked. Default: 0.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocationViewerSession AWS API Documentation
+    #
+    class BatchStartViewerSessionRevocationViewerSession < Struct.new(
+      :channel_arn,
+      :viewer_id,
+      :viewer_session_versions_less_than_or_equal_to)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Object specifying a channel.
     #
     # @!attribute [rw] arn
@@ -1450,6 +1535,36 @@ module Aws::IVS
       include Aws::Structure
     end
 
+    # @!attribute [rw] channel_arn
+    #   The ARN of the channel associated with the viewer session to revoke.
+    #   @return [String]
+    #
+    # @!attribute [rw] viewer_id
+    #   The ID of the viewer associated with the viewer session to revoke.
+    #   Do not use this field for personally identifying, confidential, or
+    #   sensitive information.
+    #   @return [String]
+    #
+    # @!attribute [rw] viewer_session_versions_less_than_or_equal_to
+    #   An optional filter on which versions of the viewer session to
+    #   revoke. All versions less than or equal to the specified version
+    #   will be revoked. Default: 0.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StartViewerSessionRevocationRequest AWS API Documentation
+    #
+    class StartViewerSessionRevocationRequest < Struct.new(
+      :channel_arn,
+      :viewer_id,
+      :viewer_session_versions_less_than_or_equal_to)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StartViewerSessionRevocationResponse AWS API Documentation
+    #
+    class StartViewerSessionRevocationResponse < Aws::EmptyStructure; end
+
     # @!attribute [rw] channel_arn
     #   ARN of the channel for which the stream is to be stopped.
     #   @return [String]

data/lib/aws-sdk-ivs.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-ivs/customizations'
 # @!group service
 module Aws::IVS
 
-  GEM_VERSION = '1.32.0'
+  GEM_VERSION = '1.33.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ivs
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core