aws-sdk-cognitoidentityprovider 1.47.0 → 1.52.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/CHANGELOG.md +343 -0
 - data/LICENSE.txt +202 -0
 - data/VERSION +1 -0
 - data/lib/aws-sdk-cognitoidentityprovider.rb +2 -2
 - data/lib/aws-sdk-cognitoidentityprovider/client.rb +467 -9
 - data/lib/aws-sdk-cognitoidentityprovider/client_api.rb +16 -1
 - data/lib/aws-sdk-cognitoidentityprovider/customizations.rb +1 -1
 - data/lib/aws-sdk-cognitoidentityprovider/errors.rb +1 -1
 - data/lib/aws-sdk-cognitoidentityprovider/resource.rb +1 -1
 - data/lib/aws-sdk-cognitoidentityprovider/types.rb +289 -20
 - metadata +11 -9
 
    
        data/VERSION
    ADDED
    
    | 
         @@ -0,0 +1 @@ 
     | 
|
| 
      
 1 
     | 
    
         
            +
            1.52.0
         
     | 
| 
         @@ -3,7 +3,7 @@ 
     | 
|
| 
       3 
3 
     | 
    
         
             
            # WARNING ABOUT GENERATED CODE
         
     | 
| 
       4 
4 
     | 
    
         
             
            #
         
     | 
| 
       5 
5 
     | 
    
         
             
            # This file is generated. See the contributing guide for more information:
         
     | 
| 
       6 
     | 
    
         
            -
            # https://github.com/aws/aws-sdk-ruby/blob/ 
     | 
| 
      
 6 
     | 
    
         
            +
            # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
         
     | 
| 
       7 
7 
     | 
    
         
             
            #
         
     | 
| 
       8 
8 
     | 
    
         
             
            # WARNING ABOUT GENERATED CODE
         
     | 
| 
       9 
9 
     | 
    
         | 
| 
         @@ -48,6 +48,6 @@ require_relative 'aws-sdk-cognitoidentityprovider/customizations' 
     | 
|
| 
       48 
48 
     | 
    
         
             
            # @!group service
         
     | 
| 
       49 
49 
     | 
    
         
             
            module Aws::CognitoIdentityProvider
         
     | 
| 
       50 
50 
     | 
    
         | 
| 
       51 
     | 
    
         
            -
              GEM_VERSION = '1. 
     | 
| 
      
 51 
     | 
    
         
            +
              GEM_VERSION = '1.52.0'
         
     | 
| 
       52 
52 
     | 
    
         | 
| 
       53 
53 
     | 
    
         
             
            end
         
     | 
| 
         @@ -3,7 +3,7 @@ 
     | 
|
| 
       3 
3 
     | 
    
         
             
            # WARNING ABOUT GENERATED CODE
         
     | 
| 
       4 
4 
     | 
    
         
             
            #
         
     | 
| 
       5 
5 
     | 
    
         
             
            # This file is generated. See the contributing guide for more information:
         
     | 
| 
       6 
     | 
    
         
            -
            # https://github.com/aws/aws-sdk-ruby/blob/ 
     | 
| 
      
 6 
     | 
    
         
            +
            # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
         
     | 
| 
       7 
7 
     | 
    
         
             
            #
         
     | 
| 
       8 
8 
     | 
    
         
             
            # WARNING ABOUT GENERATED CODE
         
     | 
| 
       9 
9 
     | 
    
         | 
| 
         @@ -486,6 +486,27 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       486 
486 
     | 
    
         
             
                # If `MessageAction` is not set, the default is to send a welcome
         
     | 
| 
       487 
487 
     | 
    
         
             
                # message via email or phone (SMS).
         
     | 
| 
       488 
488 
     | 
    
         
             
                #
         
     | 
| 
      
 489 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 490 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 491 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 492 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 493 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 494 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 495 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 496 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 497 
     | 
    
         
            +
                #
         
     | 
| 
      
 498 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 499 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 500 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 501 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 502 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 503 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 504 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 505 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 506 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 507 
     | 
    
         
            +
                #
         
     | 
| 
      
 508 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 509 
     | 
    
         
            +
                #
         
     | 
| 
       489 
510 
     | 
    
         
             
                # This message is based on a template that you configured in your call
         
     | 
| 
       490 
511 
     | 
    
         
             
                # to create or update a user pool. This template includes your custom
         
     | 
| 
       491 
512 
     | 
    
         
             
                # sign-up instructions and placeholders for user name and temporary
         
     | 
| 
         @@ -499,6 +520,11 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       499 
520 
     | 
    
         
             
                #
         
     | 
| 
       500 
521 
     | 
    
         
             
                # `AdminCreateUser` requires developer credentials.
         
     | 
| 
       501 
522 
     | 
    
         
             
                #
         
     | 
| 
      
 523 
     | 
    
         
            +
                #
         
     | 
| 
      
 524 
     | 
    
         
            +
                #
         
     | 
| 
      
 525 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 526 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 527 
     | 
    
         
            +
                #
         
     | 
| 
       502 
528 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       503 
529 
     | 
    
         
             
                #   The user pool ID for the user pool where the user will be created.
         
     | 
| 
       504 
530 
     | 
    
         
             
                #
         
     | 
| 
         @@ -1015,8 +1041,34 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       1015 
1041 
     | 
    
         | 
| 
       1016 
1042 
     | 
    
         
             
                # Initiates the authentication flow, as an administrator.
         
     | 
| 
       1017 
1043 
     | 
    
         
             
                #
         
     | 
| 
      
 1044 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 1045 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 1046 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 1047 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 1048 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 1049 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 1050 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 1051 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 1052 
     | 
    
         
            +
                #
         
     | 
| 
      
 1053 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 1054 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 1055 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 1056 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 1057 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 1058 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 1059 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 1060 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 1061 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 1062 
     | 
    
         
            +
                #
         
     | 
