Skip to main content

channels_list_only

Lists channels in a region or regions, for all properties use channels

Overview

Namechannels_list_only
TypeResource
DescriptionResource Type definition for AWS::IVS::Channel
Idaws.ivs.channels_list_only

Fields

NameDatatypeDescription
arnstringChannel ARN is automatically generated on creation and assigned as the unique identifier.
namestringChannel
authorizedbooleanWhether the channel is authorized.
insecure_ingestbooleanWhether the channel allows insecure ingest.
latency_modestringChannel latency mode.
typestringChannel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
tagsarrayA list of key-value pairs that contain metadata for the asset model.
playback_urlstringChannel Playback URL.
ingest_endpointstringChannel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
recording_configuration_arnstringRecording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
presetstringOptional 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 ("").
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all channels in a region.

SELECT
region,
arn
FROM aws.ivs.channels_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the channels_list_only resource, see channels