Skip to content

UpdateChannelRequest

Source code in docs_src/capo_ivs/types/update_channel_request.py
class UpdateChannelRequest(TypedDict, closed=True):
    arn: "capo_ivs.types.channel_arn.ChannelArn"
    """<p>ARN of the channel to be updated.</p>"""
    name: NotRequired["capo_ivs.types.channel_name.ChannelName"]
    """<p>Channel name.</p>"""
    latency_mode: NotRequired["capo_ivs.types.channel_latency_mode.ChannelLatencyMode"]
    """<p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers.</p>"""
    type: NotRequired["capo_ivs.types.channel_type.ChannelType"]
    """<p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/channel-types.html">Channel Types</a>.</p>"""
    authorized: "capo_ivs.types.boolean.Boolean"
    """<p>Whether the channel is private (enabled for playback authorization).</p>"""
    recording_configuration_arn: NotRequired[
        "capo_ivs.types.channel_recording_configuration_arn.ChannelRecordingConfigurationArn"
    ]
    """<p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.</p>"""
    insecure_ingest: "capo_ivs.types.boolean.Boolean"
    """<p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>"""
    preset: NotRequired["capo_ivs.types.transcode_preset.TranscodePreset"]
    """<p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty string (<code>""</code>).</p>"""
    playback_restriction_policy_arn: NotRequired[
        "capo_ivs.types.channel_playback_restriction_policy_arn.ChannelPlaybackRestrictionPolicyArn"
    ]
    """<p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.</p>"""
    multitrack_input_configuration: NotRequired[
        "capo_ivs.types.multitrack_input_configuration.MultitrackInputConfiguration"
    ]
    """<p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>"""
    container_format: NotRequired["capo_ivs.types.container_format.ContainerFormat"]
    """<p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>"""
    ad_configuration_arn: NotRequired[
        "capo_ivs.types.channel_ad_configuration_arn.ChannelAdConfigurationArn"
    ]
    """<p>ARN of the ad configuration associated with the channel.</p>"""

ad_configuration_arn instance-attribute

ad_configuration_arn: NotRequired[ChannelAdConfigurationArn]

ARN of the ad configuration associated with the channel.

arn instance-attribute

ARN of the channel to be updated.

authorized instance-attribute

authorized: Boolean

Whether the channel is private (enabled for playback authorization).

container_format instance-attribute

container_format: NotRequired[ContainerFormat]

Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

insecure_ingest instance-attribute

insecure_ingest: Boolean

Whether the channel allows insecure RTMP and SRT ingest. Default: false.

latency_mode instance-attribute

latency_mode: NotRequired[ChannelLatencyMode]

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.

multitrack_input_configuration instance-attribute

multitrack_input_configuration: NotRequired[MultitrackInputConfiguration]

Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

name instance-attribute

name: NotRequired[ChannelName]

Channel name.

playback_restriction_policy_arn instance-attribute

playback_restriction_policy_arn: NotRequired[ChannelPlaybackRestrictionPolicyArn]

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.

preset instance-attribute

preset: NotRequired[TranscodePreset]

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 ("").

recording_configuration_arn instance-attribute

recording_configuration_arn: NotRequired[ChannelRecordingConfigurationArn]

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.

type instance-attribute

type: NotRequired[ChannelType]

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.