software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminRespondToAuthChallengeResponse.Builder

All Superinterfaces:

CognitoIdentityProviderResponse.Builder, CopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>, SdkBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>

Enclosing class:

AdminRespondToAuthChallengeResponse

public static interface AdminRespondToAuthChallengeResponse.Builder
extends CognitoIdentityProviderResponse.Builder, CopyableBuilder<AdminRespondToAuthChallengeResponse.Builder,AdminRespondToAuthChallengeResponse>

Method Summary

Modifier and Type	Method and Description
AdminRespondToAuthChallengeResponse.Builder	authenticationResult(AuthenticationResultType authenticationResult) The result returned by the server in response to the authentication request.
default AdminRespondToAuthChallengeResponse.Builder	authenticationResult(Consumer<AuthenticationResultType.Builder> authenticationResult) The result returned by the server in response to the authentication request.
AdminRespondToAuthChallengeResponse.Builder	challengeName(ChallengeNameType challengeName) The name of the challenge.
AdminRespondToAuthChallengeResponse.Builder	challengeName(String challengeName) The name of the challenge.
AdminRespondToAuthChallengeResponse.Builder	challengeParameters(Map<String,String> challengeParameters) The challenge parameters.
AdminRespondToAuthChallengeResponse.Builder	session(String session) The session which should be passed both ways in challenge-response calls to the service.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

challengeName

AdminRespondToAuthChallengeResponse.Builder challengeName(String challengeName)

The name of the challenge. For more information, see AdminInitiateAuth.

Parameters:

challengeName - The name of the challenge. For more information, see 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. For more information, see AdminInitiateAuth.

Parameters:

challengeName - The name of the challenge. For more information, see 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 which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Parameters:

session - The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Returns:

Returns a reference to this object so that method calls can be chained together.

challengeParameters

AdminRespondToAuthChallengeResponse.Builder challengeParameters(Map<String,String> challengeParameters)

The challenge parameters. For more information, see AdminInitiateAuth.

Parameters:

challengeParameters - The challenge parameters. For more information, see AdminInitiateAuth.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationResult

AdminRespondToAuthChallengeResponse.Builder authenticationResult(AuthenticationResultType authenticationResult)

The result returned by the server in response to the authentication request.

Parameters:

authenticationResult - The result returned by the server in response to the authentication request.

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 result returned by the server in response to the authentication request.

This is a convenience that creates an instance of the AuthenticationResultType.Builder avoiding the need to create one manually via AuthenticationResultType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationResult(AuthenticationResultType).

Parameters:

authenticationResult - a consumer that will call methods on AuthenticationResultType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

authenticationResult(AuthenticationResultType)