Network.AWS.CognitoIdentityProvider.AdminInitiateAuth

Initiates the authentication flow, as an administrator.

Creating a Request

adminInitiateAuth

Arguments

:: Text

aiaUserPoolId

-> Text

aiaClientId

-> AuthFlowType

aiaAuthFlow

-> AdminInitiateAuth

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

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

• aiaClientMetadata - The client app metadata.
• aiaAuthParameters - The authentication parameters.
• aiaUserPoolId - The ID of the Amazon Cognito user pool.
• aiaClientId - The client app ID.
• aiaAuthFlow - The authentication flow.

data AdminInitiateAuth

Initiates the authorization request, as an administrator.

See: adminInitiateAuth smart constructor.

Instances

Eq AdminInitiateAuth

Methods

(==) :: AdminInitiateAuth -> AdminInitiateAuth -> Bool

(/=) :: AdminInitiateAuth -> AdminInitiateAuth -> Bool

Data AdminInitiateAuth

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminInitiateAuth -> c AdminInitiateAuth

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminInitiateAuth

toConstr :: AdminInitiateAuth -> Constr

dataTypeOf :: AdminInitiateAuth -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminInitiateAuth)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminInitiateAuth)

gmapT :: (forall b. Data b => b -> b) -> AdminInitiateAuth -> AdminInitiateAuth

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminInitiateAuth -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminInitiateAuth -> r

gmapQ :: (forall d. Data d => d -> u) -> AdminInitiateAuth -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminInitiateAuth -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminInitiateAuth -> m AdminInitiateAuth

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminInitiateAuth -> m AdminInitiateAuth

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminInitiateAuth -> m AdminInitiateAuth

Read AdminInitiateAuth

Methods

readsPrec :: Int -> ReadS AdminInitiateAuth

readList :: ReadS [AdminInitiateAuth]

readPrec :: ReadPrec AdminInitiateAuth

readListPrec :: ReadPrec [AdminInitiateAuth]

Show AdminInitiateAuth

Methods

showsPrec :: Int -> AdminInitiateAuth -> ShowS

show :: AdminInitiateAuth -> String

showList :: [AdminInitiateAuth] -> ShowS

Generic AdminInitiateAuth

Associated Types

type Rep AdminInitiateAuth :: * -> *

Methods

from :: AdminInitiateAuth -> Rep AdminInitiateAuth x

to :: Rep AdminInitiateAuth x -> AdminInitiateAuth

Hashable AdminInitiateAuth

Methods

hashWithSalt :: Int -> AdminInitiateAuth -> Int

hash :: AdminInitiateAuth -> Int

ToJSON AdminInitiateAuth

Methods

toJSON :: AdminInitiateAuth -> Value

toEncoding :: AdminInitiateAuth -> Encoding

toJSONList :: [AdminInitiateAuth] -> Value

toEncodingList :: [AdminInitiateAuth] -> Encoding

NFData AdminInitiateAuth

Methods

rnf :: AdminInitiateAuth -> ()

AWSRequest AdminInitiateAuth

Associated Types

type Rs AdminInitiateAuth :: *

Methods

request :: AdminInitiateAuth -> Request AdminInitiateAuth

response :: MonadResource m => Logger -> Service -> Proxy * AdminInitiateAuth -> ClientResponse -> m (Response AdminInitiateAuth)

ToPath AdminInitiateAuth

Methods

toPath :: AdminInitiateAuth -> ByteString

ToHeaders AdminInitiateAuth

Methods

toHeaders :: AdminInitiateAuth -> [Header]

ToQuery AdminInitiateAuth

Methods

toQuery :: AdminInitiateAuth -> QueryString

type Rep AdminInitiateAuth

type Rep AdminInitiateAuth = D1 (MetaData "AdminInitiateAuth" "Network.AWS.CognitoIdentityProvider.AdminInitiateAuth" "amazonka-cognito-idp-1.4.5-GXmpY7qnFXp3lLWwYVX1Gb" False) (C1 (MetaCons "AdminInitiateAuth'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aiaClientMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_aiaAuthParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_aiaUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_aiaClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))) (S1 (MetaSel (Just Symbol "_aiaAuthFlow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AuthFlowType))))))

type Rs AdminInitiateAuth

type Rs AdminInitiateAuth = AdminInitiateAuthResponse

Request Lenses

