aws_sdk_notifications/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    ///   - [`notification_configuration_arn(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::notification_configuration_arn) / [`set_notification_configuration_arn(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_notification_configuration_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p><br>
8    ///   - [`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 results to be returned in this call. The default value is 20.</p><br>
9    ///   - [`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 start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. <code>NextToken</code> uses Base64 encoding.</p><br>
10    /// - On success, responds with [`ListChannelsOutput`](crate::operation::list_channels::ListChannelsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_channels::ListChannelsOutput::next_token): <p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>
12    ///   - [`channels(Vec::<String>)`](crate::operation::list_channels::ListChannelsOutput::channels): <p>A list 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}