Skip to content
AWS for Query.Farm

aws.kinesisvideo.list_signaling_channels

Example SQL Queries

SELECT * FROM
aws.kinesisvideo.list_signaling_channels;

Description

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

Table Definition

Column NameColumn Data Type
channel_name_condition Input Column

Optional: Returns only the channels that satisfy a specific condition.

STRUCT(
    "comparison_operator" VARCHAR,
    "comparison_value" VARCHAR
)
Show child fields
channel_name_condition.comparison_operator

A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.

channel_name_condition.comparison_value

A value to compare.

_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_arn

The Amazon Resource Name (ARN) of the signaling channel.

VARCHAR
channel_name

The name of the signaling channel.

VARCHAR
channel_status

Current status of the signaling channel.

VARCHAR
channel_type

The type of the signaling channel.

VARCHAR
creation_time

The time at which the signaling channel was created.

TIMESTAMP_S
single_master_configuration

A structure that contains the configuration for the SINGLE_MASTER channel type.

STRUCT(
    "message_ttl_seconds" BIGINT
)
Show child fields
single_master_configuration.message_ttl_seconds

The period of time a signaling channel retains undelivered messages before they are discarded.

version

The current version of the signaling channel.

VARCHAR