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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Activates the specified user. Only active users can access Amazon WorkDocs.

Synopsis

Creating a Request

data ActivateUser Source #

See: newActivateUser smart constructor.

Constructors

ActivateUser'
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

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

newActivateUser Source #

Arguments

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

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

$sel:userId:ActivateUser', activateUser_userId - The ID of the user.

Request Lenses

activateUser_authenticationToken :: Lens' ActivateUser (Maybe Text) Source #

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

activateUser_userId :: Lens' ActivateUser Text Source #

The ID of the user.

Destructuring the Response

data ActivateUserResponse Source #

See: newActivateUserResponse smart constructor.

Constructors

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

Instances

Instances details

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

newActivateUserResponse Source #

Arguments

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

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

$sel:httpStatus:ActivateUserResponse', activateUserResponse_httpStatus - The response's http status code.

Response Lenses

activateUserResponse_user :: Lens' ActivateUserResponse (Maybe User) Source #

The user information.

activateUserResponse_httpStatus :: Lens' ActivateUserResponse Int Source #

The response's http status code.