Builder

class Builder

Properties

Link copied to clipboard

Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

Link copied to clipboard

The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows.

Link copied to clipboard

The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow for example:

Link copied to clipboard

The ID of the app client where the user wants to sign in.

Link copied to clipboard

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

Link copied to clipboard

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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 optional session ID from a ConfirmSignUp API request. You can sign in a user directly from the sign-up process with an AuthFlow of USER_AUTH and AuthParameters of EMAIL_OTP or SMS_OTP, depending on how your user pool sent the confirmation-code message.

Link copied to clipboard

The ID of the user pool where the user wants to sign in.