Skip to content
AWS for Query.Farm

aws.kinesisvideo.describe_stream

Example SQL Queries

SELECT * FROM
aws.kinesisvideo.describe_stream;

Description

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

Table Definition

Column NameColumn Data Type
stream_arn Input Column

The Amazon Resource Name (ARN) of the stream.

VARCHAR
stream_name Input Column

The name of the stream.

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_info

An object that describes the stream.

STRUCT(
    "device_name" VARCHAR,
    "stream_name" VARCHAR,
    "stream_arn" VARCHAR,
    "media_type" VARCHAR,
    "kms_key_id" VARCHAR,
    "version" VARCHAR,
    "status" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "data_retention_in_hours" BIGINT
)
Show child fields
stream_info.creation_time

A time stamp that indicates when the stream was created.

stream_info.data_retention_in_hours

How long the stream retains data, in hours.

stream_info.device_name

The name of the device that is associated with the stream.

stream_info.kms_key_id

The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

stream_info.media_type

The MediaType of the stream.

stream_info.status

The status of the stream.

stream_info.stream_arn

The Amazon Resource Name (ARN) of the stream.

stream_info.stream_name

The name of the stream.

stream_info.version

The version of the stream.