channels_list_only
Lists channels
in a region or regions, for all properties use channels
Overview
Name | channels_list_only |
Type | Resource |
Description | Resource Type definition for AWS::IVS::Channel |
Id | aws.ivs.channels_list_only |
Fields
Name | Datatype | Description |
---|---|---|
arn | string | Channel ARN is automatically generated on creation and assigned as the unique identifier. |
name | string | Channel |
authorized | boolean | Whether the channel is authorized. |
insecure_ingest | boolean | Whether the channel allows insecure ingest. |
latency_mode | string | Channel latency mode. |
type | string | Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. |
tags | array | A list of key-value pairs that contain metadata for the asset model. |
playback_url | string | Channel Playback URL. |
ingest_endpoint | string | Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software. |
recording_configuration_arn | string | Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled). |
preset | string | 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 (""). |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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