This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.
MFAOptionType is a JSON Structure definition published by Amazon Cognito, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-mfa-option-type-structure.json",
"name": "MFAOptionType",
"description": " <i>This data type is no longer supported.</i> Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.",
"type": "object",
"properties": {
"DeliveryMedium": {
"allOf": [
{
"$ref": "#/components/schemas/DeliveryMediumType"
},
{
"description": "The delivery medium to send the MFA code. You can use this parameter to set only the <code>SMS</code> delivery medium value."
}
]
},
"AttributeName": {
"allOf": [
{
"$ref": "#/components/schemas/AttributeNameType"
},
{
"description": "The attribute name of the MFA option type. The only valid value is <code>phone_number</code>."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.