AdminRespondToAuthChallengeRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AdminRespondToAuthChallengeRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Responds to an authentication challenge, as an administrator.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminRespondToAuthChallengeRequest()

Constructors
Constructor and Description
`AdminRespondToAuthChallengeRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminRespondToAuthChallengeRequest`	`addChallengeResponsesEntry(java.lang.String key, java.lang.String value)` The challenge responses.
`AdminRespondToAuthChallengeRequest`	`addClientMetadataEntry(java.lang.String key, java.lang.String value)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`AdminRespondToAuthChallengeRequest`	`clearChallengeResponsesEntries()` Removes all the entries added into ChallengeResponses.
`AdminRespondToAuthChallengeRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(java.lang.Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminRespondToAuthChallenge` calls.
`java.lang.String`	`getChallengeName()` The challenge name.
`java.util.Map<java.lang.String,java.lang.String>`	`getChallengeResponses()` The challenge responses.
`java.lang.String`	`getClientId()` The app client ID.
`java.util.Map<java.lang.String,java.lang.String>`	`getClientMetadata()` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`ContextDataType`	`getContextData()` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`java.lang.String`	`getSession()` The session that should be passed both ways in challenge-response calls to the service.
`java.lang.String`	`getUserPoolId()` The ID of the Amazon Cognito user pool.
`int`	`hashCode()`
`void`	`setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminRespondToAuthChallenge` calls.
`void`	`setChallengeName(ChallengeNameType challengeName)` The challenge name.
`void`	`setChallengeName(java.lang.String challengeName)` The challenge name.
`void`	`setChallengeResponses(java.util.Map<java.lang.String,java.lang.String> challengeResponses)` The challenge responses.
`void`	`setClientId(java.lang.String clientId)` The app client ID.
`void`	`setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`void`	`setContextData(ContextDataType contextData)` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`void`	`setSession(java.lang.String session)` The session that should be passed both ways in challenge-response calls to the service.
`void`	`setUserPoolId(java.lang.String userPoolId)` The ID of the Amazon Cognito user pool.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminRespondToAuthChallengeRequest`	`withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminRespondToAuthChallenge` calls.
`AdminRespondToAuthChallengeRequest`	`withChallengeName(ChallengeNameType challengeName)` The challenge name.
`AdminRespondToAuthChallengeRequest`	`withChallengeName(java.lang.String challengeName)` The challenge name.
`AdminRespondToAuthChallengeRequest`	`withChallengeResponses(java.util.Map<java.lang.String,java.lang.String> challengeResponses)` The challenge responses.
`AdminRespondToAuthChallengeRequest`	`withClientId(java.lang.String clientId)` The app client ID.
`AdminRespondToAuthChallengeRequest`	`withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`AdminRespondToAuthChallengeRequest`	`withContextData(ContextDataType contextData)` Contextual data about your user session, such as the device fingerprint, IP address, or location.
`AdminRespondToAuthChallengeRequest`	`withSession(java.lang.String session)` The session that should be passed both ways in challenge-response calls to the service.
`AdminRespondToAuthChallengeRequest`	`withUserPoolId(java.lang.String userPoolId)` The ID of the Amazon Cognito user pool.

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
  - AdminRespondToAuthChallengeRequest
```
public AdminRespondToAuthChallengeRequest()
```
- Method Detail
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The ID of the Amazon Cognito user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The ID of the Amazon Cognito user pool.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The ID of the Amazon Cognito user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the Amazon Cognito user pool.
  - withUserPoolId
```
public AdminRespondToAuthChallengeRequest withUserPoolId(java.lang.String userPoolId)
```
    The ID of the Amazon Cognito user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the Amazon Cognito user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientId
```
public java.lang.String getClientId()
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The app client ID.
  - setClientId
```
public void setClientId(java.lang.String clientId)
```
    The app client ID.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The app client ID.
  - withClientId
```
public AdminRespondToAuthChallengeRequest withClientId(java.lang.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 java.lang.String getChallengeName()
```
    The challenge name. For more information, see AdminInitiateAuth.
    
    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 AdminInitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(java.lang.String challengeName)
```
    The challenge name. For more information, see AdminInitiateAuth.
    
    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 AdminInitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public AdminRespondToAuthChallengeRequest withChallengeName(java.lang.String challengeName)
```
    The challenge name. For more information, see AdminInitiateAuth.
    
    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 AdminInitiateAuth.
    
    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 AdminInitiateAuth.
    
    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 AdminInitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public AdminRespondToAuthChallengeRequest withChallengeName(ChallengeNameType challengeName)
```
    The challenge name. For more information, see AdminInitiateAuth.
    
    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 AdminInitiateAuth.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - getChallengeResponses
```
public java.util.Map<java.lang.String,java.lang.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).
      
      PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    - MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    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).
    
    PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    
    ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
    
    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    
    MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
  - setChallengeResponses
```
public void setChallengeResponses(java.util.Map<java.lang.String,java.lang.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).
      
      PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    - MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    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).
    
    PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    
    ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
    
    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    
    MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
  - withChallengeResponses
```
public AdminRespondToAuthChallengeRequest withChallengeResponses(java.util.Map<java.lang.String,java.lang.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).
      
      PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    - MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    
    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).
    
    PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    
    ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
    
    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    
    MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeResponsesEntry
```
public AdminRespondToAuthChallengeRequest addChallengeResponsesEntry(java.lang.String key,
                                                                     java.lang.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).
      
      PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a remembered device.
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.
      
      In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
    - MFA_SETUP requires USERNAME, plus you must 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 an email address or phone number). To make this simpler, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
    
    For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.
    
    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 AdminRespondToAuthChallengeRequest clearChallengeResponsesEntries()