| 
      
 1063 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 1064 
     | 
    
         
            +
                #
         
     | 
| 
       1018 
1065 
     | 
    
         
             
                # Calling this action requires developer credentials.
         
     | 
| 
       1019 
1066 
     | 
    
         
             
                #
         
     | 
| 
      
 1067 
     | 
    
         
            +
                #
         
     | 
| 
      
 1068 
     | 
    
         
            +
                #
         
     | 
| 
      
 1069 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 1070 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 1071 
     | 
    
         
            +
                #
         
     | 
| 
       1020 
1072 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       1021 
1073 
     | 
    
         
             
                #   The ID of the Amazon Cognito user pool.
         
     | 
| 
       1022 
1074 
     | 
    
         
             
                #
         
     | 
| 
         @@ -1526,8 +1578,34 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       1526 
1578 
     | 
    
         
             
                # in sending a message to the end user with the code to change their
         
     | 
| 
       1527 
1579 
     | 
    
         
             
                # password.
         
     | 
| 
       1528 
1580 
     | 
    
         
             
                #
         
     | 
| 
      
 1581 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 1582 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 1583 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 1584 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 1585 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 1586 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 1587 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 1588 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 1589 
     | 
    
         
            +
                #
         
     | 
| 
      
 1590 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 1591 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 1592 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 1593 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 1594 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 1595 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 1596 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 1597 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 1598 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 1599 
     | 
    
         
            +
                #
         
     | 
| 
      
 1600 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 1601 
     | 
    
         
            +
                #
         
     | 
| 
       1529 
1602 
     | 
    
         
             
                # Calling this action requires developer credentials.
         
     | 
| 
       1530 
1603 
     | 
    
         
             
                #
         
     | 
| 
      
 1604 
     | 
    
         
            +
                #
         
     | 
| 
      
 1605 
     | 
    
         
            +
                #
         
     | 
| 
      
 1606 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 1607 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 1608 
     | 
    
         
            +
                #
         
     | 
| 
       1531 
1609 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       1532 
1610 
     | 
    
         
             
                #   The user pool ID for the user pool where you want to reset the user's
         
     | 
| 
       1533 
1611 
     | 
    
         
             
                #   password.
         
     | 
| 
         @@ -1596,8 +1674,34 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       1596 
1674 
     | 
    
         | 
| 
       1597 
1675 
     | 
    
         
             
                # Responds to an authentication challenge, as an administrator.
         
     | 
| 
       1598 
1676 
     | 
    
         
             
                #
         
     | 
| 
      
 1677 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 1678 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 1679 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 1680 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 1681 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 1682 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 1683 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 1684 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 1685 
     | 
    
         
            +
                #
         
     | 
| 
      
 1686 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 1687 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 1688 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 1689 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 1690 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 1691 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 1692 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 1693 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 1694 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 1695 
     | 
    
         
            +
                #
         
     | 
| 
      
 1696 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 1697 
     | 
    
         
            +
                #
         
     | 
| 
       1599 
1698 
     | 
    
         
             
                # Calling this action requires developer credentials.
         
     | 
| 
       1600 
1699 
     | 
    
         
             
                #
         
     | 
| 
      
 1700 
     | 
    
         
            +
                #
         
     | 
| 
      
 1701 
     | 
    
         
            +
                #
         
     | 
| 
      
 1702 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 1703 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 1704 
     | 
    
         
            +
                #
         
     | 
| 
       1601 
1705 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       1602 
1706 
     | 
    
         
             
                #   The ID of the Amazon Cognito user pool.
         
     | 
| 
       1603 
1707 
     | 
    
         
             
                #
         
     | 
| 
         @@ -1629,6 +1733,9 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       1629 
1733 
     | 
    
         
             
                #     attributes, `USERNAME`, `SECRET_HASH` (if app client is configured
         
     | 
| 
       1630 
1734 
     | 
    
         
             
                #     with client secret).
         
     | 
| 
       1631 
1735 
     | 
    
         
             
                #
         
     | 
| 
      
 1736 
     | 
    
         
            +
                #   * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
         
     | 
| 
      
 1737 
     | 
    
         
            +
                #     value returned by `VerifySoftwareToken` in the `Session` parameter.
         
     | 
| 
      
 1738 
     | 
    
         
            +
                #
         
     | 
| 
       1632 
1739 
     | 
    
         
             
                #   The value of the `USERNAME` attribute must be the user's actual
         
     | 
| 
       1633 
1740 
     | 
    
         
             
                #   username, not an alias (such as email address or phone number). To
         
     | 
| 
       1634 
1741 
     | 
    
         
             
                #   make this easier, the `AdminInitiateAuth` response includes the actual
         
     | 
| 
         @@ -1971,8 +2078,34 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       1971 
2078 
     | 
    
         
             
                # In addition to updating user attributes, this API can also be used to
         
     | 
| 
       1972 
2079 
     | 
    
         
             
                # mark phone and email as verified.
         
     | 
| 
       1973 
2080 
     | 
    
         
             
                #
         
     | 
| 
      
 2081 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 2082 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 2083 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 2084 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 2085 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 2086 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 2087 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 2088 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 2089 
     | 
    
         
            +
                #
         
     | 
| 
      
 2090 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 2091 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 2092 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 2093 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 2094 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 2095 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 2096 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 2097 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 2098 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 2099 
     | 
    
         
            +
                #
         
     | 
| 
      
 2100 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 2101 
     | 
    
         
            +
                #
         
     | 
| 
       1974 
2102 
     | 
    
         
             
                # Calling this action requires developer credentials.
         
     | 
| 
       1975 
2103 
     | 
    
         
             
                #
         
     | 
| 
      
 2104 
     | 
    
         
            +
                #
         
     | 
| 
      
 2105 
     | 
    
         
            +
                #
         
     | 
| 
      
 2106 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 2107 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 2108 
     | 
    
         
            +
                #
         
     | 
