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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data UpdateUser = UpdateUser' {
- authenticationToken :: Maybe (Sensitive Text)
- givenName :: Maybe Text
- grantPoweruserPrivileges :: Maybe BooleanEnumType
- locale :: Maybe LocaleType
- storageRule :: Maybe StorageRuleType
- surname :: Maybe Text
- timeZoneId :: Maybe Text
- type' :: Maybe UserType
- userId :: Text
}
newUpdateUser :: Text -> UpdateUser
updateUser_authenticationToken :: Lens' UpdateUser (Maybe Text)
updateUser_givenName :: Lens' UpdateUser (Maybe Text)
updateUser_grantPoweruserPrivileges :: Lens' UpdateUser (Maybe BooleanEnumType)
updateUser_locale :: Lens' UpdateUser (Maybe LocaleType)
updateUser_storageRule :: Lens' UpdateUser (Maybe StorageRuleType)
updateUser_surname :: Lens' UpdateUser (Maybe Text)
updateUser_timeZoneId :: Lens' UpdateUser (Maybe Text)
updateUser_type :: Lens' UpdateUser (Maybe UserType)
updateUser_userId :: Lens' UpdateUser Text
data UpdateUserResponse = UpdateUserResponse' {
- user :: Maybe User
- httpStatus :: Int
}
newUpdateUserResponse :: Int -> UpdateUserResponse
updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User)
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int

Creating a Request

data UpdateUser Source #

See: newUpdateUser smart constructor.

Constructors

UpdateUser'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
givenName :: Maybe Text
The given name of the user.
grantPoweruserPrivileges :: Maybe BooleanEnumType
Boolean value to determine whether the user is granted Poweruser privileges.
locale :: Maybe LocaleType
The locale of the user.
storageRule :: Maybe StorageRuleType
The amount of storage for the user.
surname :: Maybe Text
The surname of the user.
timeZoneId :: Maybe Text
The time zone ID of the user.
type' :: Maybe UserType
The type of the user.
userId :: Text
The ID of the user.

Instances

Instances details

ToJSON UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods toJSON :: UpdateUser -> Value # toEncoding :: UpdateUser -> Encoding # toJSONList :: [UpdateUser] -> Value # toEncodingList :: [UpdateUser] -> Encoding #
ToHeaders UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods toHeaders :: UpdateUser -> [Header] #
ToPath UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods toPath :: UpdateUser -> ByteString #
ToQuery UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods toQuery :: UpdateUser -> QueryString #
AWSRequest UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Associated Types type AWSResponse UpdateUser # Methods request :: (Service -> Service) -> UpdateUser -> Request UpdateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUser))) #
Generic UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Associated Types type Rep UpdateUser :: Type -> Type # Methods from :: UpdateUser -> Rep UpdateUser x # to :: Rep UpdateUser x -> UpdateUser #
Show UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods showsPrec :: Int -> UpdateUser -> ShowS # show :: UpdateUser -> String # showList :: [UpdateUser] -> ShowS #
NFData UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods rnf :: UpdateUser -> () #
Eq UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods (==) :: UpdateUser -> UpdateUser -> Bool # (/=) :: UpdateUser -> UpdateUser -> Bool #
Hashable UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods hashWithSalt :: Int -> UpdateUser -> Int # hash :: UpdateUser -> Int #
type AWSResponse UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser type AWSResponse UpdateUser = UpdateUserResponse
type Rep UpdateUser Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser type Rep UpdateUser = D1 ('MetaData "UpdateUser" "Amazonka.WorkDocs.UpdateUser" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "UpdateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "givenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "grantPoweruserPrivileges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BooleanEnumType)) :: S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LocaleType)))) :: ((S1 ('MetaSel ('Just "storageRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageRuleType)) :: S1 ('MetaSel ('Just "surname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "timeZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateUser Source #

Arguments

:: Text	`$sel:userId:UpdateUser'`
-> UpdateUser

Create a value of UpdateUser 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:authenticationToken:UpdateUser', updateUser_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

UpdateUser, updateUser_givenName - The given name of the user.

$sel:grantPoweruserPrivileges:UpdateUser', updateUser_grantPoweruserPrivileges - Boolean value to determine whether the user is granted Poweruser privileges.

UpdateUser, updateUser_locale - The locale of the user.

UpdateUser, updateUser_storageRule - The amount of storage for the user.

UpdateUser, updateUser_surname - The surname of the user.

UpdateUser, updateUser_timeZoneId - The time zone ID of the user.

UpdateUser, updateUser_type - The type of the user.

$sel:userId:UpdateUser', updateUser_userId - The ID of the user.

Request Lenses

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

The given name of the user.

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

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

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

The locale of the user.

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

The amount of storage for the user.

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

The surname of the user.

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

The time zone ID of the user.

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

The type of the user.

updateUser_userId :: Lens' UpdateUser Text Source #

The ID of the user.

Destructuring the Response

data UpdateUserResponse Source #

See: newUpdateUserResponse smart constructor.

Constructors

UpdateUserResponse'
Fields user :: Maybe User The user information. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Associated Types type Rep UpdateUserResponse :: Type -> Type # Methods from :: UpdateUserResponse -> Rep UpdateUserResponse x # to :: Rep UpdateUserResponse x -> UpdateUserResponse #
Show UpdateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods showsPrec :: Int -> UpdateUserResponse -> ShowS # show :: UpdateUserResponse -> String # showList :: [UpdateUserResponse] -> ShowS #
NFData UpdateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods rnf :: UpdateUserResponse -> () #
Eq UpdateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser Methods (==) :: UpdateUserResponse -> UpdateUserResponse -> Bool # (/=) :: UpdateUserResponse -> UpdateUserResponse -> Bool #
type Rep UpdateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.UpdateUser type Rep UpdateUserResponse = D1 ('MetaData "UpdateUserResponse" "Amazonka.WorkDocs.UpdateUser" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "UpdateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateUserResponse Source #

Arguments

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

Create a value of UpdateUserResponse 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:user:UpdateUserResponse', updateUserResponse_user - The user information.

$sel:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.

Response Lenses

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

The user information.

updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #

The response's http status code.