ivsrealtime/aws.sdk.kotlin.services.ivsrealtime.model/ListParticipantsRequest/Builder

Builder

Properties

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.

filterByRecordingState

var filterByRecordingState: ParticipantRecordingFilterByRecordingState?

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.

filterByState

var filterByState: ParticipantState?

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.

filterByUserId

var filterByUserId: 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.

maxResults

var maxResults: Int?

Maximum number of results to return. Default: 50.

nextToken

var nextToken: String?

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

sessionId

var sessionId: String?

ID of the session within the stage.

stageArn

var stageArn: String?

Stage ARN.