aws_sdk_workdocs/client/
describe_groups.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 [`DescribeGroups`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`authentication_token(impl Into<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::set_authentication_token):<br>required: **false**<br><p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p><br>
8    ///   - [`search_query(impl Into<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::search_query) / [`set_search_query(Option<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::set_search_query):<br>required: **true**<br><p>A query to describe groups by group name.</p><br>
9    ///   - [`organization_id(impl Into<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::set_organization_id):<br>required: **false**<br><p>The ID of the organization.</p><br>
10    ///   - [`marker(impl Into<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::set_marker):<br>required: **false**<br><p>The marker for the next set of results. (You received this marker from a previous call.)</p><br>
11    ///   - [`limit(i32)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of items to return with this call.</p><br>
12    /// - On success, responds with [`DescribeGroupsOutput`](crate::operation::describe_groups::DescribeGroupsOutput) with field(s):
13    ///   - [`groups(Option<Vec::<GroupMetadata>>)`](crate::operation::describe_groups::DescribeGroupsOutput::groups): <p>The list of groups.</p>
14    ///   - [`marker(Option<String>)`](crate::operation::describe_groups::DescribeGroupsOutput::marker): <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
15    /// - On failure, responds with [`SdkError<DescribeGroupsError>`](crate::operation::describe_groups::DescribeGroupsError)
16    pub fn describe_groups(&self) -> crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder {
17        crate::operation::describe_groups::builders::DescribeGroupsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_workdocs/client/describe_groups.rs

aws_sdk_workdocs/client/
describe_groups.rs
