Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

MFAOptionType

This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.

To set either type of MFA configuration, use the AdminSetUserMFAPreference or SetUserMFAPreference actions.

To look up information about either type of MFA configuration, use the AdminGetUser:UserMFASettingList or GetUser:UserMFASettingList responses.

Contents

AttributeName

The attribute name of the MFA option type. The only valid value is phone_number.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: No

DeliveryMedium

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Type: String

Valid Values: SMS | EMAIL

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: