Builder

class Builder

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The confirmation code sent by a user's request to confirm registration.

Link copied to clipboard

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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, you can also use their sub in this request.