aws_sdk_kinesis/client/
list_streams.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 [`ListStreams`](crate::operation::list_streams::builders::ListStreamsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`limit(i32)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of streams to list. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.</p><br>
8    ///   - [`exclusive_start_stream_name(impl Into<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::exclusive_start_stream_name) / [`set_exclusive_start_stream_name(Option<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_exclusive_start_stream_name):<br>required: **false**<br><p>The name of the stream to start the list with.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_next_token):<br>required: **false**<br><p></p><br>
10    /// - On success, responds with [`ListStreamsOutput`](crate::operation::list_streams::ListStreamsOutput) with field(s):
11    ///   - [`stream_names(Vec::<String>)`](crate::operation::list_streams::ListStreamsOutput::stream_names): <p>The names of the streams that are associated with the Amazon Web Services account making the <code>ListStreams</code> request.</p>
12    ///   - [`has_more_streams(bool)`](crate::operation::list_streams::ListStreamsOutput::has_more_streams): <p>If set to <code>true</code>, there are more streams available to list.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_streams::ListStreamsOutput::next_token): <p></p>
14    ///   - [`stream_summaries(Option<Vec::<StreamSummary>>)`](crate::operation::list_streams::ListStreamsOutput::stream_summaries): <p></p>
15    /// - On failure, responds with [`SdkError<ListStreamsError>`](crate::operation::list_streams::ListStreamsError)
16    pub fn list_streams(&self) -> crate::operation::list_streams::builders::ListStreamsFluentBuilder {
17        crate::operation::list_streams::builders::ListStreamsFluentBuilder::new(self.handle.clone())
18    }
19}