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

#include <AdminRespondToAuthChallengeRequest.h>

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

Public Member Functions

 AdminRespondToAuthChallengeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
AdminRespondToAuthChallengeRequestWithUserPoolId (const Aws::String &value)
 
AdminRespondToAuthChallengeRequestWithUserPoolId (Aws::String &&value)
 
AdminRespondToAuthChallengeRequestWithUserPoolId (const char *value)
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
AdminRespondToAuthChallengeRequestWithClientId (const Aws::String &value)
 
AdminRespondToAuthChallengeRequestWithClientId (Aws::String &&value)
 
AdminRespondToAuthChallengeRequestWithClientId (const char *value)
 
const ChallengeNameTypeGetChallengeName () const
 
bool ChallengeNameHasBeenSet () const
 
void SetChallengeName (const ChallengeNameType &value)
 
void SetChallengeName (ChallengeNameType &&value)
 
AdminRespondToAuthChallengeRequestWithChallengeName (const ChallengeNameType &value)
 
AdminRespondToAuthChallengeRequestWithChallengeName (ChallengeNameType &&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)
 
AdminRespondToAuthChallengeRequestWithChallengeResponses (const Aws::Map< Aws::String, Aws::String > &value)
 
AdminRespondToAuthChallengeRequestWithChallengeResponses (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (const Aws::String &key, const Aws::String &value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (Aws::String &&key, const Aws::String &value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (const Aws::String &key, Aws::String &&value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (Aws::String &&key, Aws::String &&value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (const char *key, Aws::String &&value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (Aws::String &&key, const char *value)
 
AdminRespondToAuthChallengeRequestAddChallengeResponses (const char *key, const char *value)
 
const Aws::StringGetSession () const
 
bool SessionHasBeenSet () const
 
void SetSession (const Aws::String &value)
 
void SetSession (Aws::String &&value)
 
void SetSession (const char *value)
 
AdminRespondToAuthChallengeRequestWithSession (const Aws::String &value)
 
AdminRespondToAuthChallengeRequestWithSession (Aws::String &&value)
 
AdminRespondToAuthChallengeRequestWithSession (const char *value)
 
const AnalyticsMetadataTypeGetAnalyticsMetadata () const
 
bool AnalyticsMetadataHasBeenSet () const
 
void SetAnalyticsMetadata (const AnalyticsMetadataType &value)
 
void SetAnalyticsMetadata (AnalyticsMetadataType &&value)
 
AdminRespondToAuthChallengeRequestWithAnalyticsMetadata (const AnalyticsMetadataType &value)
 
AdminRespondToAuthChallengeRequestWithAnalyticsMetadata (AnalyticsMetadataType &&value)
 
const ContextDataTypeGetContextData () const
 
bool ContextDataHasBeenSet () const
 
void SetContextData (const ContextDataType &value)
 
void SetContextData (ContextDataType &&value)
 
AdminRespondToAuthChallengeRequestWithContextData (const ContextDataType &value)
 
AdminRespondToAuthChallengeRequestWithContextData (ContextDataType &&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)
 
AdminRespondToAuthChallengeRequestWithClientMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
AdminRespondToAuthChallengeRequestWithClientMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (const Aws::String &key, const Aws::String &value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (Aws::String &&key, const Aws::String &value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (const Aws::String &key, Aws::String &&value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (Aws::String &&key, Aws::String &&value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (const char *key, Aws::String &&value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (Aws::String &&key, const char *value)
 
AdminRespondToAuthChallengeRequestAddClientMetadata (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 the authentication challenge, as an administrator.

See Also:

AWS API Reference

Definition at line 29 of file AdminRespondToAuthChallengeRequest.h.

Constructor & Destructor Documentation

◆ AdminRespondToAuthChallengeRequest()

Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::AdminRespondToAuthChallengeRequest ( )

Member Function Documentation

◆ AddChallengeResponses() [1/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 412 of file AdminRespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [2/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 362 of file AdminRespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [3/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 462 of file AdminRespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [4/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 387 of file AdminRespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [5/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 337 of file AdminRespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [6/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 437 of file AdminRespondToAuthChallengeRequest.h.

◆ AddChallengeResponses() [7/7]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 487 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [1/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 931 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [2/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 873 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [3/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 989 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [4/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 902 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [5/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 844 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [6/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 960 of file AdminRespondToAuthChallengeRequest.h.

◆ AddClientMetadata() [7/7]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 1018 of file AdminRespondToAuthChallengeRequest.h.

◆ AnalyticsMetadataHasBeenSet()

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

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

Definition at line 573 of file AdminRespondToAuthChallengeRequest.h.

◆ ChallengeNameHasBeenSet()

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

The challenge name. For more information, see AdminInitiateAuth.

Definition at line 137 of file AdminRespondToAuthChallengeRequest.h.

◆ ChallengeResponsesHasBeenSet()

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 212 of file AdminRespondToAuthChallengeRequest.h.

◆ ClientIdHasBeenSet()

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

The app client ID.

Definition at line 94 of file AdminRespondToAuthChallengeRequest.h.

◆ ClientMetadataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 699 of file AdminRespondToAuthChallengeRequest.h.

◆ ContextDataHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::ContextDataHasBeenSet ( ) 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 612 of file AdminRespondToAuthChallengeRequest.h.

◆ GetAnalyticsMetadata()

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

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

Definition at line 567 of file AdminRespondToAuthChallengeRequest.h.

◆ GetChallengeName()

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

The challenge name. For more information, see AdminInitiateAuth.

Definition at line 131 of file AdminRespondToAuthChallengeRequest.h.

◆ GetChallengeResponses()

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 187 of file AdminRespondToAuthChallengeRequest.h.

◆ GetClientId()

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

The app client ID.

Definition at line 89 of file AdminRespondToAuthChallengeRequest.h.

◆ GetClientMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 670 of file AdminRespondToAuthChallengeRequest.h.

◆ GetContextData()

const ContextDataType& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::GetContextData ( ) 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 605 of file AdminRespondToAuthChallengeRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file AdminRespondToAuthChallengeRequest.h.

◆ GetSession()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 497 of file AdminRespondToAuthChallengeRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::GetUserPoolId ( ) const
inline

The ID of the Amazon Cognito user pool.

Definition at line 48 of file AdminRespondToAuthChallengeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SessionHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 506 of file AdminRespondToAuthChallengeRequest.h.

◆ SetAnalyticsMetadata() [1/2]

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

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

Definition at line 585 of file AdminRespondToAuthChallengeRequest.h.

◆ SetAnalyticsMetadata() [2/2]

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

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

Definition at line 579 of file AdminRespondToAuthChallengeRequest.h.

◆ SetChallengeName() [1/2]

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

The challenge name. For more information, see AdminInitiateAuth.

Definition at line 149 of file AdminRespondToAuthChallengeRequest.h.

◆ SetChallengeName() [2/2]

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

The challenge name. For more information, see AdminInitiateAuth.

Definition at line 143 of file AdminRespondToAuthChallengeRequest.h.

◆ SetChallengeResponses() [1/2]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 262 of file AdminRespondToAuthChallengeRequest.h.

◆ SetChallengeResponses() [2/2]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 237 of file AdminRespondToAuthChallengeRequest.h.

◆ SetClientId() [1/3]

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

The app client ID.

Definition at line 104 of file AdminRespondToAuthChallengeRequest.h.

◆ SetClientId() [2/3]

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

The app client ID.

Definition at line 99 of file AdminRespondToAuthChallengeRequest.h.

◆ SetClientId() [3/3]

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

The app client ID.

Definition at line 109 of file AdminRespondToAuthChallengeRequest.h.

◆ SetClientMetadata() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 757 of file AdminRespondToAuthChallengeRequest.h.

◆ SetClientMetadata() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 728 of file AdminRespondToAuthChallengeRequest.h.

◆ SetContextData() [1/2]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::SetContextData ( const ContextDataType 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 619 of file AdminRespondToAuthChallengeRequest.h.

◆ SetContextData() [2/2]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::SetContextData ( ContextDataType &&  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 626 of file AdminRespondToAuthChallengeRequest.h.

◆ SetSession() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 524 of file AdminRespondToAuthChallengeRequest.h.

◆ SetSession() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 515 of file AdminRespondToAuthChallengeRequest.h.

◆ SetSession() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 533 of file AdminRespondToAuthChallengeRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::SetUserPoolId ( Aws::String &&  value)
inline

The ID of the Amazon Cognito user pool.

Definition at line 63 of file AdminRespondToAuthChallengeRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::SetUserPoolId ( const Aws::String value)
inline

The ID of the Amazon Cognito user pool.

Definition at line 58 of file AdminRespondToAuthChallengeRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::SetUserPoolId ( const char *  value)
inline

The ID of the Amazon Cognito user pool.

Definition at line 68 of file AdminRespondToAuthChallengeRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::UserPoolIdHasBeenSet ( ) const
inline

The ID of the Amazon Cognito user pool.

Definition at line 53 of file AdminRespondToAuthChallengeRequest.h.

◆ WithAnalyticsMetadata() [1/2]

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

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

Definition at line 597 of file AdminRespondToAuthChallengeRequest.h.

◆ WithAnalyticsMetadata() [2/2]

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

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

Definition at line 591 of file AdminRespondToAuthChallengeRequest.h.

◆ WithChallengeName() [1/2]

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

The challenge name. For more information, see AdminInitiateAuth.

Definition at line 161 of file AdminRespondToAuthChallengeRequest.h.

◆ WithChallengeName() [2/2]

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

The challenge name. For more information, see AdminInitiateAuth.

Definition at line 155 of file AdminRespondToAuthChallengeRequest.h.

◆ WithChallengeResponses() [1/2]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 312 of file AdminRespondToAuthChallengeRequest.h.

◆ WithChallengeResponses() [2/2]

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

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).

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

The value of the USERNAME attribute must be the user's actual username, not an alias (such as 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.

Definition at line 287 of file AdminRespondToAuthChallengeRequest.h.

◆ WithClientId() [1/3]

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

The app client ID.

Definition at line 119 of file AdminRespondToAuthChallengeRequest.h.

◆ WithClientId() [2/3]

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

The app client ID.

Definition at line 114 of file AdminRespondToAuthChallengeRequest.h.

◆ WithClientId() [3/3]

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

The app client ID.

Definition at line 124 of file AdminRespondToAuthChallengeRequest.h.

◆ WithClientMetadata() [1/2]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 815 of file AdminRespondToAuthChallengeRequest.h.

◆ WithClientMetadata() [2/2]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 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.

Definition at line 786 of file AdminRespondToAuthChallengeRequest.h.

◆ WithContextData() [1/2]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::WithContextData ( const ContextDataType 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 633 of file AdminRespondToAuthChallengeRequest.h.

◆ WithContextData() [2/2]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::WithContextData ( ContextDataType &&  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 640 of file AdminRespondToAuthChallengeRequest.h.

◆ WithSession() [1/3]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 551 of file AdminRespondToAuthChallengeRequest.h.

◆ WithSession() [2/3]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 542 of file AdminRespondToAuthChallengeRequest.h.

◆ WithSession() [3/3]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::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 560 of file AdminRespondToAuthChallengeRequest.h.

◆ WithUserPoolId() [1/3]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::WithUserPoolId ( Aws::String &&  value)
inline

The ID of the Amazon Cognito user pool.

Definition at line 78 of file AdminRespondToAuthChallengeRequest.h.

◆ WithUserPoolId() [2/3]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::WithUserPoolId ( const Aws::String value)
inline

The ID of the Amazon Cognito user pool.

Definition at line 73 of file AdminRespondToAuthChallengeRequest.h.

◆ WithUserPoolId() [3/3]

AdminRespondToAuthChallengeRequest& Aws::CognitoIdentityProvider::Model::AdminRespondToAuthChallengeRequest::WithUserPoolId ( const char *  value)
inline

The ID of the Amazon Cognito user pool.

Definition at line 83 of file AdminRespondToAuthChallengeRequest.h.


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