ivsrealtime / Client / list_participants
list_participants#
- ivsrealtime.Client.list_participants(**kwargs)#
Lists all participants in a specified stage session.
See also: AWS API Documentation
Request Syntax
response = client.list_participants( filterByPublished=True|False, filterByState='CONNECTED'|'DISCONNECTED', filterByUserId='string', maxResults=123, nextToken='string', sessionId='string', stageArn='string' )
- Parameters:
filterByPublished (boolean) – Filters the response list to only show participants who published during the stage session. Only one of
filterByUserId
,filterByPublished
, orfilterByState
can be provided per request.filterByState (string) – Filters the response list to only show participants in the specified state. Only one of
filterByUserId
,filterByPublished
, orfilterByState
can be provided per request.filterByUserId (string) – Filters the response list to match the specified user ID. Only one of
filterByUserId
,filterByPublished
, orfilterByState
can be provided per request. AuserId
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 (integer) – Maximum number of results to return. Default: 50.
nextToken (string) – The first participant to retrieve. This is used for pagination; see the
nextToken
response field.sessionId (string) –
[REQUIRED]
ID of the session within the stage.
stageArn (string) –
[REQUIRED]
Stage ARN.
- Return type:
dict
- Returns:
Response Syntax
{ 'nextToken': 'string', 'participants': [ { 'firstJoinTime': datetime(2015, 1, 1), 'participantId': 'string', 'published': True|False, 'state': 'CONNECTED'|'DISCONNECTED', 'userId': 'string' }, ] }
Response Structure
(dict) –
nextToken (string) –
If there are more participants than
maxResults
, usenextToken
in the request to get the next set.participants (list) –
List of the matching participants (summary information only).
(dict) –
Summary object describing a participant that has joined a stage.
firstJoinTime (datetime) –
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
participantId (string) –
Unique identifier for this participant, assigned by IVS.
published (boolean) –
Whether the participant ever published to the stage session.
state (string) –
Whether the participant is connected to or disconnected from the stage.
userId (string) –
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. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Exceptions
ivsrealtime.Client.exceptions.ValidationException
ivsrealtime.Client.exceptions.AccessDeniedException