NAME

Paws::CognitoIdp::RespondToAuthChallenge - Arguments for method RespondToAuthChallenge on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method RespondToAuthChallenge on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method RespondToAuthChallenge.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RespondToAuthChallenge.

SYNOPSIS

    my $cognito-idp = Paws->service('CognitoIdp');
    my $RespondToAuthChallengeResponse = $cognito -idp->RespondToAuthChallenge(
      ChallengeName     => 'SMS_MFA',
      ClientId          => 'MyClientIdType',
      AnalyticsMetadata => {
        AnalyticsEndpointId => 'MyStringType',    # OPTIONAL
      },    # OPTIONAL
      ChallengeResponses => {
        'MyStringType' => 'MyStringType',    # key: OPTIONAL, value: OPTIONAL
      },    # OPTIONAL
      ClientMetadata => {
        'MyStringType' => 'MyStringType',    # key: OPTIONAL, value: OPTIONAL
      },    # OPTIONAL
      Session         => 'MySessionType',    # OPTIONAL
      UserContextData => {
        EncodedData => 'MyStringType',       # OPTIONAL
      },    # OPTIONAL
    );
    # Results:
    my $AuthenticationResult =
      $RespondToAuthChallengeResponse->AuthenticationResult;
    my $ChallengeName = $RespondToAuthChallengeResponse->ChallengeName;
    my $ChallengeParameters =
      $RespondToAuthChallengeResponse->ChallengeParameters;
    my $Session = $RespondToAuthChallengeResponse->Session;
    # Returns a L<Paws::CognitoIdp::RespondToAuthChallengeResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/RespondToAuthChallenge>

ATTRIBUTES

AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType

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

REQUIRED ChallengeName => Str

The challenge name. For more information, see InitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html).

"ADMIN_NO_SRP_AUTH" is not a valid value.

Valid values are: "SMS_MFA", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED"

ChallengeResponses => Paws::CognitoIdp::ChallengeResponsesType

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.

REQUIRED ClientId => Str

The app client ID.

ClientMetadata => Paws::CognitoIdp::ClientMetadataType

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 (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) 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.

Session => Str

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.

UserContextData => Paws::CognitoIdp::UserContextDataType

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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>