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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Synopsis

Creating a Request

data DeactivateUser Source #

See: newDeactivateUser smart constructor.

Constructors

DeactivateUser'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. userId :: Text The ID of the user.

Instances

Instances details

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

newDeactivateUser Source #

Arguments

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

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

$sel:userId:DeactivateUser', deactivateUser_userId - The ID of the user.

Request Lenses

deactivateUser_authenticationToken :: Lens' DeactivateUser (Maybe Text) Source #

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

deactivateUser_userId :: Lens' DeactivateUser Text Source #

The ID of the user.

Destructuring the Response

data DeactivateUserResponse Source #

See: newDeactivateUserResponse smart constructor.

Constructors

DeactivateUserResponse'

Instances

Instances details

Generic DeactivateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeactivateUser Associated Types type Rep DeactivateUserResponse :: Type -> Type # Methods from :: DeactivateUserResponse -> Rep DeactivateUserResponse x # to :: Rep DeactivateUserResponse x -> DeactivateUserResponse #
Read DeactivateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeactivateUser Methods readsPrec :: Int -> ReadS DeactivateUserResponse # readList :: ReadS [DeactivateUserResponse] # readPrec :: ReadPrec DeactivateUserResponse # readListPrec :: ReadPrec [DeactivateUserResponse] #
Show DeactivateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeactivateUser Methods showsPrec :: Int -> DeactivateUserResponse -> ShowS # show :: DeactivateUserResponse -> String # showList :: [DeactivateUserResponse] -> ShowS #
NFData DeactivateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeactivateUser Methods rnf :: DeactivateUserResponse -> () #
Eq DeactivateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeactivateUser Methods (==) :: DeactivateUserResponse -> DeactivateUserResponse -> Bool # (/=) :: DeactivateUserResponse -> DeactivateUserResponse -> Bool #
type Rep DeactivateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeactivateUser type Rep DeactivateUserResponse = D1 ('MetaData "DeactivateUserResponse" "Amazonka.WorkDocs.DeactivateUser" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeactivateUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeactivateUserResponse :: DeactivateUserResponse Source #

Create a value of DeactivateUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.