| 
       1976 
2109 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       1977 
2110 
     | 
    
         
             
                #   The user pool ID for the user pool where you want to update user
         
     | 
| 
       1978 
2111 
     | 
    
         
             
                #   attributes.
         
     | 
| 
         @@ -2086,6 +2219,16 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       2086 
2219 
     | 
    
         
             
                # account. The request takes an access token or a session string, but
         
     | 
| 
       2087 
2220 
     | 
    
         
             
                # not both.
         
     | 
| 
       2088 
2221 
     | 
    
         
             
                #
         
     | 
| 
      
 2222 
     | 
    
         
            +
                # <note markdown="1"> Calling AssociateSoftwareToken immediately disassociates the existing
         
     | 
| 
      
 2223 
     | 
    
         
            +
                # software token from the user account. If the user doesn't
         
     | 
| 
      
 2224 
     | 
    
         
            +
                # subsequently verify the software token, their account is essentially
         
     | 
| 
      
 2225 
     | 
    
         
            +
                # set up to authenticate without MFA. If MFA config is set to Optional
         
     | 
| 
      
 2226 
     | 
    
         
            +
                # at the user pool level, the user can then login without MFA. However,
         
     | 
| 
      
 2227 
     | 
    
         
            +
                # if MFA is set to Required for the user pool, the user will be asked to
         
     | 
| 
      
 2228 
     | 
    
         
            +
                # setup a new software token MFA during sign in.
         
     | 
| 
      
 2229 
     | 
    
         
            +
                #
         
     | 
| 
      
 2230 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 2231 
     | 
    
         
            +
                #
         
     | 
| 
       2089 
2232 
     | 
    
         
             
                # @option params [String] :access_token
         
     | 
| 
       2090 
2233 
     | 
    
         
             
                #   The access token.
         
     | 
| 
       2091 
2234 
     | 
    
         
             
                #
         
     | 
| 
         @@ -2701,6 +2844,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       2701 
2844 
     | 
    
         
             
                # Creates a new Amazon Cognito user pool and sets the password policy
         
     | 
| 
       2702 
2845 
     | 
    
         
             
                # for the pool.
         
     | 
| 
       2703 
2846 
     | 
    
         
             
                #
         
     | 
| 
      
 2847 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 2848 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 2849 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 2850 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 2851 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 2852 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 2853 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 2854 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 2855 
     | 
    
         
            +
                #
         
     | 
| 
      
 2856 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 2857 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 2858 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 2859 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 2860 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 2861 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 2862 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 2863 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 2864 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 2865 
     | 
    
         
            +
                #
         
     | 
| 
      
 2866 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 2867 
     | 
    
         
            +
                #
         
     | 
| 
      
 2868 
     | 
    
         
            +
                #
         
     | 
| 
      
 2869 
     | 
    
         
            +
                #
         
     | 
| 
      
 2870 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 2871 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 2872 
     | 
    
         
            +
                #
         
     | 
| 
       2704 
2873 
     | 
    
         
             
                # @option params [required, String] :pool_name
         
     | 
| 
       2705 
2874 
     | 
    
         
             
                #   A string used to name the user pool.
         
     | 
| 
       2706 
2875 
     | 
    
         
             
                #
         
     | 
| 
         @@ -2746,9 +2915,21 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       2746 
2915 
     | 
    
         
             
                #
         
     | 
| 
       2747 
2916 
     | 
    
         
             
                # @option params [String] :email_verification_message
         
     | 
| 
       2748 
2917 
     | 
    
         
             
                #   A string representing the email verification message.
         
     | 
| 
      
 2918 
     | 
    
         
            +
                #   EmailVerificationMessage is allowed only if [EmailSendingAccount][1]
         
     | 
| 
      
 2919 
     | 
    
         
            +
                #   is DEVELOPER.
         
     | 
| 
      
 2920 
     | 
    
         
            +
                #
         
     | 
| 
      
 2921 
     | 
    
         
            +
                #
         
     | 
| 
      
 2922 
     | 
    
         
            +
                #
         
     | 
| 
      
 2923 
     | 
    
         
            +
                #   [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
         
     | 
| 
       2749 
2924 
     | 
    
         
             
                #
         
     | 
| 
       2750 
2925 
     | 
    
         
             
                # @option params [String] :email_verification_subject
         
     | 
| 
       2751 
2926 
     | 
    
         
             
                #   A string representing the email verification subject.
         
     | 
| 
      
 2927 
     | 
    
         
            +
                #   EmailVerificationSubject is allowed only if [EmailSendingAccount][1]
         
     | 
| 
      
 2928 
     | 
    
         
            +
                #   is DEVELOPER.
         
     | 
| 
      
 2929 
     | 
    
         
            +
                #
         
     | 
| 
      
 2930 
     | 
    
         
            +
                #
         
     | 
| 
      
 2931 
     | 
    
         
            +
                #
         
     | 
| 
      
 2932 
     | 
    
         
            +
                #   [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
         
     | 
| 
       2752 
2933 
     | 
    
         
             
                #
         
     | 
| 
       2753 
2934 
     | 
    
         
             
                # @option params [Types::VerificationMessageTemplateType] :verification_message_template
         
     | 
| 
       2754 
2935 
     | 
    
         
             
                #   The template for the verification message that the user sees when the
         
     | 
| 
         @@ -2834,6 +3015,15 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       2834 
3015 
     | 
    
         
             
                #       verify_auth_challenge_response: "ArnType",
         
     | 
| 
       2835 
3016 
     | 
    
         
             
                #       pre_token_generation: "ArnType",
         
     | 
| 
       2836 
3017 
     | 
    
         
             
                #       user_migration: "ArnType",
         
     | 
| 
      
 3018 
     | 
    
         
            +
                #       custom_sms_sender: {
         
     | 
| 
      
 3019 
     | 
    
         
            +
                #         lambda_version: "V1_0", # required, accepts V1_0
         
     | 
