/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include The request to respond to the authentication challenge, as an
* administrator.See Also:
AWS
* API Reference
The ID of the Amazon Cognito user pool.
*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *The ID of the Amazon Cognito user pool.
*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *The ID of the Amazon Cognito user pool.
*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *The ID of the Amazon Cognito user pool.
*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *The ID of the Amazon Cognito user pool.
*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *The ID of the Amazon Cognito user pool.
*/ inline AdminRespondToAuthChallengeRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *The ID of the Amazon Cognito user pool.
*/ inline AdminRespondToAuthChallengeRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *The ID of the Amazon Cognito user pool.
*/ inline AdminRespondToAuthChallengeRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *The app client ID.
*/ inline const Aws::String& GetClientId() const{ return m_clientId; } /** *The app client ID.
*/ inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; } /** *The app client ID.
*/ inline void SetClientId(const Aws::String& value) { m_clientIdHasBeenSet = true; m_clientId = value; } /** *The app client ID.
*/ inline void SetClientId(Aws::String&& value) { m_clientIdHasBeenSet = true; m_clientId = std::move(value); } /** *The app client ID.
*/ inline void SetClientId(const char* value) { m_clientIdHasBeenSet = true; m_clientId.assign(value); } /** *The app client ID.
*/ inline AdminRespondToAuthChallengeRequest& WithClientId(const Aws::String& value) { SetClientId(value); return *this;} /** *The app client ID.
*/ inline AdminRespondToAuthChallengeRequest& WithClientId(Aws::String&& value) { SetClientId(std::move(value)); return *this;} /** *The app client ID.
*/ inline AdminRespondToAuthChallengeRequest& WithClientId(const char* value) { SetClientId(value); return *this;} /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline const ChallengeNameType& GetChallengeName() const{ return m_challengeName; } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline bool ChallengeNameHasBeenSet() const { return m_challengeNameHasBeenSet; } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline void SetChallengeName(const ChallengeNameType& value) { m_challengeNameHasBeenSet = true; m_challengeName = value; } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline void SetChallengeName(ChallengeNameType&& value) { m_challengeNameHasBeenSet = true; m_challengeName = std::move(value); } /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline AdminRespondToAuthChallengeRequest& WithChallengeName(const ChallengeNameType& value) { SetChallengeName(value); return *this;} /** *The challenge name. For more information, see AdminInitiateAuth.
*/ inline AdminRespondToAuthChallengeRequest& WithChallengeName(ChallengeNameType&& value) { SetChallengeName(std::move(value)); return *this;} /** *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 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 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 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 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 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 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 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 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 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 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 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 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 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.
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.
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.
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.
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.
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.
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.
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.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
The analytics metadata for collecting Amazon Pinpoint metrics for
* AdminRespondToAuthChallenge calls.
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.
*/ inline const ContextDataType& GetContextData() const{ return m_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.
*/ inline bool ContextDataHasBeenSet() const { return m_contextDataHasBeenSet; } /** *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.
*/ inline void SetContextData(const ContextDataType& value) { m_contextDataHasBeenSet = true; m_contextData = value; } /** *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.
*/ inline void SetContextData(ContextDataType&& value) { m_contextDataHasBeenSet = true; m_contextData = std::move(value); } /** *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.
*/ inline AdminRespondToAuthChallengeRequest& WithContextData(const ContextDataType& value) { SetContextData(value); return *this;} /** *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.
*/ inline AdminRespondToAuthChallengeRequest& WithContextData(ContextDataType&& value) { SetContextData(std::move(value)); return *this;} /** *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.
*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.
*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.
*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.
*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.
*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.
*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.
*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.
*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.
*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.
*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.
*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.
*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.
*