Skip to content
AWS for Query.Farm

aws.ivs.get_channel

Example SQL Queries

SELECT * FROM
aws.ivs.get_channel
WHERE
"arn" = 'VALUE';

Description

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

Table Definition

Column NameColumn Data Type
arn Required Input Column

ARN of the channel for which the configuration is to be retrieved.

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
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
)
Show child fields
channel.arn

Channel ARN.

channel.authorized

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

channel.ingest_endpoint

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

channel.insecure_ingest

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

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.

channel.name

Channel name.

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).

channel.playback_url

Channel playback URL.

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 ("").

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).

channel.srt

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

Show child fields
channel.srt.endpoint

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

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.

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.

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.