Amazon Interactive Video Service RealTime

{'participant': {'browserName': 'string',
                 'browserVersion': 'string',
                 'ispName': 'string',
                 'osName': 'string',
                 'osVersion': 'string',
                 'sdkVersion': 'string'}}

Gets information about the specified participant token.

See also: AWS API Documentation

Request Syntax

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

type participantId

string

param participantId

[REQUIRED]

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

type sessionId

string

param sessionId

[REQUIRED]

ID of a session within the stage.

type stageArn

string

param stageArn

[REQUIRED]

Stage ARN.

rtype

dict

returns

Response Syntax

{
    'participant': {
        'attributes': {
            'string': 'string'
        },
        'browserName': 'string',
        'browserVersion': 'string',
        'firstJoinTime': datetime(2015, 1, 1),
        'ispName': 'string',
        'osName': 'string',
        'osVersion': 'string',
        'participantId': 'string',
        'published': True|False,
        'sdkVersion': 'string',
        '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) --

    • browserName (string) --

      The participant’s browser.

    • browserVersion (string) --

      The participant’s browser version.

    • firstJoinTime (datetime) --

      ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

    • ispName (string) --

      The participant’s Internet Service Provider.

    • osName (string) --

      The participant’s operating system.

    • osVersion (string) --

      The participant’s operating system version.

    • participantId (string) --

      Unique identifier for this participant, assigned by IVS.

    • published (boolean) --

      Whether the participant ever published to the stage session.

    • sdkVersion (string) --

      The participant’s SDK version.

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