Interface AdminRespondToAuthChallengeResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CognitoIdentityProviderResponse.Builder,CopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>,SdkBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- AdminRespondToAuthChallengeResponse
public static interface AdminRespondToAuthChallengeResponse.Builder extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default AdminRespondToAuthChallengeResponse.BuilderauthenticationResult(Consumer<AuthenticationResultType.Builder> authenticationResult)The outcome of a successful authentication process.AdminRespondToAuthChallengeResponse.BuilderauthenticationResult(AuthenticationResultType authenticationResult)The outcome of a successful authentication process.AdminRespondToAuthChallengeResponse.BuilderchallengeName(String challengeName)The name of the challenge that you must next respond to.AdminRespondToAuthChallengeResponse.BuilderchallengeName(ChallengeNameType challengeName)The name of the challenge that you must next respond to.AdminRespondToAuthChallengeResponse.BuilderchallengeParameters(Map<String,String> challengeParameters)The parameters that define your response to the next challenge.AdminRespondToAuthChallengeResponse.Buildersession(String session)The session identifier that maintains the state of authentication requests and challenge responses.-
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
challengeName
AdminRespondToAuthChallengeResponse.Builder challengeName(String challengeName)
The name of the challenge that you must next respond to. You can find more information about values for
ChallengeNamein the response parameters of AdminInitiateAuth.- Parameters:
challengeName- The name of the challenge that you must next respond to. You can find more information about values forChallengeNamein the response parameters of AdminInitiateAuth.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChallengeNameType,ChallengeNameType
-
challengeName
AdminRespondToAuthChallengeResponse.Builder challengeName(ChallengeNameType challengeName)
The name of the challenge that you must next respond to. You can find more information about values for
ChallengeNamein the response parameters of AdminInitiateAuth.- Parameters:
challengeName- The name of the challenge that you must next respond to. You can find more information about values forChallengeNamein the response parameters of AdminInitiateAuth.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChallengeNameType,ChallengeNameType
-
session
AdminRespondToAuthChallengeResponse.Builder session(String session)
The session identifier that maintains the state of authentication requests and challenge responses. If an
AdminInitiateAuthorAdminRespondToAuthChallengeAPI request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the nextAdminRespondToAuthChallengerequest.- Parameters:
session- The session identifier that maintains the state of authentication requests and challenge responses. If anAdminInitiateAuthorAdminRespondToAuthChallengeAPI request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the nextAdminRespondToAuthChallengerequest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
challengeParameters
AdminRespondToAuthChallengeResponse.Builder challengeParameters(Map<String,String> challengeParameters)
The parameters that define your response to the next challenge. Take the values in
ChallengeParametersand provide values for them in the ChallengeResponses of the nextAdminRespondToAuthChallengerequest.- Parameters:
challengeParameters- The parameters that define your response to the next challenge. Take the values inChallengeParametersand provide values for them in the ChallengeResponses of the nextAdminRespondToAuthChallengerequest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authenticationResult
AdminRespondToAuthChallengeResponse.Builder authenticationResult(AuthenticationResultType authenticationResult)
The outcome of a successful authentication process. After your application has passed all challenges, Amazon Cognito returns an
AuthenticationResultwith the JSON web tokens (JWTs) that indicate successful sign-in.- Parameters:
authenticationResult- The outcome of a successful authentication process. After your application has passed all challenges, Amazon Cognito returns anAuthenticationResultwith the JSON web tokens (JWTs) that indicate successful sign-in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authenticationResult
default AdminRespondToAuthChallengeResponse.Builder authenticationResult(Consumer<AuthenticationResultType.Builder> authenticationResult)
The outcome of a successful authentication process. After your application has passed all challenges, Amazon Cognito returns an
This is a convenience method that creates an instance of theAuthenticationResultwith the JSON web tokens (JWTs) that indicate successful sign-in.AuthenticationResultType.Builderavoiding the need to create one manually viaAuthenticationResultType.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toauthenticationResult(AuthenticationResultType).- Parameters:
authenticationResult- a consumer that will call methods onAuthenticationResultType.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
authenticationResult(AuthenticationResultType)
-
-