aws_sdk_kinesis/client/
describe_stream_summary.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 [`DescribeStreamSummary`](crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stream_name(impl Into<String>)`](crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder::stream_name) / [`set_stream_name(Option<String>)`](crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder::set_stream_name):<br>required: **false**<br><p>The name of the stream to describe.</p><br>
7    ///   - [`stream_arn(impl Into<String>)`](crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder::stream_arn) / [`set_stream_arn(Option<String>)`](crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder::set_stream_arn):<br>required: **false**<br><p>The ARN of the stream.</p><br>
8    /// - On success, responds with [`DescribeStreamSummaryOutput`](crate::operation::describe_stream_summary::DescribeStreamSummaryOutput) with field(s):
9    ///   - [`stream_description_summary(Option<StreamDescriptionSummary>)`](crate::operation::describe_stream_summary::DescribeStreamSummaryOutput::stream_description_summary): <p>A <code>StreamDescriptionSummary</code> containing information about the stream.</p>
10    /// - On failure, responds with [`SdkError<DescribeStreamSummaryError>`](crate::operation::describe_stream_summary::DescribeStreamSummaryError)
11    pub fn describe_stream_summary(&self) -> crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder {
12        crate::operation::describe_stream_summary::builders::DescribeStreamSummaryFluentBuilder::new(self.handle.clone())
13    }
14}