| 
      
 3020 
     | 
    
         
            +
                #         lambda_arn: "ArnType", # required
         
     | 
| 
      
 3021 
     | 
    
         
            +
                #       },
         
     | 
| 
      
 3022 
     | 
    
         
            +
                #       custom_email_sender: {
         
     | 
| 
      
 3023 
     | 
    
         
            +
                #         lambda_version: "V1_0", # required, accepts V1_0
         
     | 
| 
      
 3024 
     | 
    
         
            +
                #         lambda_arn: "ArnType", # required
         
     | 
| 
      
 3025 
     | 
    
         
            +
                #       },
         
     | 
| 
      
 3026 
     | 
    
         
            +
                #       kms_key_id: "ArnType",
         
     | 
| 
       2837 
3027 
     | 
    
         
             
                #     },
         
     | 
| 
       2838 
3028 
     | 
    
         
             
                #     auto_verified_attributes: ["phone_number"], # accepts phone_number, email
         
     | 
| 
       2839 
3029 
     | 
    
         
             
                #     alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
         
     | 
| 
         @@ -2931,6 +3121,11 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       2931 
3121 
     | 
    
         
             
                #   resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
         
     | 
| 
       2932 
3122 
     | 
    
         
             
                #   resp.user_pool.lambda_config.pre_token_generation #=> String
         
     | 
| 
       2933 
3123 
     | 
    
         
             
                #   resp.user_pool.lambda_config.user_migration #=> String
         
     | 
| 
      
 3124 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
         
     | 
| 
      
 3125 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
         
     | 
| 
      
 3126 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
         
     | 
| 
      
 3127 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
         
     | 
| 
      
 3128 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.kms_key_id #=> String
         
     | 
| 
       2934 
3129 
     | 
    
         
             
                #   resp.user_pool.status #=> String, one of "Enabled", "Disabled"
         
     | 
| 
       2935 
3130 
     | 
    
         
             
                #   resp.user_pool.last_modified_date #=> Time
         
     | 
| 
       2936 
3131 
     | 
    
         
             
                #   resp.user_pool.creation_date #=> Time
         
     | 
| 
         @@ -3320,7 +3515,7 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       3320 
3515 
     | 
    
         
             
                  req.send_request(options)
         
     | 
| 
       3321 
3516 
     | 
    
         
             
                end
         
     | 
| 
       3322 
3517 
     | 
    
         | 
| 
       3323 
     | 
    
         
            -
                # Deletes a group. 
     | 
| 
      
 3518 
     | 
    
         
            +
                # Deletes a group.
         
     | 
| 
       3324 
3519 
     | 
    
         
             
                #
         
     | 
| 
       3325 
3520 
     | 
    
         
             
                # Calling this action requires developer credentials.
         
     | 
| 
       3326 
3521 
     | 
    
         
             
                #
         
     | 
| 
         @@ -3746,6 +3941,11 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       3746 
3941 
     | 
    
         
             
                #   resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
         
     | 
| 
       3747 
3942 
     | 
    
         
             
                #   resp.user_pool.lambda_config.pre_token_generation #=> String
         
     | 
| 
       3748 
3943 
     | 
    
         
             
                #   resp.user_pool.lambda_config.user_migration #=> String
         
     | 
| 
      
 3944 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
         
     | 
| 
      
 3945 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
         
     | 
| 
      
 3946 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
         
     | 
| 
      
 3947 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
         
     | 
| 
      
 3948 
     | 
    
         
            +
                #   resp.user_pool.lambda_config.kms_key_id #=> String
         
     | 
| 
       3749 
3949 
     | 
    
         
             
                #   resp.user_pool.status #=> String, one of "Enabled", "Disabled"
         
     | 
| 
       3750 
3950 
     | 
    
         
             
                #   resp.user_pool.last_modified_date #=> Time
         
     | 
| 
       3751 
3951 
     | 
    
         
             
                #   resp.user_pool.creation_date #=> Time
         
     | 
| 
         @@ -3952,10 +4152,33 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       3952 
4152 
     | 
    
         
             
                # `InvalidParameterException` is thrown. To use the confirmation code
         
     | 
| 
       3953 
4153 
     | 
    
         
             
                # for resetting the password, call [ConfirmForgotPassword][2].
         
     | 
| 
       3954 
4154 
     | 
    
         
             
                #
         
     | 
| 
      
 4155 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 4156 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 4157 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 4158 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 4159 
     | 
    
         
            +
                # number with [Amazon Pinpoint][3]. Cognito will use the the registered
         
     | 
| 
      
 4160 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 4161 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 4162 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 4163 
     | 
    
         
            +
                #
         
     | 
| 
      
 4164 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 4165 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 4166 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 4167 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 4168 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 4169 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 4170 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 4171 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][4] in
         
     | 
| 
      
 4172 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 4173 
     | 
    
         
            +
                #
         
     | 
| 
      
 4174 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 4175 
     | 
    
         
            +
                #
         
     | 
| 
       3955 
4176 
     | 
    
         
             
                #
         
     | 
| 
       3956 
4177 
     | 
    
         
             
                #
         
     | 
| 
       3957 
4178 
     | 
    
         
             
                # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html
         
     | 
| 
       3958 
4179 
     | 
    
         
             
                # [2]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html
         
     | 
| 
      
 4180 
     | 
    
         
            +
                # [3]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 4181 
     | 
    
         
            +
                # [4]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
       3959 
4182 
     | 
    
         
             
                #
         
     | 
| 
       3960 
4183 
     | 
    
         
             
                # @option params [required, String] :client_id
         
     | 
| 
       3961 
4184 
     | 
    
         
             
                #   The ID of the client associated with the user pool.
         
     | 
| 
         @@ -4320,6 +4543,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       4320 
4543 
     | 
    
         
             
                # Gets the user attribute verification code for the specified attribute
         
     | 
| 
       4321 
