Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Connect.CreateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

Synopsis

data CreateUser = CreateUser' {
- directoryUserId :: Maybe Text
- identityInfo :: Maybe UserIdentityInfo
- password :: Maybe Text
- hierarchyGroupId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- username :: Text
- phoneConfig :: UserPhoneConfig
- securityProfileIds :: NonEmpty Text
- routingProfileId :: Text
- instanceId :: Text
}
newCreateUser :: Text -> UserPhoneConfig -> NonEmpty Text -> Text -> Text -> CreateUser
createUser_directoryUserId :: Lens' CreateUser (Maybe Text)
createUser_identityInfo :: Lens' CreateUser (Maybe UserIdentityInfo)
createUser_password :: Lens' CreateUser (Maybe Text)
createUser_hierarchyGroupId :: Lens' CreateUser (Maybe Text)
createUser_tags :: Lens' CreateUser (Maybe (HashMap Text Text))
createUser_username :: Lens' CreateUser Text
createUser_phoneConfig :: Lens' CreateUser UserPhoneConfig
createUser_securityProfileIds :: Lens' CreateUser (NonEmpty Text)
createUser_routingProfileId :: Lens' CreateUser Text
createUser_instanceId :: Lens' CreateUser Text
data CreateUserResponse = CreateUserResponse' {
- userId :: Maybe Text
- userArn :: Maybe Text
- httpStatus :: Int
}
newCreateUserResponse :: Int -> CreateUserResponse
createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text)
createUserResponse_userArn :: Lens' CreateUserResponse (Maybe Text)
createUserResponse_httpStatus :: Lens' CreateUserResponse Int

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'

Fields

directoryUserId :: Maybe Text
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
identityInfo :: Maybe UserIdentityInfo
The information about the identity of the user.
password :: Maybe Text
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
hierarchyGroupId :: Maybe Text
The identifier of the hierarchy group for the user.
tags :: Maybe (HashMap Text Text)
One or more tags.
username :: Text
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.
phoneConfig :: UserPhoneConfig
The phone settings for the user.
securityProfileIds :: NonEmpty Text
The identifier of the security profile for the user.
routingProfileId :: Text
The identifier of the routing profile for the user.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

Eq CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Read CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods readsPrec :: Int -> ReadS CreateUser # readList :: ReadS [CreateUser] # readPrec :: ReadPrec CreateUser # readListPrec :: ReadPrec [CreateUser] #
Show CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
Generic CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
NFData CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods rnf :: CreateUser -> () #
Hashable CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
ToJSON CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Associated Types type AWSResponse CreateUser # Methods request :: CreateUser -> Request CreateUser # response :: MonadResource m => Logger -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser))) #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods toQuery :: CreateUser -> QueryString #
type Rep CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.Connect.CreateUser" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "directoryUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserIdentityInfo))) :: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hierarchyGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "phoneConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserPhoneConfig)) :: (S1 ('MetaSel ('Just "securityProfileIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: (S1 ('MetaSel ('Just "routingProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.Connect.CreateUser type AWSResponse CreateUser = CreateUserResponse

newCreateUser Source #

Arguments

:: Text	`$sel:username:CreateUser'`
-> UserPhoneConfig	`$sel:phoneConfig:CreateUser'`
-> NonEmpty Text	`$sel:securityProfileIds:CreateUser'`
-> Text	`$sel:routingProfileId:CreateUser'`
-> Text	`$sel:instanceId:CreateUser'`
-> CreateUser

Create a value of CreateUser 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:directoryUserId:CreateUser', createUser_directoryUserId - The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

$sel:identityInfo:CreateUser', createUser_identityInfo - The information about the identity of the user.

$sel:password:CreateUser', createUser_password - The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

$sel:hierarchyGroupId:CreateUser', createUser_hierarchyGroupId - The identifier of the hierarchy group for the user.

$sel:tags:CreateUser', createUser_tags - One or more tags.

$sel:username:CreateUser', createUser_username - The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

$sel:phoneConfig:CreateUser', createUser_phoneConfig - The phone settings for the user.

$sel:securityProfileIds:CreateUser', createUser_securityProfileIds - The identifier of the security profile for the user.

$sel:routingProfileId:CreateUser', createUser_routingProfileId - The identifier of the routing profile for the user.

$sel:instanceId:CreateUser', createUser_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

createUser_directoryUserId :: Lens' CreateUser (Maybe Text) Source #

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

createUser_identityInfo :: Lens' CreateUser (Maybe UserIdentityInfo) Source #

The information about the identity of the user.

createUser_password :: Lens' CreateUser (Maybe Text) Source #

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

createUser_hierarchyGroupId :: Lens' CreateUser (Maybe Text) Source #

The identifier of the hierarchy group for the user.

createUser_tags :: Lens' CreateUser (Maybe (HashMap Text Text)) Source #

One or more tags.

createUser_username :: Lens' CreateUser Text Source #

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

createUser_phoneConfig :: Lens' CreateUser UserPhoneConfig Source #

The phone settings for the user.

createUser_securityProfileIds :: Lens' CreateUser (NonEmpty Text) Source #

The identifier of the security profile for the user.

createUser_routingProfileId :: Lens' CreateUser Text Source #

The identifier of the routing profile for the user.

createUser_instanceId :: Lens' CreateUser Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse'
Fields userId :: Maybe Text The identifier of the user account. userArn :: Maybe Text The Amazon Resource Name (ARN) of the user account. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateUserResponse Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
Read CreateUserResponse Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods readsPrec :: Int -> ReadS CreateUserResponse # readList :: ReadS [CreateUserResponse] # readPrec :: ReadPrec CreateUserResponse # readListPrec :: ReadPrec [CreateUserResponse] #
Show CreateUserResponse Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
Generic CreateUserResponse Source #
Instance details Defined in Amazonka.Connect.CreateUser Associated Types type Rep CreateUserResponse :: Type -> Type # Methods from :: CreateUserResponse -> Rep CreateUserResponse x # to :: Rep CreateUserResponse x -> CreateUserResponse #
NFData CreateUserResponse Source #
Instance details Defined in Amazonka.Connect.CreateUser Methods rnf :: CreateUserResponse -> () #
type Rep CreateUserResponse Source #
Instance details Defined in Amazonka.Connect.CreateUser type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.Connect.CreateUser" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserResponse'`
-> CreateUserResponse

Create a value of CreateUserResponse 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:userId:CreateUserResponse', createUserResponse_userId - The identifier of the user account.

$sel:userArn:CreateUserResponse', createUserResponse_userArn - The Amazon Resource Name (ARN) of the user account.

$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

Response Lenses

createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text) Source #

The identifier of the user account.

createUserResponse_userArn :: Lens' CreateUserResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user account.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.