RespondToAuthChallengeRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.17.187 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.RespondToAuthChallengeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RespondToAuthChallengeRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

The request to respond to an authentication challenge.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RespondToAuthChallengeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RespondToAuthChallengeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyticsMetadataType`	`analyticsMetadata()` The Amazon Pinpoint analytics metadata for collecting metrics for `RespondToAuthChallenge` calls.
`static RespondToAuthChallengeRequest.Builder`	`builder()`
`ChallengeNameType`	`challengeName()` The challenge name.
`String`	`challengeNameAsString()` The challenge name.
`Map<String,String>`	`challengeResponses()` The challenge responses.
`String`	`clientId()` The app client ID.
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChallengeResponses()` For responses, this returns true if the service returned a value for the ChallengeResponses property.
`boolean`	`hasClientMetadata()` For responses, this returns true if the service returned a value for the ClientMetadata property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RespondToAuthChallengeRequest.Builder>`	`serializableBuilderClass()`
`String`	`session()` The session that should be passed both ways in challenge-response calls to the service.
`RespondToAuthChallengeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientId
```
public final String clientId()
```
    The app client ID.
    
    Returns:
    
    The app client ID.
  - challengeName
```
public final ChallengeNameType challengeName()
```
    The challenge name. For more information, see InitiateAuth.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    If the service returns an enum value that is not available in the current SDK version, challengeName will return ChallengeNameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from challengeNameAsString().
    
    Returns:
    
    The challenge name. For more information, see InitiateAuth.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    See Also:
    
    ChallengeNameType
  - challengeNameAsString
```
public final String challengeNameAsString()
```
    The challenge name. For more information, see InitiateAuth.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    If the service returns an enum value that is not available in the current SDK version, challengeName will return ChallengeNameType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from challengeNameAsString().
    
    Returns:
    
    The challenge name. For more information, see InitiateAuth.
    
    ADMIN_NO_SRP_AUTH isn't a valid value.
    
    See Also:
    
    ChallengeNameType
  - session
```
public final String session()
```
    The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass 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:
    
    The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
  - hasChallengeResponses
```
public final boolean hasChallengeResponses()
```
    For responses, this returns true if the service returned a value for the ChallengeResponses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - challengeResponses
```
public final Map<String,String> challengeResponses()
```
    The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
    
    SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
    - SMS_MFA: SMS_MFA_CODE, USERNAME.
    - PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
      
      PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.
    - SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
    - DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
    - DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
    - MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChallengeResponses() method.
    Returns:
    The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
    
    SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
    
    SMS_MFA: SMS_MFA_CODE, USERNAME.
    
    PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
    
    PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.
    
    SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
    
    DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
    
    DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
    
    MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
  - analyticsMetadata
```
public final AnalyticsMetadataType analyticsMetadata()
```
    The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
    
    Returns:
    
    The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
  - userContextData
```
public final 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.
    
    Returns:
    
    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.
  - hasClientMetadata
```
public final boolean hasClientMetadata()
```
    For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - clientMetadata
```
public final 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 Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. 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 RespondToAuthChallenge request. In your function code in 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.
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.
    Returns:
    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 Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. 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 RespondToAuthChallenge request. In your function code in 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.
    
    When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - toBuilder
```
public RespondToAuthChallengeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static RespondToAuthChallengeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RespondToAuthChallengeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RespondToAuthChallengeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

clientId

challengeName

challengeNameAsString

session

hasChallengeResponses

challengeResponses

analyticsMetadata

userContextData

hasClientMetadata

clientMetadata

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields