aws_sdk_repostspace/client/list_channels.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 [`ListChannels`](crate::operation::list_channels::builders::ListChannelsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`space_id(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::space_id) / [`set_space_id(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_space_id):<br>required: **true**<br><p>The unique ID of the private re:Post.</p><br>
8 /// - [`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>The token for the next set of channel to return. You receive this token from a previous ListChannels operation.</p><br>
9 /// - [`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>The maximum number of channels to include in the results.</p><br>
10 /// - On success, responds with [`ListChannelsOutput`](crate::operation::list_channels::ListChannelsOutput) with field(s):
11 /// - [`channels(Vec::<ChannelData>)`](crate::operation::list_channels::ListChannelsOutput::channels): <p>An array of structures that contain some information about the channels in the private re:Post.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_channels::ListChannelsOutput::next_token): <p>The token that you use when you request the next set of channels.</p>
13 /// - On failure, responds with [`SdkError<ListChannelsError>`](crate::operation::list_channels::ListChannelsError)
14 pub fn list_channels(&self) -> crate::operation::list_channels::builders::ListChannelsFluentBuilder {
15 crate::operation::list_channels::builders::ListChannelsFluentBuilder::new(self.handle.clone())
16 }
17}