aws_sdk_chime/operation/batch_suspend_user/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_suspend_user::_batch_suspend_user_output::BatchSuspendUserOutputBuilder;
3
4pub use crate::operation::batch_suspend_user::_batch_suspend_user_input::BatchSuspendUserInputBuilder;
5
6impl crate::operation::batch_suspend_user::builders::BatchSuspendUserInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::batch_suspend_user::BatchSuspendUserOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_suspend_user::BatchSuspendUserError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_suspend_user();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchSuspendUser`.
24///
25/// <p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p>
26/// <p>Users suspended from a <code>Team</code> account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <code>InviteUsers</code> action to do so.</p>
27/// <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <code>BatchUnsuspendUser</code> action.</p>
28/// <p>To sign out users without suspending them, use the <code>LogoutUser</code> action.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct BatchSuspendUserFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::batch_suspend_user::builders::BatchSuspendUserInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::batch_suspend_user::BatchSuspendUserOutput,
38        crate::operation::batch_suspend_user::BatchSuspendUserError,
39    > for BatchSuspendUserFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::batch_suspend_user::BatchSuspendUserOutput,
47            crate::operation::batch_suspend_user::BatchSuspendUserError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl BatchSuspendUserFluentBuilder {
54    /// Creates a new `BatchSuspendUserFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the BatchSuspendUser as a reference.
63    pub fn as_input(&self) -> &crate::operation::batch_suspend_user::builders::BatchSuspendUserInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::batch_suspend_user::BatchSuspendUserOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::batch_suspend_user::BatchSuspendUserError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::batch_suspend_user::BatchSuspendUser::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::batch_suspend_user::BatchSuspendUser::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::batch_suspend_user::BatchSuspendUserOutput,
100        crate::operation::batch_suspend_user::BatchSuspendUserError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>The Amazon Chime account ID.</p>
115    pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.account_id(input.into());
117        self
118    }
119    /// <p>The Amazon Chime account ID.</p>
120    pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_account_id(input);
122        self
123    }
124    /// <p>The Amazon Chime account ID.</p>
125    pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
126        self.inner.get_account_id()
127    }
128    ///
129    /// Appends an item to `UserIdList`.
130    ///
131    /// To override the contents of this collection use [`set_user_id_list`](Self::set_user_id_list).
132    ///
133    /// <p>The request containing the user IDs to suspend.</p>
134    pub fn user_id_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.user_id_list(input.into());
136        self
137    }
138    /// <p>The request containing the user IDs to suspend.</p>
139    pub fn set_user_id_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
140        self.inner = self.inner.set_user_id_list(input);
141        self
142    }
143    /// <p>The request containing the user IDs to suspend.</p>
144    pub fn get_user_id_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
145        self.inner.get_user_id_list()
146    }
147}
aws_sdk_chime/operation/batch_suspend_user/builders.rs

aws_sdk_chime/operation/batch_suspend_user/
builders.rs
