CognitoIdentityProvider / Client / get_user_pool_mfa_config

get_user_pool_mfa_config#

CognitoIdentityProvider.Client.get_user_pool_mfa_config(**kwargs)#

Gets the user pool multi-factor authentication (MFA) configuration.

Request Syntax

response = client.get_user_pool_mfa_config(
    UserPoolId='string'
)

Parameters:

UserPoolId (string) –

[REQUIRED]

The user pool ID.

Return type:

dict

Returns:

Response Syntax

{
    'SmsMfaConfiguration': {
        'SmsAuthenticationMessage': 'string',
        'SmsConfiguration': {
            'SnsCallerArn': 'string',
            'ExternalId': 'string',
            'SnsRegion': 'string'
        }
    },
    'SoftwareTokenMfaConfiguration': {
        'Enabled': True|False
    },
    'MfaConfiguration': 'OFF'|'ON'|'OPTIONAL'
}

Response Structure

(dict) –
- SmsMfaConfiguration (dict) –
  
  The SMS text message multi-factor authentication (MFA) configuration.
  - SmsAuthenticationMessage (string) –
    
    The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn’t included, and default message will be used.
  - SmsConfiguration (dict) –
    
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.
    - SnsCallerArn (string) –
      
      The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
    - ExternalId (string) –
      
      The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
      
      For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
    - SnsRegion (string) –
      
      The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
      
      Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
- SoftwareTokenMfaConfiguration (dict) –
  
  The software token multi-factor authentication (MFA) configuration.
  - Enabled (boolean) –
    
    Specifies whether software token MFA is activated.
- MfaConfiguration (string) –
  
  The multi-factor authentication (MFA) configuration. Valid values include:
  - OFF MFA won’t be used for any users.
  - ON MFA is required for all users to sign in.
  - OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Exceptions

CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.InternalErrorException