class Aws::CognitoIdentityProvider::Types::AdminConfirmSignUpRequest

Represents the request to confirm user registration.

@note When making an API call, you may pass AdminConfirmSignUpRequest

data as a hash:

    {
      user_pool_id: "UserPoolIdType", # required
      username: "UsernameType", # required
      client_metadata: {
        "StringType" => "StringType",
      },
    }

@!attribute [rw] user_pool_id

The user pool ID for which you want to confirm user registration.
@return [String]

@!attribute [rw] username

The user name for which you want to confirm user registration.
@return [String]

@!attribute [rw] client_metadata

A map of custom key-value pairs that you can provide as input for
any custom workflows that this action triggers.

If your user pool configuration includes triggers, the
AdminConfirmSignUp API action invokes the Lambda function that is
specified for the *post confirmation* trigger. When Amazon Cognito
invokes this function, it passes a JSON payload, which the function
receives as input. In this payload, the `clientMetadata` attribute
provides the data that you assigned to the ClientMetadata parameter
in your AdminConfirmSignUp request. In your function code in 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][1] in the *Amazon Cognito Developer Guide*.

<note markdown="1"> 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 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.

 </note>

[1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
@return [Hash<String,String>]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUpRequest AWS API Documentation

Constants

SENSITIVE