aws_sdk_gameliftstreams/client/

list_stream_sessions.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListStreamSessions`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`status(StreamSessionStatus)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::status) / [`set_status(Option<StreamSessionStatus>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::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::builders::ListStreamSessionsFluentBuilder::export_files_status) / [`set_export_files_status(Option<ExportFilesStatus>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::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> <p>Exported files can be in one of the following states:</p> <ul>  <li>   <p><code>SUCCEEDED</code>: The exported files are successfully stored in an S3 bucket.</p></li>  <li>   <p><code>FAILED</code>: The session ended but Amazon GameLift Streams couldn't collect and upload the files to S3.</p></li>  <li>   <p><code>PENDING</code>: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.</p></li> </ul><br>
    ///   - [`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 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::builders::ListStreamSessionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::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>
    ///   - [`identifier(impl Into<String>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::set_identifier):<br>required: **true**<br><p>The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a>.</p><br>
    /// - On success, responds with [`ListStreamSessionsOutput`](crate::operation::list_stream_sessions::ListStreamSessionsOutput) with field(s):
    ///   - [`items(Option<Vec::<StreamSessionSummary>>)`](crate::operation::list_stream_sessions::ListStreamSessionsOutput::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::ListStreamSessionsOutput::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<ListStreamSessionsError>`](crate::operation::list_stream_sessions::ListStreamSessionsError)
    pub fn list_stream_sessions(&self) -> crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder {
        crate::operation::list_stream_sessions::builders::ListStreamSessionsFluentBuilder::new(self.handle.clone())
    }
}