public static interface AdminRespondToAuthChallengeRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,AdminRespondToAuthChallengeRequest>
| 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.
|
AdminRespondToAuthChallengeRequest.Builder |
clientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action
triggers.
|
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) |
AdminRespondToAuthChallengeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildAdminRespondToAuthChallengeRequest.Builder userPoolId(String userPoolId)
The ID of the Amazon Cognito user pool.
userPoolId - The ID of the Amazon Cognito user pool.AdminRespondToAuthChallengeRequest.Builder clientId(String clientId)
The app client ID.
clientId - The app client ID.AdminRespondToAuthChallengeRequest.Builder challengeName(String challengeName)
The challenge name. For more information, see AdminInitiateAuth.
challengeName - The challenge name. For more information, see AdminInitiateAuth.ChallengeNameType,
ChallengeNameTypeAdminRespondToAuthChallengeRequest.Builder challengeName(ChallengeNameType challengeName)
The challenge name. For more information, see AdminInitiateAuth.
challengeName - The challenge name. For more information, see AdminInitiateAuth.ChallengeNameType,
ChallengeNameTypeAdminRespondToAuthChallengeRequest.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).
MFA_SETUP requires USERNAME, plus you need to use the session value returned by
VerifySoftwareToken in the Session parameter.
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.
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).
MFA_SETUP requires USERNAME, plus you need to use the session value returned
by VerifySoftwareToken in the Session parameter.
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.
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.
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.AdminRespondToAuthChallengeRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge
calls.
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.
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).analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.BuilderanalyticsMetadata(AnalyticsMetadataType)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.
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.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 theContextDataType.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).contextData - a consumer that will call methods on ContextDataType.BuildercontextData(ContextDataType)AdminRespondToAuthChallengeRequest.Builder clientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the
following triggers: pre sign-up, custom message, post authentication, user
migration, pre token generation, define auth challenge, create auth challenge, and
verify auth challenge response. When Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a clientMetadata attribute,
which provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge
request. In your function code in AWS Lambda, you can process the clientMetadata value to
enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this
action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the
following triggers: pre sign-up, custom message, post authentication, user
migration, pre token generation, define auth challenge, create auth
challenge, and verify auth challenge response. When Amazon Cognito invokes any of these
functions, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to the ClientMetadata
parameter in your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, you can
process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
Take the following limitations into consideration when you use the ClientMetadata parameter:
Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
Amazon Cognito does not validate the ClientMetadata value.
Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
AdminRespondToAuthChallengeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderAdminRespondToAuthChallengeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.