aws_sdk_mpa/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    ///   - [`approval_team_arn(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::approval_team_arn) / [`set_approval_team_arn(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_approval_team_arn):<br>required: **true**<br><p>Amazon Resource Name (ARN) for the approval team.</p><br>
8    ///   - [`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 items to return in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that you can retrieve the remaining results.</p><br>
9    ///   - [`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>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a next call to the operation to get more output. You can repeat this until the <code>NextToken</code> response element returns <code>null</code>.</p><br>
10    ///   - [`filters(Filter)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of <code>Filter</code> objects. Contains the filter to apply when listing sessions.</p><br>
11    /// - On success, responds with [`ListSessionsOutput`](crate::operation::list_sessions::ListSessionsOutput) with field(s):
12    ///   - [`next_token(Option<String>)`](crate::operation::list_sessions::ListSessionsOutput::next_token): <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a next call to the operation to get more output. You can repeat this until the <code>NextToken</code> response element returns <code>null</code>.</p>
13    ///   - [`sessions(Option<Vec::<ListSessionsResponseSession>>)`](crate::operation::list_sessions::ListSessionsOutput::sessions): <p>An array of <code>ListSessionsResponseSession</code> objects. Contains details for the sessions.</p>
14    /// - On failure, responds with [`SdkError<ListSessionsError>`](crate::operation::list_sessions::ListSessionsError)
15    pub fn list_sessions(&self) -> crate::operation::list_sessions::builders::ListSessionsFluentBuilder {
16        crate::operation::list_sessions::builders::ListSessionsFluentBuilder::new(self.handle.clone())
17    }
18}