aws_sdk_wickr/client/

batch_create_user.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchCreateUser`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`network_id(impl Into<String>)`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network where users will be created.</p><br>
    ///   - [`users(BatchCreateUserRequestItem)`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::users) / [`set_users(Option<Vec::<BatchCreateUserRequestItem>>)`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::set_users):<br>required: **true**<br><p>A list of user objects containing the details for each user to be created, including username, name, security groups, and optional invite codes. Maximum 50 users per batch request.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique identifier for this request to ensure idempotency. If you retry a request with the same client token, the service will return the same response without creating duplicate users.</p><br>
    /// - On success, responds with [`BatchCreateUserOutput`](crate::operation::batch_create_user::BatchCreateUserOutput) with field(s):
    ///   - [`message(Option<String>)`](crate::operation::batch_create_user::BatchCreateUserOutput::message): <p>A message indicating the overall result of the batch operation.</p>
    ///   - [`successful(Option<Vec::<User>>)`](crate::operation::batch_create_user::BatchCreateUserOutput::successful): <p>A list of user objects that were successfully created, including their assigned user IDs and invite codes.</p>
    ///   - [`failed(Option<Vec::<BatchUserErrorResponseItem>>)`](crate::operation::batch_create_user::BatchCreateUserOutput::failed): <p>A list of user creation attempts that failed, including error details explaining why each user could not be created.</p>
    /// - On failure, responds with [`SdkError<BatchCreateUserError>`](crate::operation::batch_create_user::BatchCreateUserError)
    pub fn batch_create_user(&self) -> crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder {
        crate::operation::batch_create_user::builders::BatchCreateUserFluentBuilder::new(self.handle.clone())
    }
}