Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Connect.Types.UserData

Description

Synopsis

data UserData = UserData' {
- activeSlotsByChannel :: Maybe (HashMap Channel Natural)
- availableSlotsByChannel :: Maybe (HashMap Channel Natural)
- contacts :: Maybe [AgentContactReference]
- hierarchyPath :: Maybe HierarchyPathReference
- maxSlotsByChannel :: Maybe (HashMap Channel Natural)
- nextStatus :: Maybe Text
- routingProfile :: Maybe RoutingProfileReference
- status :: Maybe AgentStatusReference
- user :: Maybe UserReference
}
newUserData :: UserData
userData_activeSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural))
userData_availableSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural))
userData_contacts :: Lens' UserData (Maybe [AgentContactReference])
userData_hierarchyPath :: Lens' UserData (Maybe HierarchyPathReference)
userData_maxSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural))
userData_nextStatus :: Lens' UserData (Maybe Text)
userData_routingProfile :: Lens' UserData (Maybe RoutingProfileReference)
userData_status :: Lens' UserData (Maybe AgentStatusReference)
userData_user :: Lens' UserData (Maybe UserReference)

Documentation

data UserData Source #

Data for a user.

See: newUserData smart constructor.

Constructors

UserData'

Fields

activeSlotsByChannel :: Maybe (HashMap Channel Natural)
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
availableSlotsByChannel :: Maybe (HashMap Channel Natural)
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
contacts :: Maybe [AgentContactReference]
A list of contact reference information.
hierarchyPath :: Maybe HierarchyPathReference
Contains information about the levels of a hierarchy group assigned to a user.
maxSlotsByChannel :: Maybe (HashMap Channel Natural)
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.
nextStatus :: Maybe Text
The Next status of the agent.
routingProfile :: Maybe RoutingProfileReference
Information about the routing profile that is assigned to the user.
status :: Maybe 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 :: Maybe UserReference
Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

Instances

Instances details

FromJSON UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Methods parseJSON :: Value -> Parser UserData # parseJSONList :: Value -> Parser [UserData] #
Generic UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Associated Types type Rep UserData :: Type -> Type # Methods from :: UserData -> Rep UserData x # to :: Rep UserData x -> UserData #
Read UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Methods readsPrec :: Int -> ReadS UserData # readList :: ReadS [UserData] # readPrec :: ReadPrec UserData # readListPrec :: ReadPrec [UserData] #
Show UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Methods showsPrec :: Int -> UserData -> ShowS # show :: UserData -> String # showList :: [UserData] -> ShowS #
NFData UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Methods rnf :: UserData -> () #
Eq UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Methods (==) :: UserData -> UserData -> Bool # (/=) :: UserData -> UserData -> Bool #
Hashable UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData Methods hashWithSalt :: Int -> UserData -> Int # hash :: UserData -> Int #
type Rep UserData Source #
Instance details Defined in Amazonka.Connect.Types.UserData type Rep UserData = D1 ('MetaData "UserData" "Amazonka.Connect.Types.UserData" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UserData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activeSlotsByChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Channel Natural))) :: S1 ('MetaSel ('Just "availableSlotsByChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Channel Natural)))) :: (S1 ('MetaSel ('Just "contacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AgentContactReference])) :: S1 ('MetaSel ('Just "hierarchyPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HierarchyPathReference)))) :: ((S1 ('MetaSel ('Just "maxSlotsByChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Channel Natural))) :: S1 ('MetaSel ('Just "nextStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "routingProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingProfileReference)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AgentStatusReference)) :: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserReference)))))))

newUserData :: UserData Source #

Create a value of UserData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeSlotsByChannel:UserData', userData_activeSlotsByChannel - A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.

$sel:availableSlotsByChannel:UserData', userData_availableSlotsByChannel - A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.

$sel:contacts:UserData', userData_contacts - A list of contact reference information.

$sel:hierarchyPath:UserData', userData_hierarchyPath - Contains information about the levels of a hierarchy group assigned to a user.

$sel:maxSlotsByChannel:UserData', userData_maxSlotsByChannel - 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.

$sel:nextStatus:UserData', userData_nextStatus - The Next status of the agent.

$sel:routingProfile:UserData', userData_routingProfile - Information about the routing profile that is assigned to the user.

$sel:status:UserData', userData_status - 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.

$sel:user:UserData', userData_user - Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

userData_activeSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #

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

userData_availableSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #

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

userData_contacts :: Lens' UserData (Maybe [AgentContactReference]) Source #

A list of contact reference information.

userData_hierarchyPath :: Lens' UserData (Maybe HierarchyPathReference) Source #

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

userData_maxSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #

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.

userData_nextStatus :: Lens' UserData (Maybe Text) Source #

The Next status of the agent.

userData_routingProfile :: Lens' UserData (Maybe RoutingProfileReference) Source #

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

userData_status :: Lens' UserData (Maybe AgentStatusReference) Source #

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.

userData_user :: Lens' UserData (Maybe UserReference) Source #

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