Struct aws_sdk_ivschat::operation::create_chat_token::builders::CreateChatTokenFluentBuilder

pub struct CreateChatTokenFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateChatToken.

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

Implementations

impl CreateChatTokenFluentBuilder

pub fn as_input(&self) -> &CreateChatTokenInputBuilder

Access the CreateChatToken as a reference.

pub async fn send( self ) -> Result<CreateChatTokenOutput, SdkError<CreateChatTokenError, 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<CreateChatTokenOutput, CreateChatTokenError, 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 that the client is trying to access. Currently this must be an ARN.

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

Identifier of the room that the client is trying to access. Currently this must be an ARN.

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

Identifier of the room that the client is trying to access. Currently this must be an ARN.

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

Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

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

Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

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

Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

pub fn capabilities(self, input: ChatTokenCapability) -> Self

Appends an item to capabilities.

To override the contents of this collection use set_capabilities.

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

pub fn set_capabilities(self, input: Option<Vec<ChatTokenCapability>>) -> Self

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

pub fn get_capabilities(&self) -> &Option<Vec<ChatTokenCapability>>

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

pub fn session_duration_in_minutes(self, input: i32) -> Self

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

pub fn set_session_duration_in_minutes(self, input: Option<i32>) -> Self

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

pub fn get_session_duration_in_minutes(&self) -> &Option<i32>

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

pub fn attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to attributes.

To override the contents of this collection use set_attributes.

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

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

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

pub fn get_attributes(&self) -> &Option<HashMap<String, String>>

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

Trait Implementations

impl Clone for CreateChatTokenFluentBuilder

fn clone(&self) -> CreateChatTokenFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChatTokenFluentBuilder

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

Formats the value using the given formatter.