ivsrealtime / Client / get_participant

get_participant

ivsrealtime.Client.get_participant(**kwargs)

Gets information about the specified participant token.

See also: AWS API Documentation

Request Syntax

response = client.get_participant(
    participantId='string',
    sessionId='string',
    stageArn='string'
)

Parameters:

• participantId (string) –

  [REQUIRED]

  Unique identifier for the 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

{
    'participant': {
        'attributes': {
            'string': 'string'
        },
        'firstJoinTime': datetime(2015, 1, 1),
        'participantId': 'string',
        'published': True|False,
        'state': 'CONNECTED'|'DISCONNECTED',
        'userId': 'string'
    }
}

Response Structure

• (dict) –

  • participant (dict) –

    The participant that is returned.

    • attributes (dict) –

      Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • (string) –

        • (string) –

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

• ivsrealtime.Client.exceptions.ValidationException

• ivsrealtime.Client.exceptions.AccessDeniedException