aws-sdk-kafka 1.126.0

AWS SDK for Managed Streaming for Kafka
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 [`ListChannels`](crate::operation::list_channels::builders::ListChannelsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_arn(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::cluster_arn) / [`set_cluster_arn(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_cluster_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of channels to return in a single response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.</p><br>
    ///   - [`topic_name_filter(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::topic_name_filter) / [`set_topic_name_filter(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_topic_name_filter):<br>required: **false**<br><p>Filters results to channels whose topic name matches the specified value.</p><br>
    /// - On success, responds with [`ListChannelsOutput`](crate::operation::list_channels::ListChannelsOutput) with field(s):
    ///   - [`channels(Option<Vec::<ChannelInfo>>)`](crate::operation::list_channels::ListChannelsOutput::channels): <p>The list of channels in the cluster.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_channels::ListChannelsOutput::next_token): <p>If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page.</p>
    /// - On failure, responds with [`SdkError<ListChannelsError>`](crate::operation::list_channels::ListChannelsError)
    pub fn list_channels(&self) -> crate::operation::list_channels::builders::ListChannelsFluentBuilder {
        crate::operation::list_channels::builders::ListChannelsFluentBuilder::new(self.handle.clone())
    }
}