{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-schema/ivs-update-channel-request-schema.json", "title": "UpdateChannelRequest", "description": "UpdateChannelRequest schema", "type": "object", "properties": { "arn": { "allOf": [ { "$ref": "#/components/schemas/ChannelArn" }, { "description": "ARN of the channel to be updated." } ] }, "authorized": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Whether the channel is private (enabled for playback authorization)." } ] }, "insecureIngest": { "allOf": [ { "$ref": "#/components/schemas/Boolean" }, { "description": "Whether the channel allows insecure RTMP ingest. Default: false." } ] }, "latencyMode": { "allOf": [ { "$ref": "#/components/schemas/ChannelLatencyMode" }, { "description": "Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)" } ] }, "name": { "allOf": [ { "$ref": "#/components/schemas/ChannelName" }, { "description": "Channel name." } ] }, "preset": { "allOf": [ { "$ref": "#/components/schemas/TranscodePreset" }, { "description": "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 (\"\")." } ] }, "recordingConfigurationArn": { "allOf": [ { "$ref": "#/components/schemas/ChannelRecordingConfigurationArn" }, { "description": "Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/ChannelType" }, { "description": "

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values:

Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

" } ] } }, "required": [ "arn" ] }