aws_sdk_ivs/client/
list_stream_sessions.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 [`ListStreamSessions`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`channel_arn(impl Into<String>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::channel_arn) / [`set_channel_arn(Option<String>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::set_channel_arn):<br>required: **true**<br><p>Channel ARN used to filter the list.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The first stream to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::set_max_results):<br>required: **false**<br><p>Maximum number of streams to return. Default: 100.</p><br>
10    /// - On success, responds with [`ListStreamSessionsOutput`](crate::operation::list_stream_sessions::ListStreamSessionsOutput) with field(s):
11    ///   - [`stream_sessions(Vec::<StreamSessionSummary>)`](crate::operation::list_stream_sessions::ListStreamSessionsOutput::stream_sessions): <p>List of stream sessions.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_stream_sessions::ListStreamSessionsOutput::next_token): <p>If there are more streams than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
13    /// - On failure, responds with [`SdkError<ListStreamSessionsError>`](crate::operation::list_stream_sessions::ListStreamSessionsError)
14    pub fn list_stream_sessions(&self) -> crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder {
15        crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::new(self.handle.clone())
16    }
17}