aiaClientMetadata :: Lens' AdminInitiateAuth (HashMap Text Text)

The client app metadata.

aiaAuthParameters :: Lens' AdminInitiateAuth (HashMap Text Text)

The authentication parameters.

aiaUserPoolId :: Lens' AdminInitiateAuth Text

The ID of the Amazon Cognito user pool.

aiaClientId :: Lens' AdminInitiateAuth Text

The client app ID.

aiaAuthFlow :: Lens' AdminInitiateAuth AuthFlowType

The authentication flow.

Destructuring the Response

adminInitiateAuthResponse

Arguments

:: Int

aiarsResponseStatus

-> AdminInitiateAuthResponse

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

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

• aiarsChallengeName - The name of the challenge.
• aiarsChallengeParameters - The challenge parameters.
• aiarsAuthenticationResult - The result of the authentication response.
• aiarsSession - The session.
• aiarsResponseStatus - -- | The response status code.

data AdminInitiateAuthResponse

Initiates the authentication response, as an administrator.

See: adminInitiateAuthResponse smart constructor.

Instances

Eq AdminInitiateAuthResponse

Methods

(==) :: AdminInitiateAuthResponse -> AdminInitiateAuthResponse -> Bool

(/=) :: AdminInitiateAuthResponse -> AdminInitiateAuthResponse -> Bool

Data AdminInitiateAuthResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminInitiateAuthResponse -> c AdminInitiateAuthResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminInitiateAuthResponse

toConstr :: AdminInitiateAuthResponse -> Constr

dataTypeOf :: AdminInitiateAuthResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminInitiateAuthResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminInitiateAuthResponse)

gmapT :: (forall b. Data b => b -> b) -> AdminInitiateAuthResponse -> AdminInitiateAuthResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminInitiateAuthResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminInitiateAuthResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> AdminInitiateAuthResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminInitiateAuthResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminInitiateAuthResponse -> m AdminInitiateAuthResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminInitiateAuthResponse -> m AdminInitiateAuthResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminInitiateAuthResponse -> m AdminInitiateAuthResponse

Read AdminInitiateAuthResponse

Methods

readsPrec :: Int -> ReadS AdminInitiateAuthResponse

readList :: ReadS [AdminInitiateAuthResponse]

readPrec :: ReadPrec AdminInitiateAuthResponse

readListPrec :: ReadPrec [AdminInitiateAuthResponse]

Show AdminInitiateAuthResponse

Methods

showsPrec :: Int -> AdminInitiateAuthResponse -> ShowS

show :: AdminInitiateAuthResponse -> String

showList :: [AdminInitiateAuthResponse] -> ShowS

Generic AdminInitiateAuthResponse

Associated Types

type Rep AdminInitiateAuthResponse :: * -> *

Methods

from :: AdminInitiateAuthResponse -> Rep AdminInitiateAuthResponse x

to :: Rep AdminInitiateAuthResponse x -> AdminInitiateAuthResponse

NFData AdminInitiateAuthResponse

Methods

rnf :: AdminInitiateAuthResponse -> ()

type Rep AdminInitiateAuthResponse

type Rep AdminInitiateAuthResponse = D1 (MetaData "AdminInitiateAuthResponse" "Network.AWS.CognitoIdentityProvider.AdminInitiateAuth" "amazonka-cognito-idp-1.4.5-GXmpY7qnFXp3lLWwYVX1Gb" False) (C1 (MetaCons "AdminInitiateAuthResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aiarsChallengeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChallengeNameType))) (S1 (MetaSel (Just Symbol "_aiarsChallengeParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_aiarsAuthenticationResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthenticationResultType))) ((:*:) (S1 (MetaSel (Just Symbol "_aiarsSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aiarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))))

Response Lenses

aiarsChallengeName :: Lens' AdminInitiateAuthResponse (Maybe ChallengeNameType)

The name of the challenge.

aiarsChallengeParameters :: Lens' AdminInitiateAuthResponse (HashMap Text Text)

The challenge parameters.

aiarsAuthenticationResult :: Lens' AdminInitiateAuthResponse (Maybe AuthenticationResultType)

The result of the authentication response.

aiarsSession :: Lens' AdminInitiateAuthResponse (Maybe Text)

The session.

aiarsResponseStatus :: Lens' AdminInitiateAuthResponse Int

• - | The response status code.