Struct aws_sdk_connect::types::UserData

#[non_exhaustive]
pub struct UserData {
    pub user: Option<UserReference>,
    pub routing_profile: Option<RoutingProfileReference>,
    pub hierarchy_path: Option<HierarchyPathReference>,
    pub status: Option<AgentStatusReference>,
    pub available_slots_by_channel: Option<HashMap<Channel, i32>>,
    pub max_slots_by_channel: Option<HashMap<Channel, i32>>,
    pub active_slots_by_channel: Option<HashMap<Channel, i32>>,
    pub contacts: Option<Vec<AgentContactReference>>,
    pub next_status: Option<String>,
}

Data for a user.

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.

user: Option<UserReference>

Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

routing_profile: Option<RoutingProfileReference>

Information about the routing profile that is assigned to the user.

hierarchy_path: Option<HierarchyPathReference>

Contains information about the levels of a hierarchy group assigned to a user.

status: Option<AgentStatusReference>

The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.

available_slots_by_channel: Option<HashMap<Channel, i32>>

A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.

max_slots_by_channel: Option<HashMap<Channel, i32>>

A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.

active_slots_by_channel: Option<HashMap<Channel, i32>>

A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.

contacts: Option<Vec<AgentContactReference>>

A list of contact reference information.

next_status: Option<String>

The Next status of the agent.

Implementations

impl UserData

pub fn user(&self) -> Option<&UserReference>

Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

pub fn routing_profile(&self) -> Option<&RoutingProfileReference>

Information about the routing profile that is assigned to the user.

pub fn hierarchy_path(&self) -> Option<&HierarchyPathReference>

Contains information about the levels of a hierarchy group assigned to a user.

pub fn status(&self) -> Option<&AgentStatusReference>

The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.

pub fn available_slots_by_channel(&self) -> Option<&HashMap<Channel, i32>>

A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.

pub fn max_slots_by_channel(&self) -> Option<&HashMap<Channel, i32>>

A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.

pub fn active_slots_by_channel(&self) -> Option<&HashMap<Channel, i32>>

A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.

pub fn contacts(&self) -> &[AgentContactReference]

A list of contact reference information.

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

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

The Next status of the agent.

impl UserData

pub fn builder() -> UserDataBuilder

Creates a new builder-style object to manufacture UserData.

Trait Implementations

impl Clone for UserData

fn clone(&self) -> UserData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserData

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

Formats the value using the given formatter.

impl PartialEq for UserData

fn eq(&self, other: &UserData) -> 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 UserData