Struct aws_sdk_ivschat::operation::disconnect_user::builders::DisconnectUserFluentBuilder

pub struct DisconnectUserFluentBuilder { /* private fields */ }

Fluent builder constructing a request to DisconnectUser.

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Implementations

impl DisconnectUserFluentBuilder

pub fn as_input(&self) -> &DisconnectUserInputBuilder

Access the DisconnectUser as a reference.

pub async fn send( self ) -> Result<DisconnectUserOutput, SdkError<DisconnectUserError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<DisconnectUserOutput, DisconnectUserError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn room_identifier(self, input: impl Into<String>) -> Self

Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

pub fn set_room_identifier(self, input: Option<String>) -> Self

Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

pub fn get_room_identifier(&self) -> &Option<String>

Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

pub fn user_id(self, input: impl Into<String>) -> Self

ID of the user (connection) to disconnect from the room.

pub fn set_user_id(self, input: Option<String>) -> Self

ID of the user (connection) to disconnect from the room.

pub fn get_user_id(&self) -> &Option<String>

ID of the user (connection) to disconnect from the room.

pub fn reason(self, input: impl Into<String>) -> Self

Reason for disconnecting the user.

pub fn set_reason(self, input: Option<String>) -> Self

Reason for disconnecting the user.

pub fn get_reason(&self) -> &Option<String>

Reason for disconnecting the user.

Trait Implementations

impl Clone for DisconnectUserFluentBuilder

fn clone(&self) -> DisconnectUserFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisconnectUserFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.