aws_sdk_gameliftstreams/client/

list_stream_sessions_by_account.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListStreamSessionsByAccount`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`status(StreamSessionStatus)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::status) / [`set_status(Option<StreamSessionStatus>)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::set_status):<br>required: **false**<br><p>Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.</p><br>
    ///   - [`export_files_status(ExportFilesStatus)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::export_files_status) / [`set_export_files_status(Option<ExportFilesStatus>)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::set_export_files_status):<br>required: **false**<br><p>Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::set_max_results):<br>required: **false**<br><p>The number of results to return. Use this parameter with <code>NextToken</code> to return results in sequential pages. Default value is <code>25</code>.</p><br>
    /// - On success, responds with [`ListStreamSessionsByAccountOutput`](crate::operation::list_stream_sessions_by_account::ListStreamSessionsByAccountOutput) with field(s):
    ///   - [`items(Option<Vec::<StreamSessionSummary>>)`](crate::operation::list_stream_sessions_by_account::ListStreamSessionsByAccountOutput::items): <p>A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_stream_sessions_by_account::ListStreamSessionsByAccountOutput::next_token): <p>A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list.</p>
    /// - On failure, responds with [`SdkError<ListStreamSessionsByAccountError>`](crate::operation::list_stream_sessions_by_account::ListStreamSessionsByAccountError)
    pub fn list_stream_sessions_by_account(
        &self,
    ) -> crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder {
        crate::operation::list_stream_sessions_by_account::builders::ListStreamSessionsByAccountFluentBuilder::new(self.handle.clone())
    }
}