aws_sdk_novaact/client/
list_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 [`ListSessions`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workflow_definition_name(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::workflow_definition_name) / [`set_workflow_definition_name(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_workflow_definition_name):<br>required: **true**<br><p>The name of the workflow definition containing the workflow run.</p><br>
8    ///   - [`workflow_run_id(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::workflow_run_id) / [`set_workflow_run_id(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_workflow_run_id):<br>required: **true**<br><p>The unique identifier of the workflow run to list sessions for.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of sessions to return in a single response.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for retrieving the next page of results.</p><br>
11    ///   - [`sort_order(SortOrder)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for the returned sessions (ascending or descending).</p><br>
12    /// - On success, responds with [`ListSessionsOutput`](crate::operation::list_sessions::ListSessionsOutput) with field(s):
13    ///   - [`session_summaries(Vec::<SessionSummary>)`](crate::operation::list_sessions::ListSessionsOutput::session_summaries): <p>A list of summary information for sessions in the workflow run.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_sessions::ListSessionsOutput::next_token): <p>The token for retrieving the next page of results, if available.</p>
15    /// - On failure, responds with [`SdkError<ListSessionsError>`](crate::operation::list_sessions::ListSessionsError)
16    pub fn list_sessions(&self) -> crate::operation::list_sessions::builders::ListSessionsFluentBuilder {
17        crate::operation::list_sessions::builders::ListSessionsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_novaact/client/list_sessions.rs

aws_sdk_novaact/client/
list_sessions.rs
