AdminRespondToAuthChallengeRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.16.5 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class AdminRespondToAuthChallengeRequest
extends AmazonWebServiceRequest
implements Serializable
```
Responds to an authentication challenge, as an administrator.

Calling this action requires developer credentials.

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(String key, String value)` The challenge responses.
`AdminRespondToAuthChallengeRequest`	`addClientMetadataEntry(String key, 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(Object obj)`
`AnalyticsMetadataType`	`getAnalyticsMetadata()` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminRespondToAuthChallenge` calls.
`String`	`getChallengeName()` The challenge name.
`Map<String,String>`	`getChallengeResponses()` The challenge responses.
`String`	`getClientId()` The app client ID.
`Map<String,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 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`	`getSession()` The session which should be passed both ways in challenge-response calls to the service.
`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(String challengeName)` The challenge name.
`void`	`setChallengeResponses(Map<String,String> challengeResponses)` The challenge responses.
`void`	`setClientId(String clientId)` The app client ID.
`void`	`setClientMetadata(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.
`void`	`setContextData(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.
`void`	`setSession(String session)` The session which should be passed both ways in challenge-response calls to the service.
`void`	`setUserPoolId(String userPoolId)` The ID of the Amazon Cognito user pool.
`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(String challengeName)` The challenge name.
`AdminRespondToAuthChallengeRequest`	`withChallengeResponses(Map<String,String> challengeResponses)` The challenge responses.
`AdminRespondToAuthChallengeRequest`	`withClientId(String clientId)` The app client ID.
`AdminRespondToAuthChallengeRequest`	`withClientMetadata(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.
`AdminRespondToAuthChallengeRequest`	`withContextData(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`	`withSession(String session)` The session which should be passed both ways in challenge-response calls to the service.
`AdminRespondToAuthChallengeRequest`	`withUserPoolId(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 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(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(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 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 AdminRespondToAuthChallengeRequest 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 .
    
    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 .
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(String challengeName)
```
    The challenge name. For more information, see .
    
    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 .
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public AdminRespondToAuthChallengeRequest withChallengeName(String challengeName)
```
    The challenge name. For more information, see .
    
    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 .
    
    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 .
    
    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 .
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public AdminRespondToAuthChallengeRequest withChallengeName(ChallengeNameType challengeName)
```
    The challenge name. For more information, see .
    
    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 .
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - 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).
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
    Returns:
    The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
    
    SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
  - 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).
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
    Parameters:
    challengeResponses -
    The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
    
    SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
  - withChallengeResponses
```
public AdminRespondToAuthChallengeRequest 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).
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
    
    Returns 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).
    
    ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeResponsesEntry
```
public AdminRespondToAuthChallengeRequest 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).
    - ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).
    - NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).
    The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
    
    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 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 AdminRespondToAuthChallengeRequest 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.
  - 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 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.
  - setContextData
```
public void setContextData(ContextDataType contextData)
```
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
    
    Parameters:
    
    contextData -
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
  - withContextData
```
public AdminRespondToAuthChallengeRequest withContextData(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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    contextData -
    Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientMetadata
```
public Map<String,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 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.
    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 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.
  - setClientMetadata
```
public void setClientMetadata(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.
    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 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.
  - withClientMetadata
```
public AdminRespondToAuthChallengeRequest withClientMetadata(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.
    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 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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public AdminRespondToAuthChallengeRequest addClientMetadataEntry(String key,
                                                                 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 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.
    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 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 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