This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool via the sign_up API operation. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_confirm_sign_up/ for full documentation.
cognitoidentityprovider_confirm_sign_up(
ClientId,
SecretHash = NULL,
Username,
ConfirmationCode,
ForceAliasCreation = NULL,
AnalyticsMetadata = NULL,
UserContextData = NULL,
ClientMetadata = NULL,
Session = NULL
)[required] The ID of the app client associated with the user pool.
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. For more information about SecretHash, see Computing secret hash values.
[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.
[required] The confirmation code that your user pool sent in response to the
sign_up request.
When true, forces user confirmation despite any existing aliases.
Defaults to false. A value of true migrates the alias from an
existing user to the new user if an existing user already has the phone
number or email address as an alias.
Say, for example, that an existing user has an email attribute of
bob@example.com and email is an alias in your user pool. If the new
user also has an email of bob@example.com and your
confirm_sign_up response
sets ForceAliasCreation to true, the new user can sign in with a
username of bob@example.com and the existing user can no longer do so.
If false and an attribute belongs to an existing alias, this request
returns an AliasExistsException error.
For more information about sign-in aliases, see Customizing sign-in attributes.
The Amazon Pinpoint analytics metadata for collecting metrics for
confirm_sign_up calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
For more information, see Collecting data for threat protection in applications.
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 Lambda functions to user pool
triggers. When you use the ConfirmSignUp API action, Amazon Cognito
invokes the function that is assigned to the post confirmation
trigger. When Amazon Cognito invokes this function, 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 ConfirmSignUp 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, note 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 send sensitive information
in this parameter.
The optional session ID from a
sign_up API request. You can sign
in a user directly from the sign-up process with the USER_AUTH
authentication flow.