This IAM-authenticated API operation confirms user sign-up as an administrator. Unlike confirm_sign_up, your IAM credentials authorize user account confirmation. No confirmation code is required.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_confirm_sign_up/ for full documentation.
cognitoidentityprovider_admin_confirm_sign_up(
UserPoolId,
Username,
ClientMetadata = NULL
)[required] The user pool ID for which you want to confirm user registration.
[required] The username of the user that you want to query or modify. The value of
this parameter is typically your user's username, but it can be any of
their alias attributes. If username isn't an alias attribute in your
user pool, this value must be the sub of a local user or the username
of a user from a third-party IdP.
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 in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
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 doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.