Skip to content

UserData

Source code in docs_src/capo_connect/types/user_data.py
class UserData(TypedDict, closed=True):
    user: NotRequired["capo_connect.types.user_reference.UserReference"]
    """<p>Information about the user for the data that is returned. It contains the <code>resourceId</code> and ARN of the user. </p>"""
    routing_profile: NotRequired[
        "capo_connect.types.routing_profile_reference.RoutingProfileReference"
    ]
    """<p>Information about the routing profile that is assigned to the user.</p>"""
    hierarchy_path: NotRequired[
        "capo_connect.types.hierarchy_path_reference.HierarchyPathReference"
    ]
    """<p>Contains information about the levels of a hierarchy group assigned to a user.</p>"""
    status: NotRequired[
        "capo_connect.types.agent_status_reference.AgentStatusReference"
    ]
    """<p>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.</p>"""
    available_slots_by_channel: NotRequired[
        "capo_connect.types.channel_to_count_map.ChannelToCountMap"
    ]
    """<p>A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots. </p>"""
    max_slots_by_channel: NotRequired[
        "capo_connect.types.channel_to_count_map.ChannelToCountMap"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html">MediaConcurrency</a> of the <code>RoutingProfile</code> assigned to the agent. </p>"""
    active_slots_by_channel: NotRequired[
        "capo_connect.types.channel_to_count_map.ChannelToCountMap"
    ]
    """<p> A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots. </p>"""
    contacts: NotRequired[
        "capo_connect.types.agent_contact_reference_list.AgentContactReferenceList"
    ]
    """<p>A list of contact reference information.</p>"""
    next_status: NotRequired["capo_connect.types.agent_status_name.AgentStatusName"]
    """<p>The Next status of the agent.</p>"""

active_slots_by_channel instance-attribute

active_slots_by_channel: NotRequired[ChannelToCountMap]

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

available_slots_by_channel instance-attribute

available_slots_by_channel: NotRequired[ChannelToCountMap]

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

contacts instance-attribute

contacts: NotRequired[AgentContactReferenceList]

A list of contact reference information.

hierarchy_path instance-attribute

hierarchy_path: NotRequired[HierarchyPathReference]

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

max_slots_by_channel instance-attribute

max_slots_by_channel: NotRequired[ChannelToCountMap]

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.

next_status instance-attribute

next_status: NotRequired[AgentStatusName]

The Next status of the agent.

routing_profile instance-attribute

routing_profile: NotRequired[RoutingProfileReference]

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

status instance-attribute

status: NotRequired[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.

user instance-attribute

user: NotRequired[UserReference]

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