aws_sdk_workspaces/client/
describe_workspace_directories.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 [`DescribeWorkspaceDirectories`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`directory_ids(impl Into<String>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::directory_ids) / [`set_directory_ids(Option<Vec::<String>>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::set_directory_ids):<br>required: **false**<br><p>The identifiers of the directories. If the value is null, all directories are retrieved.</p><br>
8    ///   - [`workspace_directory_names(impl Into<String>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::workspace_directory_names) / [`set_workspace_directory_names(Option<Vec::<String>>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::set_workspace_directory_names):<br>required: **false**<br><p>The names of the WorkSpace directories.</p><br>
9    ///   - [`limit(i32)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of directories to return.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::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>
11    ///   - [`filters(DescribeWorkspaceDirectoriesFilter)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::filters) / [`set_filters(Option<Vec::<DescribeWorkspaceDirectoriesFilter>>)`](crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::set_filters):<br>required: **false**<br><p>The filter condition for the WorkSpaces.</p><br>
12    /// - On success, responds with [`DescribeWorkspaceDirectoriesOutput`](crate::operation::describe_workspace_directories::DescribeWorkspaceDirectoriesOutput) with field(s):
13    ///   - [`directories(Option<Vec::<WorkspaceDirectory>>)`](crate::operation::describe_workspace_directories::DescribeWorkspaceDirectoriesOutput::directories): <p>Information about the directories.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_workspace_directories::DescribeWorkspaceDirectoriesOutput::next_token): <p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>
15    /// - On failure, responds with [`SdkError<DescribeWorkspaceDirectoriesError>`](crate::operation::describe_workspace_directories::DescribeWorkspaceDirectoriesError)
16    pub fn describe_workspace_directories(
17        &self,
18    ) -> crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder {
19        crate::operation::describe_workspace_directories::builders::DescribeWorkspaceDirectoriesFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_workspaces/client/describe_workspace_directories.rs

aws_sdk_workspaces/client/
describe_workspace_directories.rs
