aws_sdk_wickr/client/batch_lookup_user_uname.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 [`BatchLookupUserUname`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`network_id(impl Into<String>)`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network where the users will be looked up.</p><br>
7 /// - [`unames(impl Into<String>)`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::unames) / [`set_unames(Option<Vec::<String>>)`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::set_unames):<br>required: **true**<br><p>A list of username hashes (unames) to look up. Each uname is a unique identifier for a user's username. Maximum 50 unames per batch request.</p><br>
8 /// - [`client_token(impl Into<String>)`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique identifier for this request to ensure idempotency.</p><br>
9 /// - On success, responds with [`BatchLookupUserUnameOutput`](crate::operation::batch_lookup_user_uname::BatchLookupUserUnameOutput) with field(s):
10 /// - [`message(Option<String>)`](crate::operation::batch_lookup_user_uname::BatchLookupUserUnameOutput::message): <p>A message indicating the overall result of the batch lookup operation.</p>
11 /// - [`successful(Option<Vec::<BatchUnameSuccessResponseItem>>)`](crate::operation::batch_lookup_user_uname::BatchLookupUserUnameOutput::successful): <p>A list of successfully resolved username hashes with their corresponding email addresses.</p>
12 /// - [`failed(Option<Vec::<BatchUnameErrorResponseItem>>)`](crate::operation::batch_lookup_user_uname::BatchLookupUserUnameOutput::failed): <p>A list of username hash lookup attempts that failed, including error details explaining why each lookup failed.</p>
13 /// - On failure, responds with [`SdkError<BatchLookupUserUnameError>`](crate::operation::batch_lookup_user_uname::BatchLookupUserUnameError)
14 pub fn batch_lookup_user_uname(&self) -> crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder {
15 crate::operation::batch_lookup_user_uname::builders::BatchLookupUserUnameFluentBuilder::new(self.handle.clone())
16 }
17}