aws_sdk_workdocs/client/
describe_users.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeUsers`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`authentication_token(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::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>
    ///   - [`organization_id(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_organization_id):<br>required: **false**<br><p>The ID of the organization.</p><br>
    ///   - [`user_ids(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::user_ids) / [`set_user_ids(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_user_ids):<br>required: **false**<br><p>The IDs of the users.</p><br>
    ///   - [`query(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::query) / [`set_query(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_query):<br>required: **false**<br><p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p> <ul>  <li>   <p>If you don't use either parameter, the API returns a paginated list of all users on the site.</p></li>  <li>   <p>If you use both parameters, the API ignores the <code>Query</code> parameter.</p></li>  <li>   <p>The <code>Userid</code> parameter only returns user names that match a corresponding user ID.</p></li>  <li>   <p>The <code>Query</code> parameter runs a "prefix" search for users by the <code>GivenName</code>, <code>SurName</code>, or <code>UserName</code> fields included in a <a href="https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html">CreateUser</a> API call. For example, querying on <code>Ma</code> returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on <code>Ma J</code> only returns Mateo Jackson.</p></li> </ul><br>
    ///   - [`include(UserFilterType)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::include) / [`set_include(Option<UserFilterType>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_include):<br>required: **false**<br><p>The state of the users. Specify "ALL" to include inactive users.</p><br>
    ///   - [`order(OrderType)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::order) / [`set_order(Option<OrderType>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_order):<br>required: **false**<br><p>The order for the results.</p><br>
    ///   - [`sort(UserSortType)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::sort) / [`set_sort(Option<UserSortType>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_sort):<br>required: **false**<br><p>The sorting criteria.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::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>
    ///   - [`limit(i32)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of items to return.</p><br>
    ///   - [`fields(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::fields) / [`set_fields(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_fields):<br>required: **false**<br><p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.</p><br>
    /// - On success, responds with [`DescribeUsersOutput`](crate::operation::describe_users::DescribeUsersOutput) with field(s):
    ///   - [`users(Option<Vec::<User>>)`](crate::operation::describe_users::DescribeUsersOutput::users): <p>The users.</p>
    ///   - [`total_number_of_users(Option<i64>)`](crate::operation::describe_users::DescribeUsersOutput::total_number_of_users): <p>The total number of users included in the results.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_users::DescribeUsersOutput::marker): <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
    /// - On failure, responds with [`SdkError<DescribeUsersError>`](crate::operation::describe_users::DescribeUsersError)
    pub fn describe_users(&self) -> crate::operation::describe_users::builders::DescribeUsersFluentBuilder {
        crate::operation::describe_users::builders::DescribeUsersFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_workdocs/client/describe_users.rs

aws_sdk_workdocs/client/
describe_users.rs
