aws_sdk_wickr/client/
batch_toggle_user_suspend_status.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 [`BatchToggleUserSuspendStatus`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`network_id(impl Into<String>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network where users will be suspended or unsuspended.</p><br>
7    ///   - [`suspend(bool)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::suspend) / [`set_suspend(Option<bool>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::set_suspend):<br>required: **true**<br><p>A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.</p><br>
8    ///   - [`user_ids(impl Into<String>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::user_ids) / [`set_user_ids(Option<Vec::<String>>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::set_user_ids):<br>required: **true**<br><p>A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.</p><br>
9    ///   - [`client_token(impl Into<String>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique identifier for this request to ensure idempotency.</p><br>
10    /// - On success, responds with [`BatchToggleUserSuspendStatusOutput`](crate::operation::batch_toggle_user_suspend_status::BatchToggleUserSuspendStatusOutput) with field(s):
11    ///   - [`message(Option<String>)`](crate::operation::batch_toggle_user_suspend_status::BatchToggleUserSuspendStatusOutput::message): <p>A message indicating the overall result of the batch suspend status toggle operation.</p>
12    ///   - [`successful(Option<Vec::<BatchUserSuccessResponseItem>>)`](crate::operation::batch_toggle_user_suspend_status::BatchToggleUserSuspendStatusOutput::successful): <p>A list of user IDs whose suspend status was successfully toggled.</p>
13    ///   - [`failed(Option<Vec::<BatchUserErrorResponseItem>>)`](crate::operation::batch_toggle_user_suspend_status::BatchToggleUserSuspendStatusOutput::failed): <p>A list of suspend status toggle attempts that failed, including error details explaining why each user's status could not be changed.</p>
14    /// - On failure, responds with [`SdkError<BatchToggleUserSuspendStatusError>`](crate::operation::batch_toggle_user_suspend_status::BatchToggleUserSuspendStatusError)
15    pub fn batch_toggle_user_suspend_status(
16        &self,
17    ) -> crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder {
18        crate::operation::batch_toggle_user_suspend_status::builders::BatchToggleUserSuspendStatusFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_wickr/client/batch_toggle_user_suspend_status.rs

aws_sdk_wickr/client/
batch_toggle_user_suspend_status.rs