4544 
     | 
    
         
             
                # name.
         
     | 
| 
       4322 
4545 
     | 
    
         
             
                #
         
     | 
| 
      
 4546 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 4547 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 4548 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 4549 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 4550 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 4551 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 4552 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 4553 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 4554 
     | 
    
         
            +
                #
         
     | 
| 
      
 4555 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 4556 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 4557 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 4558 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 4559 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 4560 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 4561 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 4562 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 4563 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 4564 
     | 
    
         
            +
                #
         
     | 
| 
      
 4565 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 4566 
     | 
    
         
            +
                #
         
     | 
| 
      
 4567 
     | 
    
         
            +
                #
         
     | 
| 
      
 4568 
     | 
    
         
            +
                #
         
     | 
| 
      
 4569 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 4570 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 4571 
     | 
    
         
            +
                #
         
     | 
| 
       4323 
4572 
     | 
    
         
             
                # @option params [required, String] :access_token
         
     | 
| 
       4324 
4573 
     | 
    
         
             
                #   The access token returned by the server response to get the user
         
     | 
| 
       4325 
4574 
     | 
    
         
             
                #   attribute verification code.
         
     | 
| 
         @@ -4456,6 +4705,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       4456 
4705 
     | 
    
         | 
| 
       4457 
4706 
     | 
    
         
             
                # Initiates the authentication flow.
         
     | 
| 
       4458 
4707 
     | 
    
         
             
                #
         
     | 
| 
      
 4708 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 4709 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 4710 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 4711 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 4712 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 4713 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 4714 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 4715 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 4716 
     | 
    
         
            +
                #
         
     | 
| 
      
 4717 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 4718 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 4719 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 4720 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 4721 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 4722 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 4723 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 4724 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 4725 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 4726 
     | 
    
         
            +
                #
         
     | 
| 
      
 4727 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 4728 
     | 
    
         
            +
                #
         
     | 
| 
      
 4729 
     | 
    
         
            +
                #
         
     | 
| 
      
 4730 
     | 
    
         
            +
                #
         
     | 
| 
      
 4731 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 4732 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 4733 
     | 
    
         
            +
                #
         
     | 
| 
       4459 
4734 
     | 
    
         
             
                # @option params [required, String] :auth_flow
         
     | 
| 
       4460 
4735 
     | 
    
         
             
                #   The authentication flow for this call to execute. The API action will
         
     | 
| 
       4461 
4736 
     | 
    
         
             
                #   depend on this value. For example:
         
     | 
| 
         @@ -4997,6 +5272,11 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       4997 
5272 
     | 
    
         
             
                #   resp.user_pools[0].lambda_config.verify_auth_challenge_response #=> String
         
     | 
| 
       4998 
5273 
     | 
    
         
             
                #   resp.user_pools[0].lambda_config.pre_token_generation #=> String
         
     | 
| 
       4999 
5274 
     | 
    
         
             
                #   resp.user_pools[0].lambda_config.user_migration #=> String
         
     | 
| 
      
 5275 
     | 
    
         
            +
                #   resp.user_pools[0].lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
         
     | 
| 
      
 5276 
     | 
    
         
            +
                #   resp.user_pools[0].lambda_config.custom_sms_sender.lambda_arn #=> String
         
     | 
| 
      
 5277 
     | 
    
         
            +
                #   resp.user_pools[0].lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
         
     | 
| 
      
 5278 
     | 
    
         
            +
                #   resp.user_pools[0].lambda_config.custom_email_sender.lambda_arn #=> String
         
     | 
| 
      
 5279 
     | 
    
         
            +
                #   resp.user_pools[0].lambda_config.kms_key_id #=> String
         
     | 
| 
       5000 
5280 
     | 
    
         
             
                #   resp.user_pools[0].status #=> String, one of "Enabled", "Disabled"
         
     | 
| 
       5001 
5281 
     | 
    
         
             
                #   resp.user_pools[0].last_modified_date #=> Time
         
     | 
| 
       5002 
5282 
     | 
    
         
             
                #   resp.user_pools[0].creation_date #=> Time
         
     | 
| 
         @@ -5187,6 +5467,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5187 
5467 
     | 
    
         
             
                # Resends the confirmation (for confirmation of registration) to a
         
     | 
| 
       5188 
5468 
     | 
    
         
             
                # specific user in the user pool.
         
     | 
| 
       5189 
5469 
     | 
    
         
             
                #
         
     | 
| 
      
 5470 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 5471 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 5472 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 5473 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 5474 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 5475 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 5476 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 5477 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 5478 
     | 
    
         
            +
                #
         
     | 
| 
      
 5479 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 5480 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 5481 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 5482 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 5483 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 5484 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 5485 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 5486 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 5487 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 5488 
     | 
    
         
            +
                #
         
     | 
| 
      
 5489 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 5490 
     | 
    
         
            +
                #
         
     | 
| 
      
 5491 
     | 
    
         
            +
                #
         
     | 
| 
      
 5492 
     | 
    
         
            +
                #
         
     | 
| 
      
 5493 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 5494 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 5495 
     | 
    
         
            +
                #
         
     | 
| 
       5190 
5496 
     | 
    
         
             
                # @option params [required, String] :client_id
         
     | 
| 
       5191 
5497 
     | 
    
         
             
                #   The ID of the client associated with the user pool.
         
     | 
| 
       5192 
5498 
     | 
    
         
             
                #
         
     | 
| 
         @@ -5284,6 +5590,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5284 
5590 
     | 
    
         | 
| 
       5285 
5591 
     | 
    
         
             
                # Responds to the authentication challenge.
         
     | 
| 
       5286 
5592 
     | 
    
         
             
                #
         
     | 
| 
      
 5593 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 5594 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 5595 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 5596 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 5597 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 5598 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 5599 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 5600 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 5601 
     | 
    
         
            +
                #
         
     | 
| 
      
 5602 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 5603 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 5604 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 5605 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 5606 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 5607 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 5608 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 5609 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 5610 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 5611 
     | 
    
         
            +
                #
         
     | 
| 
      
 5612 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 5613 
     | 
    
         
            +
                #
         
     | 
| 
      
 5614 
     | 
    
         
            +
                #
         
     | 
| 
      
 5615 
     | 
    
         
            +
                #
         
     | 
| 
      
 5616 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 5617 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 5618 
     | 
    
         
            +
                #
         
     | 
| 
       5287 
5619 
     | 
    
         
             
                # @option params [required, String] :client_id
         
     | 
| 
       5288 
5620 
     | 
    
         
             
                #   The app client ID.
         
     | 
| 
       5289 
5621 
     | 
    
         
             
                #
         
     | 
| 
         @@ -5330,6 +5662,9 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5330 
5662 
     | 
    
         
             
                #   * `DEVICE_PASSWORD_VERIFIER` requires everything that
         
     | 
| 
       5331 
5663 
     | 
    
         
             
                #     `PASSWORD_VERIFIER` requires plus `DEVICE_KEY`.
         
     | 
| 
       5332 
5664 
     | 
    
         
             
                #
         
     | 
| 
      
 5665 
     | 
    
         
            +
                #   * `MFA_SETUP` requires `USERNAME`, plus you need to use the session
         
     | 
| 
      
 5666 
     | 
    
         
            +
                #     value returned by `VerifySoftwareToken` in the `Session` parameter.
         
     | 
| 
      
 5667 
     | 
    
         
            +
                #
         
     | 
| 
       5333 
5668 
     | 
    
         
             
                # @option params [Types::AnalyticsMetadataType] :analytics_metadata
         
     | 
| 
       5334 
5669 
     | 
    
         
             
                #   The Amazon Pinpoint analytics metadata for collecting metrics for
         
     | 
| 
       5335 
5670 
     | 
    
         
             
                #   `RespondToAuthChallenge` calls.
         
     | 
| 
         @@ -5619,7 +5954,12 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5619 
5954 
     | 
    
         
             
                # one factor can be set as preferred. The preferred MFA factor will be
         
     | 
| 
       5620 
5955 
     | 
    
         
             
                # used to authenticate a user if multiple factors are enabled. If
         
     | 
| 
       5621 
5956 
     | 
    
         
             
                # multiple options are enabled and no preference is set, a challenge to
         
     | 
| 
       5622 
     | 
    
         
            -
                # choose an MFA option will be returned during sign in.
         
     | 
| 
      
 5957 
     | 
    
         
            +
                # choose an MFA option will be returned during sign in. If an MFA type
         
     | 
| 
      
 5958 
     | 
    
         
            +
                # is enabled for a user, the user will be prompted for MFA during all
         
     | 
| 
      
 5959 
     | 
    
         
            +
                # sign in attempts, unless device tracking is turned on and the device
         
     | 
| 
      
 5960 
     | 
    
         
            +
                # has been trusted. If you would like MFA to be applied selectively
         
     | 
| 
      
 5961 
     | 
    
         
            +
                # based on the assessed risk level of sign in attempts, disable MFA for
         
     | 
| 
      
 5962 
     | 
    
         
            +
                # users and turn on Adaptive Authentication for the user pool.
         
     | 
| 
       5623 
5963 
     | 
    
         
             
                #
         
     | 
| 
       5624 
5964 
     | 
    
         
             
                # @option params [Types::SMSMfaSettingsType] :sms_mfa_settings
         
     | 
| 
       5625 
5965 
     | 
    
         
             
                #   The SMS text message multi-factor authentication (MFA) settings.
         
     | 
| 
         @@ -5657,6 +5997,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5657 
5997 
     | 
    
         | 
| 
       5658 
5998 
     | 
    
         
             
                # Set the user pool multi-factor authentication (MFA) configuration.
         
     | 
| 
       5659 
5999 
     | 
    
         
             
                #
         
     | 
| 
      
 6000 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 6001 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 6002 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 6003 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 6004 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 6005 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 6006 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 6007 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 6008 
     | 
    
         
            +
                #
         
     | 
| 
      
 6009 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 6010 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 6011 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 6012 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 6013 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 6014 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 6015 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 6016 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 6017 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 6018 
     | 
    
         
            +
                #
         
     | 
| 
      
 6019 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 6020 
     | 
    
         
            +
                #
         
     | 
| 
      
 6021 
     | 
    
         
            +
                #
         
     | 
| 
      
 6022 
     | 
    
         
            +
                #
         
     | 
| 
      
 6023 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 6024 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 6025 
     | 
    
         
            +
                #
         
     | 
| 
       5660 
6026 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       5661 
6027 
     | 
    
         
             
                #   The user pool ID.
         
     | 
| 
       5662 
6028 
     | 
    
         
             
                #
         
     | 
| 
         @@ -5667,7 +6033,11 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5667 
6033 
     | 
    
         
             
                #   The software token MFA configuration.
         
     | 
| 
       5668 
6034 
     | 
    
         
             
                #
         
     | 
| 
       5669 
6035 
     | 
    
         
             
                # @option params [String] :mfa_configuration
         
     | 
| 
       5670 
     | 
    
         
            -
                #   The MFA configuration.  
     | 
| 
      
 6036 
     | 
    
         
            +
                #   The MFA configuration. Users who don't have an MFA factor set up
         
     | 
| 
      
 6037 
     | 
    
         
            +
                #   won't be able to sign-in if you set the MfaConfiguration value to
         
     | 
| 
      
 6038 
     | 
    
         
            +
                #   ‘ON’. See [Adding Multi-Factor Authentication (MFA) to a User
         
     | 
| 
      
 6039 
     | 
    
         
            +
                #   Pool](cognito/latest/developerguide/user-pool-settings-mfa.html) to
         
     | 
