Class: Aws::IVSRealTime::Types::ListParticipantEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::ListParticipantEventsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  Maximum number of results to return.

• #next_token ⇒ String

  The first participant event to retrieve.

• #participant_id ⇒ String

  Unique identifier for this participant.

• #session_id ⇒ String

  ID of a session within the stage.

• #stage_arn ⇒ String

  Stage ARN.

Instance Attribute Details

#max_results ⇒ Integer

Maximum number of results to return. Default: 50.

Returns:

• (Integer)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1484

class ListParticipantEventsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The first participant event to retrieve. This is used for pagination; see the ‘nextToken` response field.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1484

class ListParticipantEventsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#participant_id ⇒ String

Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1484

class ListParticipantEventsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

ID of a session within the stage.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1484

class ListParticipantEventsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

Stage ARN.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1484

class ListParticipantEventsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end