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.UserSearchSummary

Description

Synopsis

data UserSearchSummary = UserSearchSummary' {
- arn :: Maybe Text
- directoryUserId :: Maybe Text
- hierarchyGroupId :: Maybe Text
- id :: Maybe Text
- identityInfo :: Maybe UserIdentityInfoLite
- phoneConfig :: Maybe UserPhoneConfig
- routingProfileId :: Maybe Text
- securityProfileIds :: Maybe (NonEmpty Text)
- tags :: Maybe (HashMap Text Text)
- username :: Maybe Text
}
newUserSearchSummary :: UserSearchSummary
userSearchSummary_arn :: Lens' UserSearchSummary (Maybe Text)
userSearchSummary_directoryUserId :: Lens' UserSearchSummary (Maybe Text)
userSearchSummary_hierarchyGroupId :: Lens' UserSearchSummary (Maybe Text)
userSearchSummary_id :: Lens' UserSearchSummary (Maybe Text)
userSearchSummary_identityInfo :: Lens' UserSearchSummary (Maybe UserIdentityInfoLite)
userSearchSummary_phoneConfig :: Lens' UserSearchSummary (Maybe UserPhoneConfig)
userSearchSummary_routingProfileId :: Lens' UserSearchSummary (Maybe Text)
userSearchSummary_securityProfileIds :: Lens' UserSearchSummary (Maybe (NonEmpty Text))
userSearchSummary_tags :: Lens' UserSearchSummary (Maybe (HashMap Text Text))
userSearchSummary_username :: Lens' UserSearchSummary (Maybe Text)

Documentation

data UserSearchSummary Source #

Information about the returned users.

See: newUserSearchSummary smart constructor.

Constructors

UserSearchSummary'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the user.
directoryUserId :: Maybe Text
The directory identifier of the user.
hierarchyGroupId :: Maybe Text
The identifier of the user's hierarchy group.
id :: Maybe Text
The identifier of the user's summary.
identityInfo :: Maybe UserIdentityInfoLite
The user's first name and last name.
phoneConfig :: Maybe UserPhoneConfig
routingProfileId :: Maybe Text
The identifier of the user's routing profile.
securityProfileIds :: Maybe (NonEmpty Text)
The identifiers of the user's security profiles.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
username :: Maybe Text
The name of the user.

Instances

Instances details

FromJSON UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Methods parseJSON :: Value -> Parser UserSearchSummary # parseJSONList :: Value -> Parser [UserSearchSummary] #
Generic UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Associated Types type Rep UserSearchSummary :: Type -> Type # Methods from :: UserSearchSummary -> Rep UserSearchSummary x # to :: Rep UserSearchSummary x -> UserSearchSummary #
Read UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Methods readsPrec :: Int -> ReadS UserSearchSummary # readList :: ReadS [UserSearchSummary] # readPrec :: ReadPrec UserSearchSummary # readListPrec :: ReadPrec [UserSearchSummary] #
Show UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Methods showsPrec :: Int -> UserSearchSummary -> ShowS # show :: UserSearchSummary -> String # showList :: [UserSearchSummary] -> ShowS #
NFData UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Methods rnf :: UserSearchSummary -> () #
Eq UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Methods (==) :: UserSearchSummary -> UserSearchSummary -> Bool # (/=) :: UserSearchSummary -> UserSearchSummary -> Bool #
Hashable UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary Methods hashWithSalt :: Int -> UserSearchSummary -> Int # hash :: UserSearchSummary -> Int #
type Rep UserSearchSummary Source #
Instance details Defined in Amazonka.Connect.Types.UserSearchSummary type Rep UserSearchSummary = D1 ('MetaData "UserSearchSummary" "Amazonka.Connect.Types.UserSearchSummary" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "UserSearchSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "directoryUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "hierarchyGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserIdentityInfoLite))))) :: ((S1 ('MetaSel ('Just "phoneConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPhoneConfig)) :: S1 ('MetaSel ('Just "routingProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "securityProfileIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newUserSearchSummary :: UserSearchSummary Source #

Create a value of UserSearchSummary 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:arn:UserSearchSummary', userSearchSummary_arn - The Amazon Resource Name (ARN) of the user.

$sel:directoryUserId:UserSearchSummary', userSearchSummary_directoryUserId - The directory identifier of the user.

$sel:hierarchyGroupId:UserSearchSummary', userSearchSummary_hierarchyGroupId - The identifier of the user's hierarchy group.

$sel:id:UserSearchSummary', userSearchSummary_id - The identifier of the user's summary.

$sel:identityInfo:UserSearchSummary', userSearchSummary_identityInfo - The user's first name and last name.

$sel:phoneConfig:UserSearchSummary', userSearchSummary_phoneConfig - Undocumented member.

$sel:routingProfileId:UserSearchSummary', userSearchSummary_routingProfileId - The identifier of the user's routing profile.

$sel:securityProfileIds:UserSearchSummary', userSearchSummary_securityProfileIds - The identifiers of the user's security profiles.

$sel:tags:UserSearchSummary', userSearchSummary_tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

$sel:username:UserSearchSummary', userSearchSummary_username - The name of the user.

userSearchSummary_arn :: Lens' UserSearchSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user.

userSearchSummary_directoryUserId :: Lens' UserSearchSummary (Maybe Text) Source #

The directory identifier of the user.

userSearchSummary_hierarchyGroupId :: Lens' UserSearchSummary (Maybe Text) Source #

The identifier of the user's hierarchy group.

userSearchSummary_id :: Lens' UserSearchSummary (Maybe Text) Source #

The identifier of the user's summary.

userSearchSummary_identityInfo :: Lens' UserSearchSummary (Maybe UserIdentityInfoLite) Source #

The user's first name and last name.

userSearchSummary_phoneConfig :: Lens' UserSearchSummary (Maybe UserPhoneConfig) Source #