aws_sdk_iottwinmaker/client/
list_workspaces.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 [`ListWorkspaces`](crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
9    /// - On success, responds with [`ListWorkspacesOutput`](crate::operation::list_workspaces::ListWorkspacesOutput) with field(s):
10    ///   - [`workspace_summaries(Option<Vec::<WorkspaceSummary>>)`](crate::operation::list_workspaces::ListWorkspacesOutput::workspace_summaries): <p>A list of objects that contain information about the workspaces.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_workspaces::ListWorkspacesOutput::next_token): <p>The string that specifies the next page of results.</p>
12    /// - On failure, responds with [`SdkError<ListWorkspacesError>`](crate::operation::list_workspaces::ListWorkspacesError)
13    pub fn list_workspaces(&self) -> crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder {
14        crate::operation::list_workspaces::builders::ListWorkspacesFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_iottwinmaker/client/list_workspaces.rs

aws_sdk_iottwinmaker/client/
list_workspaces.rs
