aws_sdk_workspaces/client/describe_workspaces_pools.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 [`DescribeWorkspacesPools`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`pool_ids(impl Into<String>)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::pool_ids) / [`set_pool_ids(Option<Vec::<String>>)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::set_pool_ids):<br>required: **false**<br><p>The identifier of the WorkSpaces Pools.</p><br>
7 /// - [`filters(DescribeWorkspacesPoolsFilter)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::filters) / [`set_filters(Option<Vec::<DescribeWorkspacesPoolsFilter>>)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::set_filters):<br>required: **false**<br><p>The filter conditions for the WorkSpaces Pool to return.</p><br>
8 /// - [`limit(i32)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of items to return.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::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 [`DescribeWorkspacesPoolsOutput`](crate::operation::describe_workspaces_pools::DescribeWorkspacesPoolsOutput) with field(s):
11 /// - [`workspaces_pools(Option<Vec::<WorkspacesPool>>)`](crate::operation::describe_workspaces_pools::DescribeWorkspacesPoolsOutput::workspaces_pools): <p>Information about the WorkSpaces Pools.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::describe_workspaces_pools::DescribeWorkspacesPoolsOutput::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<DescribeWorkspacesPoolsError>`](crate::operation::describe_workspaces_pools::DescribeWorkspacesPoolsError)
14 pub fn describe_workspaces_pools(&self) -> crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder {
15 crate::operation::describe_workspaces_pools::builders::DescribeWorkspacesPoolsFluentBuilder::new(self.handle.clone())
16 }
17}