software.amazon.awssdk.services.cognitoidentityprovider.model

Interface RespondToAuthChallengeRequest.Builder

All Superinterfaces:

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

Enclosing class:

RespondToAuthChallengeRequest

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

Method Summary

Modifier and Type	Method and Description
RespondToAuthChallengeRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
default RespondToAuthChallengeRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
RespondToAuthChallengeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.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.
default RespondToAuthChallengeRequest.Builder	userContextData(Consumer<UserContextDataType.Builder> userContextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
RespondToAuthChallengeRequest.Builder	userContextData(UserContextDataType userContextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

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

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, 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 .

ADMIN_NO_SRP_AUTH is not a valid value.

Parameters:

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

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 .

ADMIN_NO_SRP_AUTH is not a valid value.

Parameters:

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

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.

analyticsMetadata

RespondToAuthChallengeRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Parameters:

analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Returns:

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

analyticsMetadata

default RespondToAuthChallengeRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

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

Parameters:

analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.Builder

Returns:

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

See Also:

analyticsMetadata(AnalyticsMetadataType)

userContextData

RespondToAuthChallengeRequest.Builder userContextData(UserContextDataType userContextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Parameters:

userContextData - Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

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

userContextData

default RespondToAuthChallengeRequest.Builder userContextData(Consumer<UserContextDataType.Builder> userContextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

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

Parameters:

userContextData - a consumer that will call methods on UserContextDataType.Builder

Returns:

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

See Also:

userContextData(UserContextDataType)

overrideConfiguration

RespondToAuthChallengeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

RespondToAuthChallengeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.