aws_sdk_keyspacesstreams/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    ///   - [`keyspace_name(impl Into<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::keyspace_name) / [`set_keyspace_name(Option<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_keyspace_name):<br>required: **false**<br><p>The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.</p><br>
8    ///   - [`table_name(impl Into<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::table_name) / [`set_table_name(Option<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_table_name):<br>required: **false**<br><p>The name of the table for which to list streams. Must be used together with <code>keyspaceName</code>. If specified, only streams associated with this specific table are returned.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of streams to return in a single <code>ListStreams</code> request. Default value is 100. The minimum value is 1 and the maximum value is 1000.</p><br>
10    ///   - [`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>An optional pagination token provided by a previous <code>ListStreams</code> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>maxResults</code>.</p><br>
11    /// - On success, responds with [`ListStreamsOutput`](crate::operation::list_streams::ListStreamsOutput) with field(s):
12    ///   - [`streams(Option<Vec::<Stream>>)`](crate::operation::list_streams::ListStreamsOutput::streams): <p>An array of stream objects, each containing summary information about a stream including its ARN, status, and associated table information. This list includes all streams that match the request criteria.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_streams::ListStreamsOutput::next_token): <p>A pagination token that can be used in a subsequent <code>ListStreams</code> request. This token is returned if the response contains more streams than can be returned in a single response based on the <code>MaxResults</code> parameter.</p>
14    /// - On failure, responds with [`SdkError<ListStreamsError>`](crate::operation::list_streams::ListStreamsError)
15    pub fn list_streams(&self) -> crate::operation::list_streams::builders::ListStreamsFluentBuilder {
16        crate::operation::list_streams::builders::ListStreamsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_keyspacesstreams/client/list_streams.rs

aws_sdk_keyspacesstreams/client/
list_streams.rs