| 
      
 6040 
     | 
    
         
            +
                #   learn more. Valid values include:
         
     | 
| 
       5671 
6041 
     | 
    
         
             
                #
         
     | 
| 
       5672 
6042 
     | 
    
         
             
                #   * `OFF` MFA will not be used for any users.
         
     | 
| 
       5673 
6043 
     | 
    
         
             
                #
         
     | 
| 
         @@ -5757,6 +6127,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       5757 
6127 
     | 
    
         
             
                # Registers the user in the specified user pool and creates a user name,
         
     | 
| 
       5758 
6128 
     | 
    
         
             
                # password, and user attributes.
         
     | 
| 
       5759 
6129 
     | 
    
         
             
                #
         
     | 
| 
      
 6130 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 6131 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 6132 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 6133 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 6134 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 6135 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 6136 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 6137 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 6138 
     | 
    
         
            +
                #
         
     | 
| 
      
 6139 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 6140 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 6141 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 6142 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 6143 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 6144 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 6145 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 6146 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 6147 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 6148 
     | 
    
         
            +
                #
         
     | 
| 
      
 6149 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 6150 
     | 
    
         
            +
                #
         
     | 
| 
      
 6151 
     | 
    
         
            +
                #
         
     | 
| 
      
 6152 
     | 
    
         
            +
                #
         
     | 
| 
      
 6153 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 6154 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 6155 
     | 
    
         
            +
                #
         
     | 
| 
       5760 
6156 
     | 
    
         
             
                # @option params [required, String] :client_id
         
     | 
| 
       5761 
6157 
     | 
    
         
             
                #   The ID of the client associated with the user pool.
         
     | 
| 
       5762 
6158 
     | 
    
         
             
                #
         
     | 
| 
         @@ -6291,6 +6687,32 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       6291 
6687 
     | 
    
         | 
| 
       6292 
6688 
     | 
    
         
             
                # Allows a user to update a specific attribute (one at a time).
         
     | 
| 
       6293 
6689 
     | 
    
         
             
                #
         
     | 
| 
      
 6690 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 6691 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 6692 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 6693 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 6694 
     | 
    
         
            +
                # number with [Amazon Pinpoint][1]. Cognito will use the the registered
         
     | 
| 
      
 6695 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 6696 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 6697 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 6698 
     | 
    
         
            +
                #
         
     | 
| 
      
 6699 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 6700 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 6701 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 6702 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 6703 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 6704 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 6705 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 6706 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][2] in
         
     | 
| 
      
 6707 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
      
 6708 
     | 
    
         
            +
                #
         
     | 
| 
      
 6709 
     | 
    
         
            +
                #  </note>
         
     | 
| 
      
 6710 
     | 
    
         
            +
                #
         
     | 
| 
      
 6711 
     | 
    
         
            +
                #
         
     | 
| 
      
 6712 
     | 
    
         
            +
                #
         
     | 
| 
      
 6713 
     | 
    
         
            +
                # [1]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 6714 
     | 
    
         
            +
                # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
      
 6715 
     | 
    
         
            +
                #
         
     | 
| 
       6294 
6716 
     | 
    
         
             
                # @option params [required, Array<Types::AttributeType>] :user_attributes
         
     | 
| 
       6295 
6717 
     | 
    
         
             
                #   An array of name-value pairs representing user attributes.
         
     | 
| 
       6296 
6718 
     | 
    
         
             
                #
         
     | 
| 
         @@ -6375,14 +6797,35 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       6375 
6797 
     | 
    
         | 
| 
       6376 
6798 
     | 
    
         
             
                # Updates the specified user pool with the specified attributes. You can
         
     | 
| 
       6377 
6799 
     | 
    
         
             
                # get a list of the current user pool settings using
         
     | 
| 
       6378 
     | 
    
         
            -
                # [DescribeUserPool][1].
         
     | 
| 
      
 6800 
     | 
    
         
            +
                # [DescribeUserPool][1]. If you don't provide a value for an attribute,
         
     | 
| 
      
 6801 
     | 
    
         
            +
                # it will be set to the default value.
         
     | 
| 
      
 6802 
     | 
    
         
            +
                #
         
     | 
| 
      
 6803 
     | 
    
         
            +
                # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
         
     | 
| 
      
 6804 
     | 
    
         
            +
                # U.S. telecom carriers require that you register an origination phone
         
     | 
| 
      
 6805 
     | 
    
         
            +
                # number before you can send SMS messages to U.S. phone numbers. If you
         
     | 
| 
      
 6806 
     | 
    
         
            +
                # use SMS text messages in Amazon Cognito, you must register a phone
         
     | 
| 
      
 6807 
     | 
    
         
            +
                # number with [Amazon Pinpoint][2]. Cognito will use the the registered
         
     | 
| 
      
 6808 
     | 
    
         
            +
                # number automatically. Otherwise, Cognito users that must receive SMS
         
     | 
| 
      
 6809 
     | 
    
         
            +
                # messages might be unable to sign up, activate their accounts, or sign
         
     | 
| 
      
 6810 
     | 
    
         
            +
                # in.
         
     | 
| 
      
 6811 
     | 
    
         
            +
                #
         
     | 
| 
      
 6812 
     | 
    
         
            +
                #  If you have never used SMS text messages with Amazon Cognito or any
         
     | 
| 
      
 6813 
     | 
    
         
            +
                # other AWS service, Amazon SNS might place your account in SMS sandbox.
         
     | 
| 
      
 6814 
     | 
    
         
            +
                # In <i> <a
         
     | 
| 
      
 6815 
     | 
    
         
            +
                # href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox
         
     | 
| 
      
 6816 
     | 
    
         
            +
                # mode</a> </i>, you’ll have limitations, such as sending messages to
         
     | 
| 
      
 6817 
     | 
    
         
            +
                # only verified phone numbers. After testing in the sandbox environment,
         
     | 
