Skip to content
AWS for Query.Farm

aws.kinesisvideo.describe_signaling_channel

Example SQL Queries

SELECT * FROM
aws.kinesisvideo.describe_signaling_channel;

Description

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

Table Definition

Column NameColumn Data Type
channel_arn Input Column

The ARN of the signaling channel that you want to describe.

VARCHAR
channel_name Input Column

The name of the signaling channel that you want to describe.

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_info

A structure that encapsulates the specified signaling channel's metadata and properties.

STRUCT(
    "channel_name" VARCHAR,
    "channel_arn" VARCHAR,
    "channel_type" VARCHAR,
    "channel_status" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "single_master_configuration" STRUCT(
        "message_ttl_seconds" BIGINT
    ),
    "version" VARCHAR
)
Show child fields
channel_info.channel_arn

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

channel_info.channel_name

The name of the signaling channel.

channel_info.channel_status

Current status of the signaling channel.

channel_info.channel_type

The type of the signaling channel.

channel_info.creation_time

The time at which the signaling channel was created.

channel_info.single_master_configuration

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

Show child fields
channel_info.single_master_configuration.message_ttl_seconds

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

channel_info.version

The current version of the signaling channel.