Class: Aws::IVSRealTime::Types::DisconnectParticipantRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#participant_id ⇒ String

Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).

Returns:

  • (String) 


688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 688

class DisconnectParticipantRequest < Struct.new(
  :stage_arn,
  :participant_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

Description of why this participant is being disconnected.

Returns:

  • (String) 


688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 688

class DisconnectParticipantRequest < Struct.new(
  :stage_arn,
  :participant_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

ARN of the stage to which the participant is attached.

Returns:

  • (String) 


688
689
690
691
692
693
694
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 688

class DisconnectParticipantRequest < Struct.new(
  :stage_arn,
  :participant_id,
  :reason)
  SENSITIVE = []
  include Aws::Structure
end