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


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

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


    my $cognito-idp = Paws->service('CognitoIdp');
    my $ConfirmForgotPasswordResponse = $cognito -idp->ConfirmForgotPassword(
      ClientId          => 'MyClientIdType',
      ConfirmationCode  => 'MyConfirmationCodeType',
      Password          => 'MyPasswordType',
      Username          => 'MyUsernameType',
      AnalyticsMetadata => {
        AnalyticsEndpointId => 'MyStringType',    # OPTIONAL
      },    # OPTIONAL
      SecretHash      => 'MySecretHashType',    # OPTIONAL
      UserContextData => {
        EncodedData => 'MyStringType',          # OPTIONAL
      },    # OPTIONAL

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


AnalyticsMetadata => Paws::CognitoIdp::AnalyticsMetadataType

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

REQUIRED ClientId => Str

The app client ID of the app associated with the user pool.

REQUIRED ConfirmationCode => Str

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

REQUIRED Password => Str

The password sent by a user's request to retrieve a forgotten password.

SecretHash => Str

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

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.

REQUIRED Username => Str

The user name of the user for whom you want to enter a code to retrieve a forgotten password.


This class forms part of Paws, documenting arguments for method ConfirmForgotPassword in Paws::CognitoIdp


The source code is located here:

Please report bugs to: