Struct aws_sdk_ivschat::operation::create_chat_token::CreateChatTokenInput

#[non_exhaustive]
pub struct CreateChatTokenInput {
    pub room_identifier: Option<String>,
    pub user_id: Option<String>,
    pub capabilities: Option<Vec<ChatTokenCapability>>,
    pub session_duration_in_minutes: Option<i32>,
    pub attributes: Option<HashMap<String, String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

room_identifier: Option<String>

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

user_id: Option<String>

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

capabilities: 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).

session_duration_in_minutes: Option<i32>

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

attributes: 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.

Implementations

impl CreateChatTokenInput

pub fn room_identifier(&self) -> Option<&str>

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

pub fn user_id(&self) -> Option<&str>

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

pub fn capabilities(&self) -> &[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).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capabilities.is_none().

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

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

pub fn 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.

impl CreateChatTokenInput

pub fn builder() -> CreateChatTokenInputBuilder

Creates a new builder-style object to manufacture CreateChatTokenInput.

Trait Implementations

impl Clone for CreateChatTokenInput

fn clone(&self) -> CreateChatTokenInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChatTokenInput

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

Formats the value using the given formatter.

impl PartialEq for CreateChatTokenInput

fn eq(&self, other: &CreateChatTokenInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateChatTokenInput