paws.security.identity (version 0.1.12)

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

Description

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

Usage

cognitoidentityprovider_get_user_pool_mfa_config(UserPoolId)

Value

A list with the following syntax:

list(
  SmsMfaConfiguration = list(
    SmsAuthenticationMessage = "string",
    SmsConfiguration = list(
      SnsCallerArn = "string",
      ExternalId = "string"
    )
  ),
  SoftwareTokenMfaConfiguration = list(
    Enabled = TRUE|FALSE
  ),
  MfaConfiguration = "OFF"|"ON"|"OPTIONAL"
)

Arguments

UserPoolId

[required] The user pool ID.

Request syntax

svc$get_user_pool_mfa_config(
  UserPoolId = "string"
)