channel

Gets an individual channel resource

Overview

Name	channel
Type	Resource
Description	channel
Id	awscc.ivs.channel

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

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
name,
authorized,
insecure_ingest,
latency_mode,
type,
tags,
playback_url,
ingest_endpoint,
recording_configuration_arn,
preset
FROM awscc.ivs.channel
WHERE data__Identifier = '<Arn>';

Permissions

To operate on the channel resource, the following permissions are required:

Read

ivs:GetChannel,
ivs:ListTagsForResource

Update

ivs:GetChannel,
ivs:UpdateChannel,
ivs:TagResource,
ivs:UnTagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteChannel,
ivs:UnTagResource