cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/AdminRespondToAuthChallengeRequest/Builder

Builder

class Builder

Properties

Link copied to clipboard
var analyticsMetadata: AnalyticsMetadataType?

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

Link copied to clipboard
var challengeName: ChallengeNameType?

The challenge name. For more information, see AdminInitiateAuth.

Link copied to clipboard
var challengeResponses: Map<String, String>?

The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

Link copied to clipboard
var clientId: String?

The app client ID.

Link copied to clipboard
var clientMetadata: Map<String, String>?

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
var contextData: ContextDataType?

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
var session: String?

The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Link copied to clipboard
var userPoolId: String?

The ID of the Amazon Cognito user pool.