Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Signs out users from all devices, as an administrator.

Requires developer credentials.

Creating a Request

adminUserGlobalSignOut #

Arguments

:: Text	`augsoUserPoolId`
-> Text	`augsoUsername`
-> AdminUserGlobalSignOut

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

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

augsoUserPoolId - The user pool ID.
augsoUsername - The user name.

data AdminUserGlobalSignOut #

The request to sign out of all devices, as an administrator.

See: adminUserGlobalSignOut smart constructor.

Instances

Eq AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods (==) :: AdminUserGlobalSignOut -> AdminUserGlobalSignOut -> Bool # (/=) :: AdminUserGlobalSignOut -> AdminUserGlobalSignOut -> Bool #
Data AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminUserGlobalSignOut -> c AdminUserGlobalSignOut # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminUserGlobalSignOut # toConstr :: AdminUserGlobalSignOut -> Constr # dataTypeOf :: AdminUserGlobalSignOut -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AdminUserGlobalSignOut) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminUserGlobalSignOut) # gmapT :: (forall b. Data b => b -> b) -> AdminUserGlobalSignOut -> AdminUserGlobalSignOut # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminUserGlobalSignOut -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminUserGlobalSignOut -> r # gmapQ :: (forall d. Data d => d -> u) -> AdminUserGlobalSignOut -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminUserGlobalSignOut -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminUserGlobalSignOut -> m AdminUserGlobalSignOut # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminUserGlobalSignOut -> m AdminUserGlobalSignOut # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminUserGlobalSignOut -> m AdminUserGlobalSignOut #
Show AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods showsPrec :: Int -> AdminUserGlobalSignOut -> ShowS # show :: AdminUserGlobalSignOut -> String # showList :: [AdminUserGlobalSignOut] -> ShowS #
Generic AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Associated Types type Rep AdminUserGlobalSignOut :: * -> * # Methods from :: AdminUserGlobalSignOut -> Rep AdminUserGlobalSignOut x # to :: Rep AdminUserGlobalSignOut x -> AdminUserGlobalSignOut #
Hashable AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods hashWithSalt :: Int -> AdminUserGlobalSignOut -> Int # hash :: AdminUserGlobalSignOut -> Int #
ToJSON AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods toJSON :: AdminUserGlobalSignOut -> Value # toEncoding :: AdminUserGlobalSignOut -> Encoding # toJSONList :: [AdminUserGlobalSignOut] -> Value # toEncodingList :: [AdminUserGlobalSignOut] -> Encoding #
AWSRequest AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Associated Types type Rs AdminUserGlobalSignOut :: * # Methods request :: AdminUserGlobalSignOut -> Request AdminUserGlobalSignOut # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy AdminUserGlobalSignOut -> ClientResponse -> m (Response AdminUserGlobalSignOut) #
ToHeaders AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods toHeaders :: AdminUserGlobalSignOut -> [Header] #
ToPath AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods toPath :: AdminUserGlobalSignOut -> ByteString #
ToQuery AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods toQuery :: AdminUserGlobalSignOut -> QueryString #
NFData AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods rnf :: AdminUserGlobalSignOut -> () #
type Rep AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut type Rep AdminUserGlobalSignOut = D1 (MetaData "AdminUserGlobalSignOut" "Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut" "amazonka-cognito-idp-1.6.0-7SljkxAhdrGDTNozW2RuYv" False) (C1 (MetaCons "AdminUserGlobalSignOut'" PrefixI True) (S1 (MetaSel (Just "_augsoUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_augsoUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))))
type Rs AdminUserGlobalSignOut #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut type Rs AdminUserGlobalSignOut = AdminUserGlobalSignOutResponse

Request Lenses

augsoUserPoolId :: Lens' AdminUserGlobalSignOut Text #

The user pool ID.

augsoUsername :: Lens' AdminUserGlobalSignOut Text #

The user name.

Destructuring the Response

adminUserGlobalSignOutResponse #

Arguments

:: Int	`augsorsResponseStatus`
-> AdminUserGlobalSignOutResponse

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

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

augsorsResponseStatus - -- | The response status code.

data AdminUserGlobalSignOutResponse #

The global sign-out response, as an administrator.

See: adminUserGlobalSignOutResponse smart constructor.

Instances

Eq AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods (==) :: AdminUserGlobalSignOutResponse -> AdminUserGlobalSignOutResponse -> Bool # (/=) :: AdminUserGlobalSignOutResponse -> AdminUserGlobalSignOutResponse -> Bool #
Data AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminUserGlobalSignOutResponse -> c AdminUserGlobalSignOutResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminUserGlobalSignOutResponse # toConstr :: AdminUserGlobalSignOutResponse -> Constr # dataTypeOf :: AdminUserGlobalSignOutResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AdminUserGlobalSignOutResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminUserGlobalSignOutResponse) # gmapT :: (forall b. Data b => b -> b) -> AdminUserGlobalSignOutResponse -> AdminUserGlobalSignOutResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminUserGlobalSignOutResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminUserGlobalSignOutResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> AdminUserGlobalSignOutResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminUserGlobalSignOutResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminUserGlobalSignOutResponse -> m AdminUserGlobalSignOutResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminUserGlobalSignOutResponse -> m AdminUserGlobalSignOutResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminUserGlobalSignOutResponse -> m AdminUserGlobalSignOutResponse #
Read AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods readsPrec :: Int -> ReadS AdminUserGlobalSignOutResponse # readList :: ReadS [AdminUserGlobalSignOutResponse] # readPrec :: ReadPrec AdminUserGlobalSignOutResponse # readListPrec :: ReadPrec [AdminUserGlobalSignOutResponse] #
Show AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods showsPrec :: Int -> AdminUserGlobalSignOutResponse -> ShowS # show :: AdminUserGlobalSignOutResponse -> String # showList :: [AdminUserGlobalSignOutResponse] -> ShowS #
Generic AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Associated Types type Rep AdminUserGlobalSignOutResponse :: * -> * # Methods from :: AdminUserGlobalSignOutResponse -> Rep AdminUserGlobalSignOutResponse x # to :: Rep AdminUserGlobalSignOutResponse x -> AdminUserGlobalSignOutResponse #
NFData AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut Methods rnf :: AdminUserGlobalSignOutResponse -> () #
type Rep AdminUserGlobalSignOutResponse #
Instance details Defined in Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut type Rep AdminUserGlobalSignOutResponse = D1 (MetaData "AdminUserGlobalSignOutResponse" "Network.AWS.CognitoIdentityProvider.AdminUserGlobalSignOut" "amazonka-cognito-idp-1.6.0-7SljkxAhdrGDTNozW2RuYv" True) (C1 (MetaCons "AdminUserGlobalSignOutResponse'" PrefixI True) (S1 (MetaSel (Just "_augsorsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

augsorsResponseStatus :: Lens' AdminUserGlobalSignOutResponse Int #

- | The response status code.