RespondToAuthChallengeRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.13.4 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class RespondToAuthChallengeRequest
extends AmazonWebServiceRequest
implements Serializable
```
Responds to the authentication challenge.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RespondToAuthChallengeRequest()

Constructors
Constructor and Description
`RespondToAuthChallengeRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RespondToAuthChallengeRequest`	`addChallengeResponsesEntry(String key, String value)` The challenge responses.
`RespondToAuthChallengeRequest`	`clearChallengeResponsesEntries()` Removes all the entries added into ChallengeResponses.
`boolean`	`equals(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The Amazon Pinpoint analytics metadata for collecting metrics for `RespondToAuthChallenge` calls.
`String`	`getChallengeName()` The challenge name.
`Map<String,String>`	`getChallengeResponses()` The challenge responses.
`String`	`getClientId()` The app client ID.
`String`	`getSession()` The session which should be passed both ways in challenge-response calls to the service.
`UserContextDataType`	`getUserContextData()` 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.
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata for collecting metrics for `RespondToAuthChallenge` calls.
`void`	`setChallengeName(ChallengeNameType challengeName)` The challenge name.
`void`	`setChallengeName(String challengeName)` The challenge name.
`void`	`setChallengeResponses(Map<String,String> challengeResponses)` The challenge responses.
`void`	`setClientId(String clientId)` The app client ID.
`void`	`setSession(String session)` The session which should be passed both ways in challenge-response calls to the service.
`void`	`setUserContextData(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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RespondToAuthChallengeRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The Amazon Pinpoint analytics metadata for collecting metrics for `RespondToAuthChallenge` calls.
`RespondToAuthChallengeRequest`	`withChallengeName(ChallengeNameType challengeName)` The challenge name.
`RespondToAuthChallengeRequest`	`withChallengeName(String challengeName)` The challenge name.
`RespondToAuthChallengeRequest`	`withChallengeResponses(Map<String,String> challengeResponses)` The challenge responses.
`RespondToAuthChallengeRequest`	`withClientId(String clientId)` The app client ID.
`RespondToAuthChallengeRequest`	`withSession(String session)` The session which should be passed both ways in challenge-response calls to the service.
`RespondToAuthChallengeRequest`	`withUserContextData(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 com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - RespondToAuthChallengeRequest
```
public RespondToAuthChallengeRequest()
```
- Method Detail
  - getClientId
```
public String getClientId()
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The app client ID.
  - setClientId
```
public void setClientId(String clientId)
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID.
  - withClientId
```
public RespondToAuthChallengeRequest withClientId(String clientId)
```
    The app client ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getChallengeName
```
public String getChallengeName()
```
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Returns:
    
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(String challengeName)
```
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeRequest withChallengeName(String challengeName)
```
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(ChallengeNameType challengeName)
```
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeRequest withChallengeName(ChallengeNameType challengeName)
```
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see .
    
    ADMIN_NO_SRP_AUTH is not a valid value.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - getSession
```
public String getSession()
```
    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.
    
    Constraints:
    Length: 20 - 2048
    
    Returns:
    
    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.
  - setSession
```
public void setSession(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.
    
    Constraints:
    Length: 20 - 2048
    
    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.
  - withSession
```
public RespondToAuthChallengeRequest withSession(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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getChallengeResponses
```
public Map<String,String> getChallengeResponses()
```
    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:
    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).
  - setChallengeResponses
```
public void setChallengeResponses(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).
  - withChallengeResponses
```
public RespondToAuthChallengeRequest withChallengeResponses(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).
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeResponsesEntry
```
public RespondToAuthChallengeRequest addChallengeResponsesEntry(String key,
                                                                String value)
```
    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).
    The method adds a new key-value pair into ChallengeResponses parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into ChallengeResponses.
    
    value - The corresponding value of the entry to be added into ChallengeResponses.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearChallengeResponsesEntries
```
public RespondToAuthChallengeRequest clearChallengeResponsesEntries()
```
    Removes all the entries added into ChallengeResponses.
    Returns a reference to this object so that method calls can be chained together.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
    
    Returns:
    
    The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(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.
  - withAnalyticsMetadata
```
public RespondToAuthChallengeRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserContextData
```
public UserContextDataType getUserContextData()
```
    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.
  - setUserContextData
```
public void setUserContextData(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.
  - withUserContextData
```
public RespondToAuthChallengeRequest withUserContextData(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 a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class RespondToAuthChallengeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

RespondToAuthChallengeRequest

Method Detail

getClientId

setClientId

withClientId

getChallengeName

setChallengeName

withChallengeName

setChallengeName

withChallengeName

getSession

setSession

withSession

getChallengeResponses

setChallengeResponses

withChallengeResponses

addChallengeResponsesEntry

clearChallengeResponsesEntries

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

getUserContextData

setUserContextData

withUserContextData

toString

hashCode

equals