```
    Removes all the entries added into ChallengeResponses.
    Returns a reference to this object so that method calls can be chained together.
  - getSession
```
public java.lang.String getSession()
```
    The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns 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 that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
  - setSession
```
public void setSession(java.lang.String session)
```
    The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns 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 that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
  - withSession
```
public AdminRespondToAuthChallengeRequest withSession(java.lang.String session)
```
    The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns 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 that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns 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.
  - getAnalyticsMetadata
```
public AnalyticsMetadataType getAnalyticsMetadata()
```
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
    
    Returns:
    
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
  - setAnalyticsMetadata
```
public void setAnalyticsMetadata(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.
  - withAnalyticsMetadata
```
public AdminRespondToAuthChallengeRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)
```
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsMetadata -
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getContextData
```
public ContextDataType getContextData()
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns:
    
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
  - setContextData
```
public void setContextData(ContextDataType contextData)
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Parameters:
    
    contextData -
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
  - withContextData
```
public AdminRespondToAuthChallengeRequest withContextData(ContextDataType contextData)
```
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    contextData -
    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getClientMetadata()
```
    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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    - pre sign-up
    - custom message
    - post authentication
    - user migration
    - pre token generation
    - define auth challenge
    - create auth challenge
    - 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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
    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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    
    pre sign-up
    
    custom message
    
    post authentication
    
    user migration
    
    pre token generation
    
    define auth challenge
    
    create auth challenge
    
    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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
  - setClientMetadata
```
public void setClientMetadata(java.util.Map<java.lang.String,java.lang.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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    - pre sign-up
    - custom message
    - post authentication
    - user migration
    - pre token generation
    - define auth challenge
    - create auth challenge
    - 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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
    Parameters:
    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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    
    pre sign-up
    
    custom message
    
    post authentication
    
    user migration
    
    pre token generation
    
    define auth challenge
    
    create auth challenge
    
    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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
  - withClientMetadata
```
public AdminRespondToAuthChallengeRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    - pre sign-up
    - custom message
    - post authentication
    - user migration
    - pre token generation
    - define auth challenge
    - create auth challenge
    - 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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    
    pre sign-up
    
    custom message
    
    post authentication
    
    user migration
    
    pre token generation
    
    define auth challenge
    
    create auth challenge
    
    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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public AdminRespondToAuthChallengeRequest addClientMetadataEntry(java.lang.String key,
                                                                 java.lang.String value)
```
    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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
    - pre sign-up
    - custom message
    - post authentication
    - user migration
    - pre token generation
    - define auth challenge
    - create auth challenge
    - 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 that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge 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.
    The method adds a new key-value pair into ClientMetadata 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 ClientMetadata.
    
    value - The corresponding value of the entry to be added into ClientMetadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearClientMetadataEntries
```
public AdminRespondToAuthChallengeRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AdminRespondToAuthChallengeRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminRespondToAuthChallengeRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientId

setClientId

withClientId

getChallengeName

setChallengeName

withChallengeName

setChallengeName

withChallengeName

getChallengeResponses

setChallengeResponses

withChallengeResponses

addChallengeResponsesEntry

clearChallengeResponsesEntries

getSession

setSession

withSession

getAnalyticsMetadata

setAnalyticsMetadata

withAnalyticsMetadata

getContextData

setContextData

withContextData

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

toString

hashCode

equals