software.amazon.awssdk.services.cognitoidentityprovider.model

Interface RespondToAuthChallengeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CognitoIdentityProviderRequest.Builder, CopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>, SdkBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>, SdkRequest.Builder

Enclosing class:

RespondToAuthChallengeRequest

public static interface RespondToAuthChallengeRequest.Builder
extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

Method Summary

Modifier and Type	Method and Description
RespondToAuthChallengeRequest.Builder	challengeName(ChallengeNameType challengeName) The challenge name.
RespondToAuthChallengeRequest.Builder	challengeName(String challengeName) The challenge name.
RespondToAuthChallengeRequest.Builder	challengeResponses(Map<String,String> challengeResponses) The challenge responses.
RespondToAuthChallengeRequest.Builder	clientId(String clientId) The app client ID.
RespondToAuthChallengeRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
RespondToAuthChallengeRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
RespondToAuthChallengeRequest.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.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

clientId

RespondToAuthChallengeRequest.Builder clientId(String clientId)

The app client ID.

Parameters:

clientId - The app client ID.

Returns:

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

challengeName

RespondToAuthChallengeRequest.Builder challengeName(String challengeName)

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Parameters:

challengeName - The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Returns:

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

See Also:

ChallengeNameType, ChallengeNameType

challengeName

RespondToAuthChallengeRequest.Builder challengeName(ChallengeNameType challengeName)

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Parameters:

challengeName - The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Returns:

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

See Also:

ChallengeNameType, ChallengeNameType

session

RespondToAuthChallengeRequest.Builder session(String session)

The session which should be passed both ways in challenge-response calls to the service. If 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 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.

challengeResponses

RespondToAuthChallengeRequest.Builder challengeResponses(Map<String,String> challengeResponses)

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

Parameters:

challengeResponses - The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

Returns:

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

requestOverrideConfig

RespondToAuthChallengeRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

RespondToAuthChallengeRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.