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

Contents

Description

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Synopsis

updateUser :: Text -> UpdateUser
data UpdateUser
uuGivenName :: Lens' UpdateUser (Maybe Text)
uuGrantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType)
uuLocale :: Lens' UpdateUser (Maybe LocaleType)
uuAuthenticationToken :: Lens' UpdateUser (Maybe Text)
uuStorageRule :: Lens' UpdateUser (Maybe StorageRuleType)
uuType :: Lens' UpdateUser (Maybe UserType)
uuSurname :: Lens' UpdateUser (Maybe Text)
uuTimeZoneId :: Lens' UpdateUser (Maybe Text)
uuUserId :: Lens' UpdateUser Text
updateUserResponse :: Int -> UpdateUserResponse
data UpdateUserResponse
uursUser :: Lens' UpdateUserResponse (Maybe User)
uursResponseStatus :: Lens' UpdateUserResponse Int

Creating a Request

updateUser Source #

Arguments

:: Text	`uuUserId`
-> UpdateUser

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

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

uuGivenName - The given name of the user.
uuGrantPoweruserPrivileges - Boolean value to determine whether the user is granted Poweruser privileges.
uuLocale - The locale of the user.
uuAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
uuStorageRule - The amount of storage for the user.
uuType - The type of the user.
uuSurname - The surname of the user.
uuTimeZoneId - The time zone ID of the user.
uuUserId - The ID of the user.

data UpdateUser Source #

See: updateUser smart constructor.

Instances

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

Request Lenses

uuGivenName :: Lens' UpdateUser (Maybe Text) Source #

The given name of the user.

uuGrantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType) Source #

Boolean value to determine whether the user is granted Poweruser privileges.

uuLocale :: Lens' UpdateUser (Maybe LocaleType) Source #

The locale of the user.

uuAuthenticationToken :: Lens' UpdateUser (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.

uuStorageRule :: Lens' UpdateUser (Maybe StorageRuleType) Source #

The amount of storage for the user.

uuType :: Lens' UpdateUser (Maybe UserType) Source #

The type of the user.

uuSurname :: Lens' UpdateUser (Maybe Text) Source #

The surname of the user.

uuTimeZoneId :: Lens' UpdateUser (Maybe Text) Source #

The time zone ID of the user.

uuUserId :: Lens' UpdateUser Text Source #

The ID of the user.

Destructuring the Response

updateUserResponse Source #

Arguments

:: Int	`uursResponseStatus`
-> UpdateUserResponse

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

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

uursUser - The user information.
uursResponseStatus - -- | The response status code.

data UpdateUserResponse Source #

See: updateUserResponse smart constructor.

Instances

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

Response Lenses

uursUser :: Lens' UpdateUserResponse (Maybe User) Source #

The user information.

uursResponseStatus :: Lens' UpdateUserResponse Int Source #

- | The response status code.