aws_sdk_wickr/client/batch_reinvite_user.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 [`BatchReinviteUser`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`network_id(impl Into<String>)`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network where users will be reinvited.</p><br>
7 /// - [`user_ids(impl Into<String>)`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::user_ids) / [`set_user_ids(Option<Vec::<String>>)`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::set_user_ids):<br>required: **true**<br><p>A list of user IDs identifying the users to be reinvited to the network. Maximum 50 users per batch request.</p><br>
8 /// - [`client_token(impl Into<String>)`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique identifier for this request to ensure idempotency.</p><br>
9 /// - On success, responds with [`BatchReinviteUserOutput`](crate::operation::batch_reinvite_user::BatchReinviteUserOutput) with field(s):
10 /// - [`message(Option<String>)`](crate::operation::batch_reinvite_user::BatchReinviteUserOutput::message): <p>A message indicating the overall result of the batch reinvitation operation.</p>
11 /// - [`successful(Option<Vec::<BatchUserSuccessResponseItem>>)`](crate::operation::batch_reinvite_user::BatchReinviteUserOutput::successful): <p>A list of user IDs that were successfully reinvited.</p>
12 /// - [`failed(Option<Vec::<BatchUserErrorResponseItem>>)`](crate::operation::batch_reinvite_user::BatchReinviteUserOutput::failed): <p>A list of reinvitation attempts that failed, including error details explaining why each user could not be reinvited.</p>
13 /// - On failure, responds with [`SdkError<BatchReinviteUserError>`](crate::operation::batch_reinvite_user::BatchReinviteUserError)
14 pub fn batch_reinvite_user(&self) -> crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder {
15 crate::operation::batch_reinvite_user::builders::BatchReinviteUserFluentBuilder::new(self.handle.clone())
16 }
17}