NAME

Paws::CognitoIdp::SMSMfaSettingsType

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CognitoIdp::SMSMfaSettingsType object:

$service_obj->Method(Att1 => { Enabled => $value, ..., PreferredMfa => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::SMSMfaSettingsType object:

$result = $service_obj->Method(...);
$result->Att1->Enabled

DESCRIPTION

The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.

ATTRIBUTES

Enabled => Bool

Specifies whether SMS text message MFA is enabled. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted.

PreferredMfa => Bool

Specifies whether SMS is the preferred MFA method.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CognitoIdp

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues