Options
All
  • Public
  • Public/Protected
  • All
Menu

Setup Phone Number for SMS MFA

Index

Interfaces

Type aliases

Variables

Functions

Interfaces

Args

Args:

phoneNumber

phoneNumber: string

Phone numbers must follow these formatting rules: A phone number must start with a plus (+) sign, followed immediately by the country code. A phone number can only contain the + sign and digits. You must remove any other characters from a phone number, such as parentheses, spaces, or dashes (-) before submitting the value to the service. For example, a United States-based phone number must follow this format: +14325551212. (Sourced from: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html)

Type aliases

Response

Response: MessageResponse

Result

When successful, the message ought to say something like, "Your phone number has been registered for SMS MFA."

Variables

Const HTTP

HTTP: POST = "POST"

Const Path

Path: string = `${authBasePath}/${ResourcePaths.configureMfa}`

Functions

isArgs

  • isArgs(val: any): boolean

newArgs

Generated using TypeDoc