aws_sdk_ivs/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    ///   - [`filter_by_name(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::filter_by_name) / [`set_filter_by_name(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_filter_by_name):<br>required: **false**<br><p>Filters the channel list to match the specified name.</p><br>
8    ///   - [`filter_by_recording_configuration_arn(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::filter_by_recording_configuration_arn) / [`set_filter_by_recording_configuration_arn(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_filter_by_recording_configuration_arn):<br>required: **false**<br><p>Filters the channel list to match the specified recording-configuration ARN.</p><br>
9    ///   - [`filter_by_playback_restriction_policy_arn(impl Into<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::filter_by_playback_restriction_policy_arn) / [`set_filter_by_playback_restriction_policy_arn(Option<String>)`](crate::operation::list_channels::builders::ListChannelsFluentBuilder::set_filter_by_playback_restriction_policy_arn):<br>required: **false**<br><p>Filters the channel list to match the specified policy.</p><br>
10    ///   - [`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 first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p><br>
11    ///   - [`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. Default: 100.</p><br>
12    /// - On success, responds with [`ListChannelsOutput`](crate::operation::list_channels::ListChannelsOutput) with field(s):
13    ///   - [`channels(Vec::<ChannelSummary>)`](crate::operation::list_channels::ListChannelsOutput::channels): <p>List of the matching channels.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_channels::ListChannelsOutput::next_token): <p>If there are more channels than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
15    /// - On failure, responds with [`SdkError<ListChannelsError>`](crate::operation::list_channels::ListChannelsError)
16    pub fn list_channels(&self) -> crate::operation::list_channels::builders::ListChannelsFluentBuilder {
17        crate::operation::list_channels::builders::ListChannelsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_ivs/client/list_channels.rs

aws_sdk_ivs/client/
list_channels.rs
