AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest Class Reference

#include <RespondToAuthChallengeRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest:

Public Member Functions

 RespondToAuthChallengeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
RespondToAuthChallengeRequestWithClientId (const Aws::String &value)
 
RespondToAuthChallengeRequestWithClientId (Aws::String &&value)
 
RespondToAuthChallengeRequestWithClientId (const char *value)
 
const ChallengeNameTypeGetChallengeName () const
 
bool ChallengeNameHasBeenSet () const
 
void SetChallengeName (const ChallengeNameType &value)
 
void SetChallengeName (ChallengeNameType &&value)
 
RespondToAuthChallengeRequestWithChallengeName (const ChallengeNameType &value)
 
RespondToAuthChallengeRequestWithChallengeName (ChallengeNameType &&value)
 
const Aws::StringGetSession () const
 
bool SessionHasBeenSet () const
 
void SetSession (const Aws::String &value)
 
void SetSession (Aws::String &&value)
 
void SetSession (const char *value)
 
RespondToAuthChallengeRequestWithSession (const Aws::String &value)
 
RespondToAuthChallengeRequestWithSession (Aws::String &&value)
 
RespondToAuthChallengeRequestWithSession (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetChallengeResponses () const
 
bool ChallengeResponsesHasBeenSet () const
 
void SetChallengeResponses (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetChallengeResponses (Aws::Map< Aws::String, Aws::String > &&value)
 
RespondToAuthChallengeRequestWithChallengeResponses (const Aws::Map< Aws::String, Aws::String > &value)
 
RespondToAuthChallengeRequestWithChallengeResponses (Aws::Map< Aws::String, Aws::String > &&value)
 
RespondToAuthChallengeRequestAddChallengeResponses (const Aws::String &key, const Aws::String &value)
 
RespondToAuthChallengeRequestAddChallengeResponses (Aws::String &&key, const Aws::String &value)
 
RespondToAuthChallengeRequestAddChallengeResponses (const Aws::String &key, Aws::String &&value)
 
RespondToAuthChallengeRequestAddChallengeResponses (Aws::String &&key, Aws::String &&value)
 
RespondToAuthChallengeRequestAddChallengeResponses (const char *key, Aws::String &&value)
 
RespondToAuthChallengeRequestAddChallengeResponses (Aws::String &&key, const char *value)
 
RespondToAuthChallengeRequestAddChallengeResponses (const char *key, const char *value)
 
const AnalyticsMetadataTypeGetAnalyticsMetadata () const
 
bool AnalyticsMetadataHasBeenSet () const
 
void SetAnalyticsMetadata (const AnalyticsMetadataType &value)
 
void SetAnalyticsMetadata (AnalyticsMetadataType &&value)
 
RespondToAuthChallengeRequestWithAnalyticsMetadata (const AnalyticsMetadataType &value)
 
RespondToAuthChallengeRequestWithAnalyticsMetadata (AnalyticsMetadataType &&value)
 
const UserContextDataTypeGetUserContextData () const
 
bool UserContextDataHasBeenSet () const
 
void SetUserContextData (const UserContextDataType &value)
 
void SetUserContextData (UserContextDataType &&value)
 
RespondToAuthChallengeRequestWithUserContextData (const UserContextDataType &value)
 
RespondToAuthChallengeRequestWithUserContextData (UserContextDataType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetClientMetadata () const
 
bool ClientMetadataHasBeenSet () const
 
void SetClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
RespondToAuthChallengeRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
RespondToAuthChallengeRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
RespondToAuthChallengeRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
RespondToAuthChallengeRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
RespondToAuthChallengeRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
RespondToAuthChallengeRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
RespondToAuthChallengeRequestAddClientMetadata (const char *key, Aws::String &&value)
 
RespondToAuthChallengeRequestAddClientMetadata (Aws::String &&key, const char *value)
 
RespondToAuthChallengeRequestAddClientMetadata (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

The request to respond to an authentication challenge.

See Also:

AWS API Reference

Definition at line 29 of file RespondToAuthChallengeRequest.h.

Constructor & Destructor Documentation

◆ RespondToAuthChallengeRequest()

Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::RespondToAuthChallengeRequest ( )

Member Function Documentation

◆ AddChallengeResponses() [1/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 430 of file RespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [2/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( Aws::String &&  key,
const Aws::String value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 384 of file RespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [3/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( Aws::String &&  key,
const char *  value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 476 of file RespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [4/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( const Aws::String key,
Aws::String &&  value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 407 of file RespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [5/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( const Aws::String key,
const Aws::String value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 361 of file RespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [6/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( const char *  key,
Aws::String &&  value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 453 of file RespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [7/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddChallengeResponses ( const char *  key,
const char *  value 
)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 499 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [1/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 860 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [2/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 804 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [3/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( Aws::String &&  key,
const char *  value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 916 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [4/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 832 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [5/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( const Aws::String key,
const Aws::String value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 776 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [6/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( const char *  key,
Aws::String &&  value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 888 of file RespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [7/7]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AddClientMetadata ( const char *  key,
const char *  value 
)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 944 of file RespondToAuthChallengeRequest.h.

◆ AnalyticsMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::AnalyticsMetadataHasBeenSet ( ) const
inline

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Definition at line 512 of file RespondToAuthChallengeRequest.h.

◆ ChallengeNameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::ChallengeNameHasBeenSet ( ) const
inline

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Definition at line 98 of file RespondToAuthChallengeRequest.h.

◆ ChallengeResponsesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::ChallengeResponsesHasBeenSet ( ) const
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 246 of file RespondToAuthChallengeRequest.h.

◆ ClientIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::ClientIdHasBeenSet ( ) const
inline

The app client ID.

Definition at line 53 of file RespondToAuthChallengeRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::ClientMetadataHasBeenSet ( ) const
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 636 of file RespondToAuthChallengeRequest.h.

◆ GetAnalyticsMetadata()

const AnalyticsMetadataType& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetAnalyticsMetadata ( ) const
inline

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Definition at line 506 of file RespondToAuthChallengeRequest.h.

◆ GetChallengeName()

const ChallengeNameType& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetChallengeName ( ) const
inline

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Definition at line 91 of file RespondToAuthChallengeRequest.h.

◆ GetChallengeResponses()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetChallengeResponses ( ) const
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 223 of file RespondToAuthChallengeRequest.h.

◆ GetClientId()

const Aws::String& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetClientId ( ) const
inline

The app client ID.

Definition at line 48 of file RespondToAuthChallengeRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetClientMetadata ( ) const
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 608 of file RespondToAuthChallengeRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file RespondToAuthChallengeRequest.h.

◆ GetSession()

const Aws::String& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetSession ( ) const
inline

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.

Definition at line 136 of file RespondToAuthChallengeRequest.h.

◆ GetUserContextData()

const UserContextDataType& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::GetUserContextData ( ) const
inline

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.

Definition at line 544 of file RespondToAuthChallengeRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SessionHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SessionHasBeenSet ( ) const
inline

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.

Definition at line 145 of file RespondToAuthChallengeRequest.h.

◆ SetAnalyticsMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetAnalyticsMetadata ( AnalyticsMetadataType &&  value)
inline

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Definition at line 524 of file RespondToAuthChallengeRequest.h.

◆ SetAnalyticsMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetAnalyticsMetadata ( const AnalyticsMetadataType value)
inline

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Definition at line 518 of file RespondToAuthChallengeRequest.h.

◆ SetChallengeName() [1/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetChallengeName ( ChallengeNameType &&  value)
inline

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Definition at line 112 of file RespondToAuthChallengeRequest.h.

◆ SetChallengeName() [2/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetChallengeName ( const ChallengeNameType value)
inline

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Definition at line 105 of file RespondToAuthChallengeRequest.h.

◆ SetChallengeResponses() [1/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetChallengeResponses ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 292 of file RespondToAuthChallengeRequest.h.

◆ SetChallengeResponses() [2/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetChallengeResponses ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 269 of file RespondToAuthChallengeRequest.h.

◆ SetClientId() [1/3]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetClientId ( Aws::String &&  value)
inline

The app client ID.

Definition at line 63 of file RespondToAuthChallengeRequest.h.

◆ SetClientId() [2/3]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetClientId ( const Aws::String value)
inline

The app client ID.

Definition at line 58 of file RespondToAuthChallengeRequest.h.

◆ SetClientId() [3/3]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetClientId ( const char *  value)
inline

The app client ID.

Definition at line 68 of file RespondToAuthChallengeRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 692 of file RespondToAuthChallengeRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 664 of file RespondToAuthChallengeRequest.h.

◆ SetSession() [1/3]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetSession ( Aws::String &&  value)
inline

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.

Definition at line 163 of file RespondToAuthChallengeRequest.h.

◆ SetSession() [2/3]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetSession ( const Aws::String value)
inline

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.

Definition at line 154 of file RespondToAuthChallengeRequest.h.

◆ SetSession() [3/3]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetSession ( const char *  value)
inline

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.

Definition at line 172 of file RespondToAuthChallengeRequest.h.

◆ SetUserContextData() [1/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetUserContextData ( const UserContextDataType value)
inline

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.

Definition at line 558 of file RespondToAuthChallengeRequest.h.

◆ SetUserContextData() [2/2]

void Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::SetUserContextData ( UserContextDataType &&  value)
inline

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.

Definition at line 565 of file RespondToAuthChallengeRequest.h.

◆ UserContextDataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::UserContextDataHasBeenSet ( ) const
inline

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.

Definition at line 551 of file RespondToAuthChallengeRequest.h.

◆ WithAnalyticsMetadata() [1/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithAnalyticsMetadata ( AnalyticsMetadataType &&  value)
inline

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Definition at line 536 of file RespondToAuthChallengeRequest.h.

◆ WithAnalyticsMetadata() [2/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithAnalyticsMetadata ( const AnalyticsMetadataType value)
inline

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Definition at line 530 of file RespondToAuthChallengeRequest.h.

◆ WithChallengeName() [1/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithChallengeName ( ChallengeNameType &&  value)
inline

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Definition at line 126 of file RespondToAuthChallengeRequest.h.

◆ WithChallengeName() [2/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithChallengeName ( const ChallengeNameType value)
inline

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Definition at line 119 of file RespondToAuthChallengeRequest.h.

◆ WithChallengeResponses() [1/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithChallengeResponses ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 338 of file RespondToAuthChallengeRequest.h.

◆ WithChallengeResponses() [2/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithChallengeResponses ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

  • MFA_SETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

Definition at line 315 of file RespondToAuthChallengeRequest.h.

◆ WithClientId() [1/3]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithClientId ( Aws::String &&  value)
inline

The app client ID.

Definition at line 78 of file RespondToAuthChallengeRequest.h.

◆ WithClientId() [2/3]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithClientId ( const Aws::String value)
inline

The app client ID.

Definition at line 73 of file RespondToAuthChallengeRequest.h.

◆ WithClientId() [3/3]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithClientId ( const char *  value)
inline

The app client ID.

Definition at line 83 of file RespondToAuthChallengeRequest.h.

◆ WithClientMetadata() [1/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithClientMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 748 of file RespondToAuthChallengeRequest.h.

◆ WithClientMetadata() [2/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithClientMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in 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.

Definition at line 720 of file RespondToAuthChallengeRequest.h.

◆ WithSession() [1/3]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithSession ( Aws::String &&  value)
inline

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.

Definition at line 190 of file RespondToAuthChallengeRequest.h.

◆ WithSession() [2/3]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithSession ( const Aws::String value)
inline

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.

Definition at line 181 of file RespondToAuthChallengeRequest.h.

◆ WithSession() [3/3]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithSession ( const char *  value)
inline

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.

Definition at line 199 of file RespondToAuthChallengeRequest.h.

◆ WithUserContextData() [1/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithUserContextData ( const UserContextDataType value)
inline

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.

Definition at line 572 of file RespondToAuthChallengeRequest.h.

◆ WithUserContextData() [2/2]

RespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::RespondToAuthChallengeRequest::WithUserContextData ( UserContextDataType &&  value)
inline

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.

Definition at line 579 of file RespondToAuthChallengeRequest.h.


The documentation for this class was generated from the following file: