Skip to content
AWS for Query.Farm

aws.ivs.list_stream_sessions

Example SQL Queries

SELECT * FROM
aws.ivs.list_stream_sessions
WHERE
"channel_arn" = 'VALUE';

Description

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Table Definition

Column NameColumn Data Type
channel_arn Required Input Column

Channel ARN used to filter the list.

VARCHAR
max_results Input Column

Maximum number of streams to return. Default: 100.

BIGINT
next_token Input Column

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

_aws_region Input Column

The AWS region to use.

VARCHAR
stream_sessions

List of stream sessions.

STRUCT(
    "stream_id" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "has_error_event" BOOLEAN
)[]
Show child fields
stream_sessions[]
Show child fields
stream_sessions[].end_time

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

stream_sessions[].has_error_event

If true, this stream encountered a quota breach or failure.

stream_sessions[].start_time

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

stream_sessions[].stream_id

Unique identifier for a live or previously live stream in the specified channel.