aws_sdk_ivschat/client/
disconnect_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 [`DisconnectUser`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`room_identifier(impl Into<String>)`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::room_identifier) / [`set_room_identifier(Option<String>)`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::set_room_identifier):<br>required: **true**<br><p>Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.</p><br>
7    ///   - [`user_id(impl Into<String>)`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::set_user_id):<br>required: **true**<br><p>ID of the user (connection) to disconnect from the room.</p><br>
8    ///   - [`reason(impl Into<String>)`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::reason) / [`set_reason(Option<String>)`](crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::set_reason):<br>required: **false**<br><p>Reason for disconnecting the user.</p><br>
9    /// - On success, responds with [`DisconnectUserOutput`](crate::operation::disconnect_user::DisconnectUserOutput)
10    /// - On failure, responds with [`SdkError<DisconnectUserError>`](crate::operation::disconnect_user::DisconnectUserError)
11    pub fn disconnect_user(&self) -> crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder {
12        crate::operation::disconnect_user::builders::DisconnectUserFluentBuilder::new(self.handle.clone())
13    }
14}