List of Cognito authentication error codes and messages

Is this related to a new or existing framework?

No response

Is this related to a new or existing API?

Authentication

Is this related to another service?

Cognito

Describe the feature you’d like to request

I would like to be able to find a list of common Cognito authentication error codes and messages so that I could provide a mapping for translation purposes.

Describe the solution you’d like

Either one of the following would be ideal:

• Typescript type for each method’s error codes/messages
  • Added to https://github.com/DefinitelyTyped/DefinitelyTyped or this package

OR/AND

• Documentation article which provides this list of error codes/messages

---

So that I could do something like this:

try {
  await Auth.signIn(email, password);
} catch(error) {
  const { code, message }: { code: AuthSignInErrorCode | undefined, message: AuthSignInErrorMessage | undefined } = error;
  switch(code) {
    case AuthSignInErrorCode.USER_NOT_CONFIRMED: {
      // do something if user is not confirmed
    }
  }
}

Describe alternatives you’ve considered

I have considered encountering the errors myself manually and creating my own types, however I’m not aware of each of the errors

Additional context

No response

Is this something that you’d be interested in working on?

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

[mkbctrl]

I ended up with a hook returning keyed object like that, here’s an example:

export const useAuthErrors = () => {
  const { t } = useTranslation('auth')

  const errorMap: Record<
    string,
    {
      message: string
      action: null | ((email?: string) => void)
    }
  > = {
    /** Thrown by amplify when email or password doesn't match */
    /** FIXME: The same exception is returned when you try to confirm already confirmed account */
    NotAuthorizedException: {
      message: t('validator.accountCredentialsInvalid'),
      action:() => {
        ...perform an action (optional) like a redirect or displaying toast
      },
    },
  }

  return {
    errorMap,
  }
}

This way I am able to translate the errors easily and control what will be displayed to the user + side effects

[wmoa]

@joelzwarrington woops, I skimmed this thread in a rush (it’s been a long day), apologies.

That did the trick for now, thank you very much. 😄