Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439243197.0 KB

Lists all participants in a specified stage session.

post/ListParticipants

Request body

stageArnstring required

Stage ARN.

sessionIdstring required

ID of the session within the stage.

filterByUserIdstring

Filters the response list to match the specified user ID. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request. A <code>userId</code> 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.

filterByPublishedboolean

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

filterByState'CONNECTED' | 'DISCONNECTED'

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

nextTokenstring

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

maxResultsinteger

Maximum number of results to return. Default: 50.

filterByRecordingState'STARTING' | 'ACTIVE' | 'STOPPING' | 'STOPPED' | 'FAILED'

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

Response

Success

nextTokenstring

If there are more participants than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.