Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.WorkDocs.CreateUser

Contents

Description

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is ACTIVE. New users can access Amazon WorkDocs.

Synopsis

createUser :: Text -> Text -> Text -> Text -> CreateUser
data CreateUser
cuAuthenticationToken :: Lens' CreateUser (Maybe Text)
cuStorageRule :: Lens' CreateUser (Maybe StorageRuleType)
cuEmailAddress :: Lens' CreateUser (Maybe Text)
cuTimeZoneId :: Lens' CreateUser (Maybe Text)
cuOrganizationId :: Lens' CreateUser (Maybe Text)
cuUsername :: Lens' CreateUser Text
cuGivenName :: Lens' CreateUser Text
cuSurname :: Lens' CreateUser Text
cuPassword :: Lens' CreateUser Text
createUserResponse :: Int -> CreateUserResponse
data CreateUserResponse
cursUser :: Lens' CreateUserResponse (Maybe User)
cursResponseStatus :: Lens' CreateUserResponse Int

Creating a Request

createUser Source #

Arguments

:: Text	`cuUsername`
-> Text	`cuGivenName`
-> Text	`cuSurname`
-> Text	`cuPassword`
-> CreateUser

Creates a value of CreateUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cuAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
cuStorageRule - The amount of storage for the user.
cuEmailAddress - The email address of the user.
cuTimeZoneId - The time zone ID of the user.
cuOrganizationId - The ID of the organization.
cuUsername - The login name of the user.
cuGivenName - The given name of the user.
cuSurname - The surname of the user.
cuPassword - The password of the user.

data CreateUser Source #

See: createUser smart constructor.

Instances

Eq CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Data CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUser -> c CreateUser # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUser # toConstr :: CreateUser -> Constr # dataTypeOf :: CreateUser -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateUser) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUser) # gmapT :: (forall b. Data b => b -> b) -> CreateUser -> CreateUser # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUser -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUser -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateUser -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUser -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUser -> m CreateUser # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUser -> m CreateUser # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUser -> m CreateUser #
Show CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
Generic CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
Hashable CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
ToJSON CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
AWSRequest CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Associated Types type Rs CreateUser :: Type # Methods request :: CreateUser -> Request CreateUser # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateUser -> ClientResponse -> m (Response CreateUser) #
ToHeaders CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods toQuery :: CreateUser -> QueryString #
NFData CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods rnf :: CreateUser -> () #
type Rep CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser type Rep CreateUser = D1 (MetaData "CreateUser" "Network.AWS.WorkDocs.CreateUser" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "CreateUser'" PrefixI True) (((S1 (MetaSel (Just "_cuAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 (MetaSel (Just "_cuStorageRule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StorageRuleType))) :: (S1 (MetaSel (Just "_cuEmailAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cuTimeZoneId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_cuOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cuUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_cuGivenName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_cuSurname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_cuPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)))))))
type Rs CreateUser Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser type Rs CreateUser = CreateUserResponse

Request Lenses

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

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

cuStorageRule :: Lens' CreateUser (Maybe StorageRuleType) Source #

The amount of storage for the user.

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

The email address of the user.

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

The time zone ID of the user.

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

The ID of the organization.

cuUsername :: Lens' CreateUser Text Source #

The login name of the user.

cuGivenName :: Lens' CreateUser Text Source #

The given name of the user.

cuSurname :: Lens' CreateUser Text Source #

The surname of the user.

cuPassword :: Lens' CreateUser Text Source #

The password of the user.

Destructuring the Response

createUserResponse Source #

Arguments

:: Int	`cursResponseStatus`
-> CreateUserResponse

Creates a value of CreateUserResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cursUser - The user information.
cursResponseStatus - -- | The response status code.

data CreateUserResponse Source #

See: createUserResponse smart constructor.

Instances

Eq CreateUserResponse Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
Data CreateUserResponse Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUserResponse -> c CreateUserResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUserResponse # toConstr :: CreateUserResponse -> Constr # dataTypeOf :: CreateUserResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateUserResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUserResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateUserResponse -> CreateUserResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUserResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateUserResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUserResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUserResponse -> m CreateUserResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserResponse -> m CreateUserResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUserResponse -> m CreateUserResponse #
Read CreateUserResponse Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods readsPrec :: Int -> ReadS CreateUserResponse # readList :: ReadS [CreateUserResponse] # readPrec :: ReadPrec CreateUserResponse # readListPrec :: ReadPrec [CreateUserResponse] #
Show CreateUserResponse Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
Generic CreateUserResponse Source #
Instance details Defined in Network.AWS.WorkDocs.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 Network.AWS.WorkDocs.CreateUser Methods rnf :: CreateUserResponse -> () #
type Rep CreateUserResponse Source #
Instance details Defined in Network.AWS.WorkDocs.CreateUser type Rep CreateUserResponse = D1 (MetaData "CreateUserResponse" "Network.AWS.WorkDocs.CreateUser" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "CreateUserResponse'" PrefixI True) (S1 (MetaSel (Just "_cursUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe User)) :*: S1 (MetaSel (Just "_cursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cursUser :: Lens' CreateUserResponse (Maybe User) Source #

The user information.

cursResponseStatus :: Lens' CreateUserResponse Int Source #

- | The response status code.