NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $cognito-idp = Paws->service('CognitoIdp');
    my $AdminRespondToAuthChallengeResponse =
      $cognito -idp->AdminRespondToAuthChallenge(
      ChallengeName     => 'SMS_MFA',
      ClientId          => 'MyClientIdType',
      UserPoolId        => 'MyUserPoolIdType',
      AnalyticsMetadata => {
        AnalyticsEndpointId => 'MyStringType',    # OPTIONAL
      },    # OPTIONAL
      ChallengeResponses => {
        'MyStringType' => 'MyStringType',    # key: OPTIONAL, value: OPTIONAL
      },    # OPTIONAL
      ClientMetadata => {
        'MyStringType' => 'MyStringType',    # key: OPTIONAL, value: OPTIONAL
      },    # OPTIONAL
      ContextData => {
        HttpHeaders => [
          {
            HeaderName  => 'MyStringType',    # OPTIONAL
            HeaderValue => 'MyStringType',    # OPTIONAL
          },
          ...
        ],
        IpAddress   => 'MyStringType',    # OPTIONAL
        ServerName  => 'MyStringType',    # OPTIONAL
        ServerPath  => 'MyStringType',    # OPTIONAL
        EncodedData => 'MyStringType',    # OPTIONAL
      },    # OPTIONAL
      Session => 'MySessionType',    # OPTIONAL
      );
    # Results:
    my $AuthenticationResult =
      $AdminRespondToAuthChallengeResponse->AuthenticationResult;
    my $ChallengeName = $AdminRespondToAuthChallengeResponse->ChallengeName;
    my $ChallengeParameters =
      $AdminRespondToAuthChallengeResponse->ChallengeParameters;
    my $Session = $AdminRespondToAuthChallengeResponse->Session;
    # Returns a L<Paws::CognitoIdp::AdminRespondToAuthChallengeResponse> 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/AdminRespondToAuthChallenge>

ATTRIBUTES

AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType

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

REQUIRED ChallengeName => Str

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

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:

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

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

ContextData => Paws::CognitoIdp::ContextDataType

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.

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.

REQUIRED UserPoolId => Str

The ID of the Amazon Cognito user pool.

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>