Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.CognitoIdentityProvider.AdminInitiateAuth
Description
Initiates the authentication flow, as an administrator.
- adminInitiateAuth :: Text -> Text -> AuthFlowType -> AdminInitiateAuth
- data AdminInitiateAuth
- aiaClientMetadata :: Lens' AdminInitiateAuth (HashMap Text Text)
- aiaAuthParameters :: Lens' AdminInitiateAuth (HashMap Text Text)
- aiaUserPoolId :: Lens' AdminInitiateAuth Text
- aiaClientId :: Lens' AdminInitiateAuth Text
- aiaAuthFlow :: Lens' AdminInitiateAuth AuthFlowType
- adminInitiateAuthResponse :: Int -> AdminInitiateAuthResponse
- data AdminInitiateAuthResponse
- aiarsChallengeName :: Lens' AdminInitiateAuthResponse (Maybe ChallengeNameType)
- aiarsChallengeParameters :: Lens' AdminInitiateAuthResponse (HashMap Text Text)
- aiarsAuthenticationResult :: Lens' AdminInitiateAuthResponse (Maybe AuthenticationResultType)
- aiarsSession :: Lens' AdminInitiateAuthResponse (Maybe Text)
- aiarsResponseStatus :: Lens' AdminInitiateAuthResponse Int
Creating a Request
Arguments
:: Text | |
-> Text | |
-> AuthFlowType | |
-> 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
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
Arguments
:: Int | |
-> 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.
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.