aws_sdk_ivs/client/
update_channel.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateChannel`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`arn(impl Into<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_arn):<br>required: **true**<br><p>ARN of the channel to be updated.</p><br>
7    ///   - [`name(impl Into<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_name):<br>required: **false**<br><p>Channel name.</p><br>
8    ///   - [`latency_mode(ChannelLatencyMode)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::latency_mode) / [`set_latency_mode(Option<ChannelLatencyMode>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_latency_mode):<br>required: **false**<br><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><br>
9    ///   - [`r#type(ChannelType)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::type) / [`set_type(Option<ChannelType>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_type):<br>required: **false**<br><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/LowLatencyAPIReference/channel-types.html">Channel Types</a>.</p><br>
10    ///   - [`authorized(bool)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::authorized) / [`set_authorized(Option<bool>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_authorized):<br>required: **false**<br><p>Whether the channel is private (enabled for playback authorization).</p><br>
11    ///   - [`recording_configuration_arn(impl Into<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::recording_configuration_arn) / [`set_recording_configuration_arn(Option<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_recording_configuration_arn):<br>required: **false**<br><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><br>
12    ///   - [`insecure_ingest(bool)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::insecure_ingest) / [`set_insecure_ingest(Option<bool>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_insecure_ingest):<br>required: **false**<br><p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p><br>
13    ///   - [`preset(TranscodePreset)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::preset) / [`set_preset(Option<TranscodePreset>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_preset):<br>required: **false**<br><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><br>
14    ///   - [`playback_restriction_policy_arn(impl Into<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::playback_restriction_policy_arn) / [`set_playback_restriction_policy_arn(Option<String>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_playback_restriction_policy_arn):<br>required: **false**<br><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><br>
15    ///   - [`multitrack_input_configuration(MultitrackInputConfiguration)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::multitrack_input_configuration) / [`set_multitrack_input_configuration(Option<MultitrackInputConfiguration>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_multitrack_input_configuration):<br>required: **false**<br><p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p><br>
16    ///   - [`container_format(ContainerFormat)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::container_format) / [`set_container_format(Option<ContainerFormat>)`](crate::operation::update_channel::builders::UpdateChannelFluentBuilder::set_container_format):<br>required: **false**<br><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><br>
17    /// - On success, responds with [`UpdateChannelOutput`](crate::operation::update_channel::UpdateChannelOutput) with field(s):
18    ///   - [`channel(Option<Channel>)`](crate::operation::update_channel::UpdateChannelOutput::channel): <p>Object specifying the updated channel.</p>
19    /// - On failure, responds with [`SdkError<UpdateChannelError>`](crate::operation::update_channel::UpdateChannelError)
20    pub fn update_channel(&self) -> crate::operation::update_channel::builders::UpdateChannelFluentBuilder {
21        crate::operation::update_channel::builders::UpdateChannelFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_ivs/client/update_channel.rs

aws_sdk_ivs/client/
update_channel.rs
