ivsrealtime / Client / list_participant_events

list_participant_events#

ivsrealtime.Client.list_participant_events(**kwargs)#

Lists events for a specified participant that occurred during a specified stage session.

See also: AWS API Documentation

Request Syntax

response = client.list_participant_events(
    maxResults=123,
    nextToken='string',
    participantId='string',
    sessionId='string',
    stageArn='string'
)
Parameters:

  • 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.

  • participantId (string) –

    [REQUIRED]

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

  • sessionId (string) –

    [REQUIRED]

    ID of a session within the stage.

  • stageArn (string) –

    [REQUIRED]

    Stage ARN.

Return type:

dict

Returns:

Response Syntax

{
    'events': [
        {
            'errorCode': 'INSUFFICIENT_CAPABILITIES',
            'eventTime': datetime(2015, 1, 1),
            'name': 'JOINED'|'LEFT'|'PUBLISH_STARTED'|'PUBLISH_STOPPED'|'SUBSCRIBE_STARTED'|'SUBSCRIBE_STOPPED'|'PUBLISH_ERROR'|'SUBSCRIBE_ERROR'|'JOIN_ERROR',
            'participantId': 'string',
            'remoteParticipantId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • events (list) –

      List of the matching events.

      • (dict) –

        An occurrence during a stage session.

        • errorCode (string) –

          If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken.

        • eventTime (datetime) –

          ISO 8601 timestamp (returned as a string) for when the event occurred.

        • name (string) –

          The name of the event.

        • participantId (string) –

          Unique identifier for the participant who triggered the event. This is assigned by IVS.

        • remoteParticipantId (string) –

          Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

    • nextToken (string) –

      If there are more rooms than maxResults, use nextToken in the request to get the next set.

Exceptions

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException