Skip to content
AWS for Query.Farm

aws.ivs_realtime.list_participant_events

Example SQL Queries

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

Description

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

Table Definition

Column NameColumn Data Type
participant_id Required Input Column

Unique identifier for this 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
max_results Input Column

Maximum number of results to return. Default: 50.

BIGINT
next_token Input Column

If there are more events 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.

events

List of the matching events.

STRUCT(
    "name" VARCHAR,
    "participant_id" VARCHAR,
    "event_time" TIMESTAMP_S,
    "remote_participant_id" VARCHAR,
    "error_code" VARCHAR
)[]
Show child fields
events[]
Show child fields
events[].error_code

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. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.

events[].event_time

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

events[].name

The name of the event.

events[].participant_id

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

events[].remote_participant_id

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.