Class: Aws::IVSRealTime::Types::ListParticipantsRequest

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::ListParticipantsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter_by_published ⇒ Boolean

  Filters the response list to only show participants who published during the stage session.

• #filter_by_recording_state ⇒ String

  Filters the response list to only show participants with the specified recording state.

• #filter_by_state ⇒ String

  Filters the response list to only show participants in the specified state.

• #filter_by_user_id ⇒ String

  Filters the response list to match the specified user ID.

• #max_results ⇒ Integer

  Maximum number of results to return.

• #next_token ⇒ String

  The first participant to retrieve.

• #session_id ⇒ String

  ID of the session within the stage.

• #stage_arn ⇒ String

  Stage ARN.

Instance Attribute Details

#filter_by_published ⇒ Boolean

Filters the response list to only show participants who published during the stage session. Only one of ‘filterByUserId`, `filterByPublished`, `filterByState`, or `filterByRecordingState` can be provided per request.

Returns:

• (Boolean)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_recording_state ⇒ String

Filters the response list to only show participants with the specified recording state. Only one of ‘filterByUserId`, `filterByPublished`, `filterByState`, or `filterByRecordingState` can be provided per request.

Returns:

• (String)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_state ⇒ String

Filters the response list to only show participants in the specified state. Only one of ‘filterByUserId`, `filterByPublished`, `filterByState`, or `filterByRecordingState` can be provided per request.

Returns:

• (String)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#filter_by_user_id ⇒ String

Filters the response list to match the specified user ID. Only one of ‘filterByUserId`, `filterByPublished`, `filterByState`, or `filterByRecordingState` can be provided per request. A `userId` is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Returns:

• (String)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of results to return. Default: 50.

Returns:

• (Integer)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

ID of the session within the stage.

Returns:

• (String)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

Stage ARN.

Returns:

• (String)

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

class ListParticipantsRequest < Struct.new(
  :stage_arn,
  :session_id,
  :filter_by_user_id,
  :filter_by_published,
  :filter_by_state,
  :next_token,
  :max_results,
  :filter_by_recording_state)
  SENSITIVE = []
  include Aws::Structure
end