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.WorkMail.CreateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.

Synopsis

data CreateUser = CreateUser' {
- organizationId :: Text
- name :: Text
- displayName :: Text
- password :: Sensitive Text
}
newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
createUser_organizationId :: Lens' CreateUser Text
createUser_name :: Lens' CreateUser Text
createUser_displayName :: Lens' CreateUser Text
createUser_password :: Lens' CreateUser Text
data CreateUserResponse = CreateUserResponse' {
- userId :: Maybe Text
- httpStatus :: Int
}
newCreateUserResponse :: Int -> CreateUserResponse
createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text)
createUserResponse_httpStatus :: Lens' CreateUserResponse Int

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'
Fields organizationId :: Text The identifier of the organization for which the user is created. name :: Text The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20. displayName :: Text The display name for the new user. password :: Sensitive Text The password for the new user.

Instances

Instances details

ToJSON CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods toQuery :: CreateUser -> QueryString #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Associated Types type AWSResponse CreateUser # Methods request :: (Service -> Service) -> CreateUser -> Request CreateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser))) #
Generic CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
Show CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
NFData CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods rnf :: CreateUser -> () #
Eq CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Hashable CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser type AWSResponse CreateUser = CreateUserResponse
type Rep CreateUser Source #
Instance details Defined in Amazonka.WorkMail.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.WorkMail.CreateUser" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newCreateUser Source #

Arguments

:: Text	`CreateUser`
-> Text	`CreateUser`
-> Text	`CreateUser`
-> Text	`$sel:password: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:

CreateUser, createUser_organizationId - The identifier of the organization for which the user is created.

CreateUser, createUser_name - The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

CreateUser, createUser_displayName - The display name for the new user.

$sel:password:CreateUser', createUser_password - The password for the new user.

Request Lenses

createUser_organizationId :: Lens' CreateUser Text Source #

The identifier of the organization for which the user is created.

createUser_name :: Lens' CreateUser Text Source #

The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

createUser_displayName :: Lens' CreateUser Text Source #

The display name for the new user.

createUser_password :: Lens' CreateUser Text Source #

The password for the new user.

Destructuring the Response

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse'
Fields userId :: Maybe Text The identifier for the new user. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateUserResponse Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Associated Types type Rep CreateUserResponse :: Type -> Type # Methods from :: CreateUserResponse -> Rep CreateUserResponse x # to :: Rep CreateUserResponse x -> CreateUserResponse #
Read CreateUserResponse Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods readsPrec :: Int -> ReadS CreateUserResponse # readList :: ReadS [CreateUserResponse] # readPrec :: ReadPrec CreateUserResponse # readListPrec :: ReadPrec [CreateUserResponse] #
Show CreateUserResponse Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
NFData CreateUserResponse Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods rnf :: CreateUserResponse -> () #
Eq CreateUserResponse Source #
Instance details Defined in Amazonka.WorkMail.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
type Rep CreateUserResponse Source #
Instance details Defined in Amazonka.WorkMail.CreateUser type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.WorkMail.CreateUser" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") '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:

CreateUserResponse, createUserResponse_userId - The identifier for the new user.

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

Response Lenses

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

The identifier for the new user.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.