aws_sdk_workspaces/client/describe_workspaces_pool_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 [`DescribeWorkspacesPoolSessions`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`pool_id(impl Into<String>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::pool_id) / [`set_pool_id(Option<String>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::set_pool_id):<br>required: **true**<br><p>The identifier of the pool.</p><br>
7 /// - [`user_id(impl Into<String>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::set_user_id):<br>required: **false**<br><p>The identifier of the user.</p><br>
8 /// - [`limit(i32)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum size of each page of results. The default value is 20 and the maximum value is 50.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::set_next_token):<br>required: **false**<br><p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p><br>
10 /// - On success, responds with [`DescribeWorkspacesPoolSessionsOutput`](crate::operation::describe_workspaces_pool_sessions::DescribeWorkspacesPoolSessionsOutput) with field(s):
11 /// - [`sessions(Option<Vec::<WorkspacesPoolSession>>)`](crate::operation::describe_workspaces_pool_sessions::DescribeWorkspacesPoolSessionsOutput::sessions): <p>Describes the pool sessions.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::describe_workspaces_pool_sessions::DescribeWorkspacesPoolSessionsOutput::next_token): <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.</p>
13 /// - On failure, responds with [`SdkError<DescribeWorkspacesPoolSessionsError>`](crate::operation::describe_workspaces_pool_sessions::DescribeWorkspacesPoolSessionsError)
14 pub fn describe_workspaces_pool_sessions(
15 &self,
16 ) -> crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder {
17 crate::operation::describe_workspaces_pool_sessions::builders::DescribeWorkspacesPoolSessionsFluentBuilder::new(self.handle.clone())
18 }
19}