aws-sdk-dsql 1.56.0

AWS SDK for Amazon Aurora DSQL
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListStreams`](crate::operation::list_streams::builders::ListStreamsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_identifier(impl Into<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::operation::list_streams::builders::ListStreamsFluentBuilder::set_cluster_identifier):<br>required: **true**<br><p>The ID of the cluster for which to list streams.</p><br>
    ///   - [`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>An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.</p><br>
    ///   - [`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>If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.</p><br>
    /// - On success, responds with [`ListStreamsOutput`](crate::operation::list_streams::ListStreamsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_streams::ListStreamsOutput::next_token): <p>If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.</p>
    ///   - [`streams(Vec::<StreamSummary>)`](crate::operation::list_streams::ListStreamsOutput::streams): <p>An array of the returned streams.</p>
    /// - On failure, responds with [`SdkError<ListStreamsError>`](crate::operation::list_streams::ListStreamsError)
    pub fn list_streams(&self) -> crate::operation::list_streams::builders::ListStreamsFluentBuilder {
        crate::operation::list_streams::builders::ListStreamsFluentBuilder::new(self.handle.clone())
    }
}