aws_sdk_kinesis/client/update_stream_warm_throughput.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 [`UpdateStreamWarmThroughput`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`stream_arn(impl Into<String>)`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::stream_arn) / [`set_stream_arn(Option<String>)`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::set_stream_arn):<br>required: **false**<br><p>The ARN of the stream to be updated.</p><br>
7 /// - [`stream_name(impl Into<String>)`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::stream_name) / [`set_stream_name(Option<String>)`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::set_stream_name):<br>required: **false**<br><p>The name of the stream to be updated.</p><br>
8 /// - [`warm_throughput_mibps(i32)`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::warm_throughput_mibps) / [`set_warm_throughput_mibps(Option<i32>)`](crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::set_warm_throughput_mibps):<br>required: **true**<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.</p><br>
9 /// - On success, responds with [`UpdateStreamWarmThroughputOutput`](crate::operation::update_stream_warm_throughput::UpdateStreamWarmThroughputOutput) with field(s):
10 /// - [`stream_arn(Option<String>)`](crate::operation::update_stream_warm_throughput::UpdateStreamWarmThroughputOutput::stream_arn): <p>The ARN of the stream that was updated.</p>
11 /// - [`stream_name(Option<String>)`](crate::operation::update_stream_warm_throughput::UpdateStreamWarmThroughputOutput::stream_name): <p>The name of the stream that was updated.</p>
12 /// - [`warm_throughput(Option<WarmThroughputObject>)`](crate::operation::update_stream_warm_throughput::UpdateStreamWarmThroughputOutput::warm_throughput): <p>Specifies the updated warm throughput configuration for your data stream.</p>
13 /// - On failure, responds with [`SdkError<UpdateStreamWarmThroughputError>`](crate::operation::update_stream_warm_throughput::UpdateStreamWarmThroughputError)
14 pub fn update_stream_warm_throughput(
15 &self,
16 ) -> crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder {
17 crate::operation::update_stream_warm_throughput::builders::UpdateStreamWarmThroughputFluentBuilder::new(self.handle.clone())
18 }
19}