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.FinSpaceData.DisableUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Denies access to the FinSpace web application and API for the specified user.

Synopsis

data DisableUser = DisableUser' {
- clientToken :: Maybe Text
- userId :: Text
}
newDisableUser :: Text -> DisableUser
disableUser_clientToken :: Lens' DisableUser (Maybe Text)
disableUser_userId :: Lens' DisableUser Text
data DisableUserResponse = DisableUserResponse' {
- userId :: Maybe Text
- httpStatus :: Int
}
newDisableUserResponse :: Int -> DisableUserResponse
disableUserResponse_userId :: Lens' DisableUserResponse (Maybe Text)
disableUserResponse_httpStatus :: Lens' DisableUserResponse Int

Creating a Request

data DisableUser Source #

See: newDisableUser smart constructor.

Constructors

DisableUser'
Fields clientToken :: Maybe Text A token that ensures idempotency. This token expires in 10 minutes. userId :: Text The unique identifier for the user account that you want to disable.

Instances

Instances details

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

newDisableUser Source #

Arguments

:: Text	`DisableUser`
-> DisableUser

Create a value of DisableUser 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:clientToken:DisableUser', disableUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

DisableUser, disableUser_userId - The unique identifier for the user account that you want to disable.

Request Lenses

disableUser_clientToken :: Lens' DisableUser (Maybe Text) Source #

A token that ensures idempotency. This token expires in 10 minutes.

disableUser_userId :: Lens' DisableUser Text Source #

The unique identifier for the user account that you want to disable.

Destructuring the Response

data DisableUserResponse Source #

See: newDisableUserResponse smart constructor.

Constructors

DisableUserResponse'
Fields userId :: Maybe Text The unique identifier for the disabled user account. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DisableUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.DisableUser Associated Types type Rep DisableUserResponse :: Type -> Type # Methods from :: DisableUserResponse -> Rep DisableUserResponse x # to :: Rep DisableUserResponse x -> DisableUserResponse #
Read DisableUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.DisableUser Methods readsPrec :: Int -> ReadS DisableUserResponse # readList :: ReadS [DisableUserResponse] # readPrec :: ReadPrec DisableUserResponse # readListPrec :: ReadPrec [DisableUserResponse] #
Show DisableUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.DisableUser Methods showsPrec :: Int -> DisableUserResponse -> ShowS # show :: DisableUserResponse -> String # showList :: [DisableUserResponse] -> ShowS #
NFData DisableUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.DisableUser Methods rnf :: DisableUserResponse -> () #
Eq DisableUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.DisableUser Methods (==) :: DisableUserResponse -> DisableUserResponse -> Bool # (/=) :: DisableUserResponse -> DisableUserResponse -> Bool #
type Rep DisableUserResponse Source #
Instance details Defined in Amazonka.FinSpaceData.DisableUser type Rep DisableUserResponse = D1 ('MetaData "DisableUserResponse" "Amazonka.FinSpaceData.DisableUser" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "DisableUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisableUserResponse Source #

Arguments

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

Create a value of DisableUserResponse 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:

DisableUser, disableUserResponse_userId - The unique identifier for the disabled user account.

$sel:httpStatus:DisableUserResponse', disableUserResponse_httpStatus - The response's http status code.

Response Lenses

disableUserResponse_userId :: Lens' DisableUserResponse (Maybe Text) Source #

The unique identifier for the disabled user account.

disableUserResponse_httpStatus :: Lens' DisableUserResponse Int Source #

The response's http status code.