1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_users::_describe_users_output::DescribeUsersOutputBuilder;
pub use crate::operation::describe_users::_describe_users_input::DescribeUsersInputBuilder;
/// Fluent builder constructing a request to `DescribeUsers`.
///
/// <p>Describes the specified users. You can describe all users or filter the results (for example, by status or organization).</p>
/// <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeUsersFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_users::builders::DescribeUsersInputBuilder,
}
impl DescribeUsersFluentBuilder {
/// Creates a new `DescribeUsers`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::describe_users::DescribeUsers,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::describe_users::DescribeUsersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::describe_users::DescribeUsersOutput,
aws_smithy_http::result::SdkError<crate::operation::describe_users::DescribeUsersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::describe_users::paginator::DescribeUsersPaginator::send) which returns a `Stream`.
pub fn into_paginator(
self,
) -> crate::operation::describe_users::paginator::DescribeUsersPaginator {
crate::operation::describe_users::paginator::DescribeUsersPaginator::new(
self.handle,
self.inner,
)
}
/// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
pub fn authentication_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.authentication_token(input.into());
self
}
/// <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
pub fn set_authentication_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_authentication_token(input);
self
}
/// <p>The ID of the organization.</p>
pub fn organization_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.organization_id(input.into());
self
}
/// <p>The ID of the organization.</p>
pub fn set_organization_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_organization_id(input);
self
}
/// <p>The IDs of the users.</p>
pub fn user_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_ids(input.into());
self
}
/// <p>The IDs of the users.</p>
pub fn set_user_ids(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_ids(input);
self
}
/// <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>
pub fn query(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.query(input.into());
self
}
/// <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>
pub fn set_query(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_query(input);
self
}
/// <p>The state of the users. Specify "ALL" to include inactive users.</p>
pub fn include(mut self, input: crate::types::UserFilterType) -> Self {
self.inner = self.inner.include(input);
self
}
/// <p>The state of the users. Specify "ALL" to include inactive users.</p>
pub fn set_include(mut self, input: std::option::Option<crate::types::UserFilterType>) -> Self {
self.inner = self.inner.set_include(input);
self
}
/// <p>The order for the results.</p>
pub fn order(mut self, input: crate::types::OrderType) -> Self {
self.inner = self.inner.order(input);
self
}
/// <p>The order for the results.</p>
pub fn set_order(mut self, input: std::option::Option<crate::types::OrderType>) -> Self {
self.inner = self.inner.set_order(input);
self
}
/// <p>The sorting criteria.</p>
pub fn sort(mut self, input: crate::types::UserSortType) -> Self {
self.inner = self.inner.sort(input);
self
}
/// <p>The sorting criteria.</p>
pub fn set_sort(mut self, input: std::option::Option<crate::types::UserSortType>) -> Self {
self.inner = self.inner.set_sort(input);
self
}
/// <p>The marker for the next set of results. (You received this marker from a previous call.)</p>
pub fn marker(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.marker(input.into());
self
}
/// <p>The marker for the next set of results. (You received this marker from a previous call.)</p>
pub fn set_marker(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_marker(input);
self
}
/// <p>The maximum number of items to return.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of items to return.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.</p>
pub fn fields(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fields(input.into());
self
}
/// <p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.</p>
pub fn set_fields(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fields(input);
self
}
}