aws_sdk_wickr/client/

batch_delete_user.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchDeleteUser`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`network_id(impl Into<String>)`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network from which users will be deleted.</p><br>
    ///   - [`user_ids(impl Into<String>)`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::user_ids) / [`set_user_ids(Option<Vec::<String>>)`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::set_user_ids):<br>required: **true**<br><p>A list of user IDs identifying the users to be deleted from the network. Maximum 50 users per batch request.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::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 attempting to delete users again.</p><br>
    /// - On success, responds with [`BatchDeleteUserOutput`](crate::operation::batch_delete_user::BatchDeleteUserOutput) with field(s):
    ///   - [`message(Option<String>)`](crate::operation::batch_delete_user::BatchDeleteUserOutput::message): <p>A message indicating the overall result of the batch deletion operation.</p>
    ///   - [`successful(Option<Vec::<BatchUserSuccessResponseItem>>)`](crate::operation::batch_delete_user::BatchDeleteUserOutput::successful): <p>A list of user IDs that were successfully deleted from the network.</p>
    ///   - [`failed(Option<Vec::<BatchUserErrorResponseItem>>)`](crate::operation::batch_delete_user::BatchDeleteUserOutput::failed): <p>A list of user deletion attempts that failed, including error details explaining why each user could not be deleted.</p>
    /// - On failure, responds with [`SdkError<BatchDeleteUserError>`](crate::operation::batch_delete_user::BatchDeleteUserError)
    pub fn batch_delete_user(&self) -> crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder {
        crate::operation::batch_delete_user::builders::BatchDeleteUserFluentBuilder::new(self.handle.clone())
    }
}