Skip to content
AWS for Query.Farm

aws.ivs.get_stream_session

Example SQL Queries

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

Description

Gets metadata on a specified stream.

Table Definition

Column NameColumn Data Type
channel_arn Required Input Column

ARN of the channel resource

VARCHAR
stream_id Input Column

Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

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_session

List of stream details.

STRUCT(
    "stream_id" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "channel" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR,
        "latency_mode" VARCHAR,
        "type" VARCHAR,
        "recording_configuration_arn" VARCHAR,
        "ingest_endpoint" VARCHAR,
        "playback_url" VARCHAR,
        "authorized" BOOLEAN,
        "tags" MAP(VARCHAR, VARCHAR),
        "insecure_ingest" BOOLEAN,
        "preset" VARCHAR,
        "srt" STRUCT(
            "endpoint" VARCHAR,
            "passphrase" VARCHAR
        ),
        "playback_restriction_policy_arn" VARCHAR
    ),
    "ingest_configuration" STRUCT(
        "video" STRUCT(
            "avc_profile" VARCHAR,
            "avc_level" VARCHAR,
            "codec" VARCHAR,
            "encoder" VARCHAR,
            "target_bitrate" BIGINT,
            "target_framerate" BIGINT,
            "video_height" BIGINT,
            "video_width" BIGINT
        ),
        "audio" STRUCT(
            "codec" VARCHAR,
            "target_bitrate" BIGINT,
            "sample_rate" BIGINT,
            "channels" BIGINT
        )
    ),
    "recording_configuration" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR,
        "destination_configuration" STRUCT(
            "s3" STRUCT(
                "bucket_name" VARCHAR
            )
        ),
        "state" VARCHAR,
        "tags" MAP(VARCHAR, VARCHAR),
        "thumbnail_configuration" STRUCT(
            "recording_mode" VARCHAR,
            "target_interval_seconds" BIGINT,
            "resolution" VARCHAR,
            "storage" VARCHAR[]
        ),
        "recording_reconnect_window_seconds" BIGINT,
        "rendition_configuration" STRUCT(
            "rendition_selection" VARCHAR,
            "renditions" VARCHAR[]
        )
    ),
    "truncated_events" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR,
        "event_time" TIMESTAMP_S
    )[]
)
Show child fields
stream_session.channel

The properties of the channel at the time of going live.

Show child fields
stream_session.channel.arn

Channel ARN.

stream_session.channel.authorized

Whether the channel is private (enabled for playback authorization). Default: false.

stream_session.channel.ingest_endpoint

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

stream_session.channel.insecure_ingest

Whether the channel allows insecure RTMP ingest. Default: false.

stream_session.channel.latency_mode

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

stream_session.channel.name

Channel name.

stream_session.channel.playback_restriction_policy_arn

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

stream_session.channel.playback_url

Channel playback URL.

stream_session.channel.preset

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

stream_session.channel.recording_configuration_arn

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

stream_session.channel.srt

Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

Show child fields
stream_session.channel.srt.endpoint

The endpoint to be used when streaming with IVS using the SRT protocol.

stream_session.channel.srt.passphrase

Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the insecureIngest option for the channel.

stream_session.channel.tags

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

stream_session.channel.type

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

stream_session.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_session.ingest_configuration

The properties of the incoming RTMP stream for the stream.

Show child fields
stream_session.ingest_configuration.audio

Encoder settings for audio.

Show child fields
stream_session.ingest_configuration.audio.channels

Number of audio channels.

stream_session.ingest_configuration.audio.codec

Codec used for the audio encoding.

stream_session.ingest_configuration.audio.sample_rate

Number of audio samples recorded per second.

stream_session.ingest_configuration.audio.target_bitrate

The expected ingest bitrate (bits per second). This is configured in the encoder.

stream_session.ingest_configuration.video

Encoder settings for video.

Show child fields
stream_session.ingest_configuration.video.avc_level

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

stream_session.ingest_configuration.video.avc_profile

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

stream_session.ingest_configuration.video.codec

Codec used for the video encoding.

stream_session.ingest_configuration.video.encoder

Software or hardware used to encode the video.

stream_session.ingest_configuration.video.target_bitrate

The expected ingest bitrate (bits per second). This is configured in the encoder.

stream_session.ingest_configuration.video.target_framerate

The expected ingest framerate. This is configured in the encoder.

stream_session.ingest_configuration.video.video_height

Video-resolution height in pixels.

stream_session.ingest_configuration.video.video_width

Video-resolution width in pixels.

stream_session.recording_configuration

The properties of recording the live stream.

Show child fields
stream_session.recording_configuration.arn

Recording-configuration ARN.

stream_session.recording_configuration.destination_configuration

A complex type that contains information about where recorded video will be stored.

Show child fields
stream_session.recording_configuration.destination_configuration.s3

An S3 destination configuration where recorded videos will be stored.

Show child fields
stream_session.recording_configuration.destination_configuration.s3.bucket_name

Location (S3 bucket name) where recorded videos will be stored.

stream_session.recording_configuration.name

Recording-configuration name. The value does not need to be unique.

stream_session.recording_configuration.recording_reconnect_window_seconds

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

stream_session.recording_configuration.rendition_configuration

Object that describes which renditions should be recorded for a stream.

Show child fields
stream_session.recording_configuration.rendition_configuration.rendition_selection

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

stream_session.recording_configuration.rendition_configuration.renditions[]
stream_session.recording_configuration.state

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

stream_session.recording_configuration.tags

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

stream_session.recording_configuration.thumbnail_configuration

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Show child fields
stream_session.recording_configuration.thumbnail_configuration.recording_mode

Thumbnail recording mode. Default: INTERVAL.

stream_session.recording_configuration.thumbnail_configuration.resolution

Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).

stream_session.recording_configuration.thumbnail_configuration.storage[]
stream_session.recording_configuration.thumbnail_configuration.target_interval_seconds

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: For the BASIC channel type, setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

stream_session.start_time

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

stream_session.stream_id

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

stream_session.truncated_events[]
Show child fields
stream_session.truncated_events[].event_time

Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.

stream_session.truncated_events[].name

Name that identifies the stream event within a type.

stream_session.truncated_events[].type

Logical group for certain events.