Skip to content
AWS for Query.Farm

aws.ivs_realtime.get_participant

Example SQL Queries

SELECT * FROM
aws.ivs_realtime.get_participant
WHERE
"stage_arn" = 'VALUE'
AND "session_id" = 'VALUE'
AND "participant_id" = 'VALUE';

Description

Gets information about the specified participant token.

Table Definition

Column NameColumn Data Type
participant_id Required Input Column

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

VARCHAR
session_id Required Input Column

ID of a session within the stage.

VARCHAR
stage_arn Required Input Column

Stage ARN.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

participant

The participant that is returned.

STRUCT(
    "participant_id" VARCHAR,
    "user_id" VARCHAR,
    "state" VARCHAR,
    "first_join_time" TIMESTAMP_S,
    "attributes" MAP(VARCHAR, VARCHAR),
    "published" BOOLEAN,
    "isp_name" VARCHAR,
    "os_name" VARCHAR,
    "os_version" VARCHAR,
    "browser_name" VARCHAR,
    "browser_version" VARCHAR,
    "sdk_version" VARCHAR,
    "recording_s3_bucket_name" VARCHAR,
    "recording_s3_prefix" VARCHAR,
    "recording_state" VARCHAR
)
Show child fields
participant.attributes

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.

participant.browser_name

The participant’s browser.

participant.browser_version

The participant’s browser version.

participant.first_join_time

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

participant.isp_name

The participant’s Internet Service Provider.

participant.os_name

The participant’s operating system.

participant.os_version

The participant’s operating system version.

participant.participant_id

Unique identifier for this participant, assigned by IVS.

participant.published

Whether the participant ever published to the stage session.

participant.recording_s3_bucket_name

Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.

participant.recording_s3_prefix

S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.

participant.recording_state

The participant’s recording state.

participant.sdk_version

The participant’s SDK version.

participant.state

Whether the participant is connected to or disconnected from the stage.

participant.user_id

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.