| 
      
 6818 
     | 
    
         
            +
                # you can move out of the SMS sandbox and into production. For more
         
     | 
| 
      
 6819 
     | 
    
         
            +
                # information, see [ SMS message settings for Cognito User Pools][3] in
         
     | 
| 
      
 6820 
     | 
    
         
            +
                # the *Amazon Cognito Developer Guide*.
         
     | 
| 
       6379 
6821 
     | 
    
         
             
                #
         
     | 
| 
       6380 
     | 
    
         
            -
                # 
     | 
| 
       6381 
     | 
    
         
            -
                # default value.
         
     | 
| 
      
 6822 
     | 
    
         
            +
                #  </note>
         
     | 
| 
       6382 
6823 
     | 
    
         
             
                #
         
     | 
| 
       6383 
6824 
     | 
    
         
             
                #
         
     | 
| 
       6384 
6825 
     | 
    
         
             
                #
         
     | 
| 
       6385 
6826 
     | 
    
         
             
                # [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html
         
     | 
| 
      
 6827 
     | 
    
         
            +
                # [2]: https://console.aws.amazon.com/pinpoint/home/
         
     | 
| 
      
 6828 
     | 
    
         
            +
                # [3]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html
         
     | 
| 
       6386 
6829 
     | 
    
         
             
                #
         
     | 
| 
       6387 
6830 
     | 
    
         
             
                # @option params [required, String] :user_pool_id
         
     | 
| 
       6388 
6831 
     | 
    
         
             
                #   The user pool ID for the user pool you want to update.
         
     | 
| 
         @@ -6420,11 +6863,17 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       6420 
6863 
     | 
    
         
             
                #     user registration.
         
     | 
| 
       6421 
6864 
     | 
    
         
             
                #
         
     | 
| 
       6422 
6865 
     | 
    
         
             
                #   * `ON` - MFA tokens are required for all user registrations. You can
         
     | 
| 
       6423 
     | 
    
         
            -
                #     only specify  
     | 
| 
      
 6866 
     | 
    
         
            +
                #     only specify ON when you are initially creating a user pool. You can
         
     | 
| 
      
 6867 
     | 
    
         
            +
                #     use the [SetUserPoolMfaConfig][1] API operation to turn MFA "ON"
         
     | 
| 
      
 6868 
     | 
    
         
            +
                #     for existing user pools.
         
     | 
| 
       6424 
6869 
     | 
    
         
             
                #
         
     | 
| 
       6425 
6870 
     | 
    
         
             
                #   * `OPTIONAL` - Users have the option when registering to create an MFA
         
     | 
| 
       6426 
6871 
     | 
    
         
             
                #     token.
         
     | 
| 
       6427 
6872 
     | 
    
         
             
                #
         
     | 
| 
      
 6873 
     | 
    
         
            +
                #
         
     | 
| 
      
 6874 
     | 
    
         
            +
                #
         
     | 
| 
      
 6875 
     | 
    
         
            +
                #   [1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
         
     | 
| 
      
 6876 
     | 
    
         
            +
                #
         
     | 
| 
       6428 
6877 
     | 
    
         
             
                # @option params [Types::DeviceConfigurationType] :device_configuration
         
     | 
| 
       6429 
6878 
     | 
    
         
             
                #   Device configuration.
         
     | 
| 
       6430 
6879 
     | 
    
         
             
                #
         
     | 
| 
         @@ -6482,6 +6931,15 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       6482 
6931 
     | 
    
         
             
                #       verify_auth_challenge_response: "ArnType",
         
     | 
| 
       6483 
6932 
     | 
    
         
             
                #       pre_token_generation: "ArnType",
         
     | 
| 
       6484 
6933 
     | 
    
         
             
                #       user_migration: "ArnType",
         
     | 
| 
      
 6934 
     | 
    
         
            +
                #       custom_sms_sender: {
         
     | 
| 
      
 6935 
     | 
    
         
            +
                #         lambda_version: "V1_0", # required, accepts V1_0
         
     | 
| 
      
 6936 
     | 
    
         
            +
                #         lambda_arn: "ArnType", # required
         
     | 
| 
      
 6937 
     | 
    
         
            +
                #       },
         
     | 
| 
      
 6938 
     | 
    
         
            +
                #       custom_email_sender: {
         
     | 
| 
      
 6939 
     | 
    
         
            +
                #         lambda_version: "V1_0", # required, accepts V1_0
         
     | 
| 
      
 6940 
     | 
    
         
            +
                #         lambda_arn: "ArnType", # required
         
     | 
| 
      
 6941 
     | 
    
         
            +
                #       },
         
     | 
| 
      
 6942 
     | 
    
         
            +
                #       kms_key_id: "ArnType",
         
     | 
| 
       6485 
6943 
     | 
    
         
             
                #     },
         
     | 
| 
       6486 
6944 
     | 
    
         
             
                #     auto_verified_attributes: ["phone_number"], # accepts phone_number, email
         
     | 
| 
       6487 
6945 
     | 
    
         
             
                #     sms_verification_message: "SmsVerificationMessageType",
         
     | 
| 
         @@ -6982,7 +7440,7 @@ module Aws::CognitoIdentityProvider 
     | 
|
| 
       6982 
7440 
     | 
    
         
             
                    params: params,
         
     | 
| 
       6983 
7441 
     | 
    
         
             
                    config: config)
         
     | 
| 
       6984 
7442 
     | 
    
         
             
                  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
         
     | 
| 
       6985 
     | 
    
         
            -
                  context[:gem_version] = '1. 
     | 
| 
      
 7443 
     | 
    
         
            +
                  context[:gem_version] = '1.52.0'
         
     | 
| 
       6986 
7444 
     | 
    
         
             
                  Seahorse::Client::Request.new(handlers, context)
         
     | 
| 
       6987 
7445 
     | 
    
         
             
                end
         
     | 
| 
       6988 
7446 
     | 
    
         |