software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminRespondToAuthChallengeRequest.Builder

All Superinterfaces:

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

Enclosing class:

AdminRespondToAuthChallengeRequest

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

Method Summary

Modifier and Type	Method and Description
AdminRespondToAuthChallengeRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
default AdminRespondToAuthChallengeRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
AdminRespondToAuthChallengeRequest.Builder	challengeName(ChallengeNameType challengeName) The challenge name.
AdminRespondToAuthChallengeRequest.Builder	challengeName(String challengeName) The challenge name.
AdminRespondToAuthChallengeRequest.Builder	challengeResponses(Map<String,String> challengeResponses) The challenge responses.
AdminRespondToAuthChallengeRequest.Builder	clientId(String clientId) The app client ID.
default AdminRespondToAuthChallengeRequest.Builder	contextData(Consumer<ContextDataType.Builder> contextData) 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.
AdminRespondToAuthChallengeRequest.Builder	contextData(ContextDataType contextData) 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.
AdminRespondToAuthChallengeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
AdminRespondToAuthChallengeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
AdminRespondToAuthChallengeRequest.Builder	session(String session) The session which should be passed both ways in challenge-response calls to the service.
AdminRespondToAuthChallengeRequest.Builder	userPoolId(String userPoolId) The ID of the Amazon Cognito user pool.

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

userPoolId

AdminRespondToAuthChallengeRequest.Builder userPoolId(String userPoolId)

The ID of the Amazon Cognito user pool.

Parameters:

userPoolId - The ID of the Amazon Cognito user pool.

Returns:

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

clientId

AdminRespondToAuthChallengeRequest.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

AdminRespondToAuthChallengeRequest.Builder challengeName(String challengeName)

The challenge name. For more information, see .

Parameters:

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

Returns:

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

See Also:

ChallengeNameType, ChallengeNameType

challengeName

AdminRespondToAuthChallengeRequest.Builder challengeName(ChallengeNameType challengeName)

The challenge name. For more information, see .

Parameters:

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

Returns:

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

See Also:

ChallengeNameType, ChallengeNameType

challengeResponses

AdminRespondToAuthChallengeRequest.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).

• ADMIN_NO_SRP_AUTH: PASSWORD, 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).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

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).

• ADMIN_NO_SRP_AUTH: PASSWORD, 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).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

Returns:

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

session

AdminRespondToAuthChallengeRequest.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.

analyticsMetadata

AdminRespondToAuthChallengeRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

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

Returns:

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

analyticsMetadata

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

The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge 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)

contextData

AdminRespondToAuthChallengeRequest.Builder contextData(ContextDataType contextData)

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:

contextData - 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.

contextData

default AdminRespondToAuthChallengeRequest.Builder contextData(Consumer<ContextDataType.Builder> contextData)

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 ContextDataType.Builder avoiding the need to create one manually via ContextDataType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contextData(ContextDataType).

Parameters:

contextData - a consumer that will call methods on ContextDataType.Builder

Returns:

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

See Also:

contextData(ContextDataType)

overrideConfiguration

AdminRespondToAuthChallengeRequest.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

AdminRespondToAuthChallengeRequest.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.