Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CognitoUserPoolTriggerEvent

Cognito User Pool event

deprecated

Please use specific event types instead http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Hierarchy

  • CognitoUserPoolTriggerEvent

Index

Properties

Properties

callerContext

callerContext: { awsSdkVersion: string; clientId: string }

Type declaration

  • awsSdkVersion: string
  • clientId: string

region

region: string

request

request: { challengeAnswer?: string; challengeName?: string; clientMetadata?: {}; codeParameter?: string; linkParameter?: string; newDeviceUsed?: boolean; password?: string; privateChallengeParameters?: {}; session?: { challengeMetadata?: string; challengeName: "CUSTOM_CHALLENGE" | "PASSWORD_VERIFIER" | "SMS_MFA" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "SRP_A"; challengeResult: boolean }[]; userAttributes: {}; userNotFound?: boolean; usernameParameter?: string; validationData?: {} }

Type declaration

  • Optional challengeAnswer?: string
  • Optional challengeName?: string
  • Optional clientMetadata?: {}
    • [key: string]: string
  • Optional codeParameter?: string
  • Optional linkParameter?: string
  • Optional newDeviceUsed?: boolean
  • Optional password?: string
  • Optional privateChallengeParameters?: {}
    • [key: string]: string
  • Optional session?: { challengeMetadata?: string; challengeName: "CUSTOM_CHALLENGE" | "PASSWORD_VERIFIER" | "SMS_MFA" | "DEVICE_SRP_AUTH" | "DEVICE_PASSWORD_VERIFIER" | "ADMIN_NO_SRP_AUTH" | "SRP_A"; challengeResult: boolean }[]
  • userAttributes: {}
    • [key: string]: string
  • Optional userNotFound?: boolean
  • Optional usernameParameter?: string
  • Optional validationData?: {}
    • [key: string]: string

response

response: { answerCorrect?: boolean; autoConfirmUser?: boolean; autoVerifyEmail?: boolean; autoVerifyPhone?: boolean; challengeMetadata?: string; challengeName?: string; claimsOverrideDetails?: { claimsToAddOrOverride?: {}; claimsToSuppress?: string[]; groupOverrideDetails?: { groupsToOverride?: string[]; iamRolesToOverride?: string[]; preferredRole?: string } }; desiredDeliveryMediums?: ("EMAIL" | "SMS")[]; emailMessage?: string; emailSubject?: string; failAuthentication?: boolean; finalUserStatus?: "CONFIRMED" | "RESET_REQUIRED"; forceAliasCreation?: boolean; issueTokens?: boolean; messageAction?: "SUPPRESS"; privateChallengeParameters?: {}; publicChallengeParameters?: {}; smsMessage?: string; userAttributes?: {} }

Type declaration

  • Optional answerCorrect?: boolean
  • Optional autoConfirmUser?: boolean
  • Optional autoVerifyEmail?: boolean
  • Optional autoVerifyPhone?: boolean
  • Optional challengeMetadata?: string
  • Optional challengeName?: string
  • Optional claimsOverrideDetails?: { claimsToAddOrOverride?: {}; claimsToSuppress?: string[]; groupOverrideDetails?: { groupsToOverride?: string[]; iamRolesToOverride?: string[]; preferredRole?: string } }
    • Optional claimsToAddOrOverride?: {}
      • [key: string]: string
    • Optional claimsToSuppress?: string[]
    • Optional groupOverrideDetails?: { groupsToOverride?: string[]; iamRolesToOverride?: string[]; preferredRole?: string }
      • Optional groupsToOverride?: string[]
      • Optional iamRolesToOverride?: string[]
      • Optional preferredRole?: string
  • Optional desiredDeliveryMediums?: ("EMAIL" | "SMS")[]
  • Optional emailMessage?: string
  • Optional emailSubject?: string
  • Optional failAuthentication?: boolean
  • Optional finalUserStatus?: "CONFIRMED" | "RESET_REQUIRED"
  • Optional forceAliasCreation?: boolean
  • Optional issueTokens?: boolean
  • Optional messageAction?: "SUPPRESS"
  • Optional privateChallengeParameters?: {}
    • [key: string]: string
  • Optional publicChallengeParameters?: {}
    • [key: string]: string
  • Optional smsMessage?: string
  • Optional userAttributes?: {}
    • [key: string]: string

triggerSource

triggerSource: "PreSignUp_SignUp" | "PreSignUp_ExternalProvider" | "PostConfirmation_ConfirmSignUp" | "PreAuthentication_Authentication" | "PostAuthentication_Authentication" | "CustomMessage_SignUp" | "CustomMessage_AdminCreateUser" | "CustomMessage_ResendCode" | "CustomMessage_ForgotPassword" | "CustomMessage_UpdateUserAttribute" | "CustomMessage_VerifyUserAttribute" | "CustomMessage_Authentication" | "DefineAuthChallenge_Authentication" | "CreateAuthChallenge_Authentication" | "VerifyAuthChallengeResponse_Authentication" | "PreSignUp_AdminCreateUser" | "PostConfirmation_ConfirmForgotPassword" | "TokenGeneration_HostedAuth" | "TokenGeneration_Authentication" | "TokenGeneration_NewPasswordChallenge" | "TokenGeneration_AuthenticateDevice" | "TokenGeneration_RefreshTokens" | "UserMigration_Authentication" | "UserMigration_ForgotPassword"

Optional userName

userName: string

userPoolId

userPoolId: string

version

version: number

Generated using TypeDoc