aws_sdk_kinesis/client/

update_stream_mode.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateStreamMode`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`stream_arn(impl Into<String>)`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::stream_arn) / [`set_stream_arn(Option<String>)`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::set_stream_arn):<br>required: **true**<br><p>Specifies the ARN of the data stream whose capacity mode you want to update.</p><br>
    ///   - [`stream_mode_details(StreamModeDetails)`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::stream_mode_details) / [`set_stream_mode_details(Option<StreamModeDetails>)`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::set_stream_mode_details):<br>required: **true**<br><p>Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams.</p><br>
    ///   - [`warm_throughput_mibps(i32)`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::warm_throughput_mibps) / [`set_warm_throughput_mibps(Option<i32>)`](crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::set_warm_throughput_mibps):<br>required: **false**<br><p>The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations. This field is only valid when the stream mode is being updated to on-demand.</p><br>
    /// - On success, responds with [`UpdateStreamModeOutput`](crate::operation::update_stream_mode::UpdateStreamModeOutput)
    /// - On failure, responds with [`SdkError<UpdateStreamModeError>`](crate::operation::update_stream_mode::UpdateStreamModeError)
    pub fn update_stream_mode(&self) -> crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder {
        crate::operation::update_stream_mode::builders::UpdateStreamModeFluentBuilder::new(self.handle.clone())
    }
}