Skip to content
AWS for Query.Farm

aws.ivs_realtime.list_participants

Example SQL Queries

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

Description

Lists all participants in a specified stage session.

Table Definition

Column NameColumn Data Type
session_id Required Input Column

ID of the session within the stage.

VARCHAR
stage_arn Required Input Column

Stage ARN.

VARCHAR
filter_by_published Input Column

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

BOOLEAN
filter_by_recording_state Input Column

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

VARCHAR
filter_by_state Input Column

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

VARCHAR
filter_by_user_id Input Column

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId 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.

VARCHAR
max_results Input Column

Maximum number of results to return. Default: 50.

BIGINT
next_token Input Column

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

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.

participants

List of the matching participants (summary information only).

STRUCT(
    "participant_id" VARCHAR,
    "user_id" VARCHAR,
    "state" VARCHAR,
    "first_join_time" TIMESTAMP_S,
    "published" BOOLEAN,
    "recording_state" VARCHAR
)[]
Show child fields
participants[]
Show child fields
participants[].first_join_time

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

participants[].participant_id

Unique identifier for this participant, assigned by IVS.

participants[].published

Whether the participant ever published to the stage session.

participants[].recording_state

The participant’s recording state.

participants[].state

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

participants[].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.