cognitoidentityprovider_resend_confirmation_code: Resends the confirmation (for confirmation of registration)...

View source: R/cognitoidentityprovider_operations.R

cognitoidentityprovider_resend_confirmation_codeR Documentation

Resends the confirmation (for confirmation of registration) to a specific user in the user pool

Description

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_resend_confirmation_code/ for full documentation.

Usage

cognitoidentityprovider_resend_confirmation_code(
  ClientId,
  SecretHash = NULL,
  UserContextData = NULL,
  Username,
  AnalyticsMetadata = NULL,
  ClientMetadata = NULL
)

Arguments

ClientId

[required] The ID of the client associated with the user pool.

SecretHash

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

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.

Username

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

AnalyticsMetadata

The Amazon Pinpoint analytics metadata that contributes to your metrics for resend_confirmation_code calls.

ClientMetadata

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 ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message 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 ResendConfirmationCode 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.


paws.security.identity documentation built on May 29, 2024, 10:51 a.m.