Amazonka.WorkMail.CreateUser

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

Creating a Request

data CreateUser

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

ToJSON CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

toJSON :: CreateUser -> Value

toEncoding :: CreateUser -> Encoding

toJSONList :: [CreateUser] -> Value

toEncodingList :: [CreateUser] -> Encoding

ToHeaders CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

toHeaders :: CreateUser -> [Header]

ToPath CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

toPath :: CreateUser -> ByteString

ToQuery CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

toQuery :: CreateUser -> QueryString

AWSRequest CreateUser

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

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

Defined in Amazonka.WorkMail.CreateUser

Methods

showsPrec :: Int -> CreateUser -> ShowS

show :: CreateUser -> String

showList :: [CreateUser] -> ShowS

NFData CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

rnf :: CreateUser -> ()

Eq CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

(==) :: CreateUser -> CreateUser -> Bool

(/=) :: CreateUser -> CreateUser -> Bool

Hashable CreateUser

Defined in Amazonka.WorkMail.CreateUser

Methods

hashWithSalt :: Int -> CreateUser -> Int

hash :: CreateUser -> Int

type AWSResponse CreateUser

Defined in Amazonka.WorkMail.CreateUser

type AWSResponse CreateUser = CreateUserResponse

type Rep CreateUser

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

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

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

createUser_name :: Lens' CreateUser 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.

createUser_displayName :: Lens' CreateUser Text

The display name for the new user.

createUser_password :: Lens' CreateUser Text

The password for the new user.

Destructuring the Response

data CreateUserResponse

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

Generic CreateUserResponse

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

Defined in Amazonka.WorkMail.CreateUser

Methods

readsPrec :: Int -> ReadS CreateUserResponse

readList :: ReadS [CreateUserResponse]

readPrec :: ReadPrec CreateUserResponse

readListPrec :: ReadPrec [CreateUserResponse]

Show CreateUserResponse

Defined in Amazonka.WorkMail.CreateUser

Methods

showsPrec :: Int -> CreateUserResponse -> ShowS

show :: CreateUserResponse -> String

showList :: [CreateUserResponse] -> ShowS

NFData CreateUserResponse

Defined in Amazonka.WorkMail.CreateUser

Methods

rnf :: CreateUserResponse -> ()

Eq CreateUserResponse

Defined in Amazonka.WorkMail.CreateUser

Methods

(==) :: CreateUserResponse -> CreateUserResponse -> Bool

(/=) :: CreateUserResponse -> CreateUserResponse -> Bool

type Rep CreateUserResponse

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

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)

The identifier for the new user.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int

The response's http status code.